Managed Service for Prometheus:Spring Boot アプリケーションを Managed Service for Prometheus に接続する

統合プロセスの概要

Spring Boot アプリケーション向けに、コミュニティは Spring Boot Actuator フレームワークを提供しており、Java 開発者がコードのイベントトラッキング、メトリック収集、出力を簡素化できます。Spring Boot 2.0 以降、Actuator は Micrometer 上で再構築され、より強力かつ柔軟なモニタリング機能を提供しています。Micrometer はメトリックのファサードであり、ロギングにおける SLF4J に類似しています。Micrometer を使用することで、アプリケーションは AppOptics、Datadog、Elastic、InfluxDB、および Managed Service for Prometheus など、さまざまなモニタリングシステムに接続できます。

Java アプリケーションからのメトリックをマッピングする際、Micrometer は以下のセマンティクスを使用して、自身のメトリクスタイプを Managed Service for Prometheus で使用されるタイプにマッピングします。

• Micrometer の Counter メトリクスタイプは、Managed Service for Prometheus の Counter タイプにマッピングされ、API 呼び出し回数、キャッシュヒット数、総訪問者数など、単調増加する変数を記述するために使用されます。Timer は論理的に Counter を含みます。API の応答時間を Timer で収集すると、呼び出し回数も同時に収集されるため、同一の API に対して Timer と Counter の両方を指定する必要はありません。

• Micrometer の Gauge メトリクスタイプは、Managed Service for Prometheus の Gauge タイプにマッピングされ、CPU 使用率やスレッドプールキュー内のタスク数など、範囲内で継続的に変動する変数を記述するために使用されます。

• Micrometer の Timer メトリクスタイプは、Managed Service for Prometheus の Histogram タイプにマッピングされ、API のレスポンスタイム (RT) 分布など、時間関連データを記述するために使用されます。

• Micrometer の DistributionSummary メトリクスタイプは、Managed Service for Prometheus の Summary タイプにマッピングされます。Histogram と同様に統計的分布に使用されますが、分布はクライアント側で計算された後に Managed Service for Prometheus に送信されて保存されるため、複数のマシン間で集計できません。この制限により、データ分布のグローバルなビューを提供できないため、利用が制限されます。

統合ワークフロー

Kubernetes クラスターにデプロイされた Spring Boot アプリケーションを Managed Service for Prometheus に接続する場合は、「コードのイベントトラッキング」→「アプリケーションデプロイメント」→「サービス検出」の順に処理を進める必要があります。

まず、コードに必要な Spring Boot Actuator Maven 依存関係を追加し、モニタリング対象のメトリックを登録するか、コントローラーのメソッドにアノテーションを追加します。

次に、イベントトラッキング済みのアプリケーションを Kubernetes にデプロイし、メトリック収集エンドポイントを Managed Service for Prometheus に登録します。このプロセスは サービス検出 と呼ばれます。Managed Service for Prometheus は、ServiceMonitor カスタムリソース定義 (CRD) を使用してサービス検出を実現します。

最後に、Managed Service for Prometheus がターゲットアプリケーションのメトリックエンドポイントを正常に検出した後、Grafana でデータソースを構成し、ダッシュボードを作成できます。また、重要なメトリックに基づいてアラートを設定することも可能です。

モニタリング目標

Kubernetes クラスター内の Spring Boot アプリケーションを Managed Service for Prometheus に接続することで、以下のことが可能になります。

• システムのエントリーポイントのモニタリング：顧客トラフィックを処理するフロントエンドサービス上で、外部向け API の主要 RED メトリック（Rate、Errors、Duration）を追跡します。

• 重要なシステムパスのモニタリング：バックエンドサービスのクリティカルパス上のキーオブジェクト（スレッドプールのキュー状態や、インプロセス Guava Cache のヒット率など）を観測します。

• ビジネスに関連するカスタムメトリックのモニタリング：特定の API のユニークビジター数など、ビジネス固有のメトリックをモニタリングします。

• JVM パフォーマンスのモニタリング：JVM のガベージコレクション (GC) およびメモリ使用量を追跡します。

• モニタリングの集中化：上記すべてのメトリックを集約し、統一ダッシュボードに表示するとともに、重要な指標に対してアラートを設定します。

手順 1：Spring Boot Actuator の構成

本トピックでは、Spring Boot および Spring Cloud Alibaba を使用して構築されたクラウドネイティブマイクロサービスアプリケーションを例に、Kubernetes クラスター内の Spring Boot マイクロサービスアプリケーションを Managed Service for Prometheus に接続する方法を説明します。

1. pom.xml ファイルに Spring Boot Actuator の依存関係を追加します。

   <!-- spring-boot-actuator dependency -->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-actuator</artifactId>
   </dependency>
   <!-- prometheus dependency -->
   <dependency>
       <groupId>io.micrometer</groupId>
       <artifactId>micrometer-registry-prometheus</artifactId>
   </dependency>

2. application.properties ファイルに、モニタリングデータを公開するポートの構成を追加します。本例ではポート 8091 を使用します。

   # Add the following configuration to application.properties to expose metrics
   spring.application.name=frontend
   management.server.port=8091
   management.endpoints.web.exposure.include=*
   management.metrics.tags.application=${spring.application.name}

   構成が完了すると、アプリケーションのポート 8091 にアクセスできるようになります。このポートの /actuator/prometheus パスで、OpenMetrics 形式のモニタリングデータが利用可能になります。

手順 2：コードのイベントトラッキング

API の RED メトリックを収集するには、対応するメソッドに @Timed アノテーションを追加します。以下の例では、インデックスページ API に @Timed を追加しています。

@Timed(value = "main_page_request_duration", description = "Time taken to return main page", histogram = true)
@ApiOperation(value = "Home page", tags = {"Home page operations"})
@GetMapping("/")
public String index(Model model) {
    model.addAttribute("products", productDAO.getProductList());
    model.addAttribute("FRONTEND_APP_NAME", Application.APP_NAME);
    model.addAttribute("FRONTEND_SERVICE_TAG", Application.SERVICE_TAG);
    model.addAttribute("FRONTEND_IP", registration.getHost());
    model.addAttribute("PRODUCT_APP_NAME", PRODUCT_APP_NAME);
    model.addAttribute("PRODUCT_SERVICE_TAG", PRODUCT_SERVICE_TAG);
    model.addAttribute("PRODUCT_IP", PRODUCT_IP);
    model.addAttribute("new_version", StringUtils.isBlank(env));
    return "index.html";
}

アプリケーションで Guava Cache などのインプロセスキャッシュライブラリを使用しており、そのランタイム状態を追跡したい場合は、Micrometer のデコレーターメソッドを使用してキーオブジェクトをラップできます。

Guava キャッシュの変更

1. MeterRegistry を注入します。Spring Boot は自動的に PrometheusMeterRegistry 実装を注入します。

2. ユーティリティ API（以下のコードでは GuavaCacheMetrics.monitor）を使用してローカルキャッシュをラップします。

3. .recordStats() メソッドを呼び出して、キャッシュ統計の記録を有効にします。

4. キャッシュオブジェクトに名前を付けて、対応するメトリックを生成します。

@Resource
private static MeterRegistry meterRegistry;
private static final LoadingCache<String, String> REFRESH_CACHE = GuavaCacheMetrics.monitor(
        meterRegistry,
        CacheBuilder.newBuilder()
                .recordStats()
                .build(new CacheLoader<String, String>() {
                    @Override
                    public String load(String key) {
                        // Implement the specific load operation here.
                        return "";
                    }
                }),
        "refresh-cache");

スレッドプールの変更

1. MeterRegistry を注入します。ここに注入される具体的な実装は PrometheusMeterRegistry です。

2. ユーティリティ API を使用してスレッドプールをラップします。

3. スレッドプールに名前を付けて、対応するメトリックを生成します。

@Resource
private static MeterRegistry meterRegistry;
private static final ScheduledExecutorService REFRESH_EXECUTOR = ExecutorServiceMetrics.monitor(
        meterRegistry,
        Executors.newScheduledThreadPool(1,
                new ThreadFactory() {
                        public Thread newThread(Runnable r) {
                            Thread thread = new Thread(r);
                            thread.setDaemon(true);
                            thread.setName("dubbo.outlier.refresh-" + thread.getId());
                            return thread;
                        }
                }),
        "refresh-executor"
);

ビジネス固有のカスタムメトリックをモニタリングするには、Bean に MeterRegistry を注入し、要件に応じて Counter、Gauge、または Timer を構築します。その後、それを MeterRegistry に登録してメトリックを公開します。以下の例を参照してください。

@Service
public class DemoService {
    Counter visitCounter;
    public DemoService(MeterRegistry registry) {
        visitCounter = Counter.builder("visit_counter")
            .description("Number of visits to the site")
            .register(registry);
    }
    public String visit() {
        visitCounter.increment();
        return "Hello World!";
    }    
}

これで必要なコード変更は完了です。次に、アプリケーションイメージを再ビルドし、Managed Service for Prometheus がインストールされている Kubernetes クラスターにデプロイします。その後、Managed Service for Prometheus コンソールで ServiceMonitor を構成してサービス検出を有効にしてください。詳細については、「Container Observability」および「インスタンス管理」をご参照ください。

ServiceMonitor の構成後、Targets リストに新しく登録されたアプリケーションが表示されます。

Targets ページで、default/frontend-service-monitor/0 (1/1 up) が表示され、State が UP となっている場合、メトリックエンドポイント（パス：/actuator/prometheus）が正常に動作しており、ServiceMonitor 構成がアクティブであることを示します。

手順 3：ダッシュボードの構成

Managed Service for Prometheus は、アプリケーションのモニタリングデータを収集・保存しています。ダッシュボードとアラートを構成してデータを表示できます。以下のオープンソース Grafana コミュニティのダッシュボードテンプレートを使用して、独自のモニタリングダッシュボードを構築できます。

• Spring Boot 2.1 Statistics

• JVM (Micrometer)

これらのテンプレートと Managed Service for Prometheus のビルトイン Grafana サービスを使用することで、開発と運用保守に必要な主要メトリックを単一ページに統合したダッシュボードを作成できます。たとえば、これらのテンプレートから構築されたダッシュボードには、概要、コンポーネントランタイム、メモリ使用量、ヒープおよび非ヒープメモリ、世代別 GC 状態などが含まれます。