SpringBootアプリケーションのメトリクス監視

plugins {
	...
  // SpringBootのバージョンは「3.0.2」で
	id 'org.springframework.boot' version '3.0.2'
	id 'io.spring.dependency-management' version '1.1.0'
}

...

dependencies {
  ...
  // （必須）メトリクス収集のメインを担うライブラリ
	implementation 'org.springframework.boot:spring-boot-starter-actuator'
  // メトリクスをprometheusで読み取れる形式で出力するためのライブラリ
	implementation 'io.micrometer:micrometer-registry-prometheus'
}

management:
  server:
    # （任意）メトリクスを出力するportを変更する
    # ※エンドポイントさえ知っていれば外から叩けてしまうのでアプリケーションのポートと別にするのがオススメ
    port: 9990
  endpoints:
    web:
      exposure:
        # 有効化したいエンドポイントを記載（ここではprometheusを追加）
        include: health, prometheus

management:
  metrics:
    distribution:
      percentiles:
        # 取得するパーセンタイルの設定（この例だと50%ileと99%ile）
        "http.server.requests": 0.5,0.99
  observations:
    http:
      server:
        requests:
          # （任意）メトリクス名を指定
          name: "http.server.requests"

server:
  tomcat:
    mbeanregistry:
      # Tomcatのメトリクス収集を有効化
      enabled: true
    threads:
      # 最大スレッド数の設定（デフォルト:200）
      max: 500

    @Bean
    public PoolingHttpClientConnectionManager connectionManager() {
        return PoolingHttpClientConnectionManagerBuilder.create()
                .setMaxConnTotal(100)    // 最大コネクション数　※デフォルト: 25
                .setMaxConnPerRoute(50)  // ドメインごとの最大コネクション数　※デフォルト: 5
                .build();
    }

    @Bean
    public RestTemplate myRestTemplate(
            PoolingHttpClientConnectionManager connectionManager,
            ObservationRestTemplateCustomizer observationRestTemplateCustomizer
    ) {
        var httpClient = HttpClients.custom()
                .setConnectionManager(connectionManager)
                .build();

        var requestFactory = new HttpComponentsClientHttpRequestFactory();
        requestFactory.setHttpClient(httpClient);

        return new RestTemplateBuilder()
                // HTTP通信のメトリクス取得のためのCustomizer
                // （Springが提供しているRestTemplateBuilder beanを使う場合は不要）
                .customizers(observationRestTemplateCustomizer)
                // カスタマイズしたHttpClientを設定する
                .requestFactory(() -> requestFactory)
                .build();

    @Bean
    public WebClient myWebClient(ObservationWebClientCustomizer observationWebClientCustomizer) {
        var connectionProvider = ConnectionProvider.builder("sample")
                .maxConnections(100) // コネクションプール数
                .metrics(true) // コネクション数のメトリクスを有効化
                .build();

        var httpClient = HttpClient.create(connectionProvider);

        return WebClient.builder()
                .clientConnector(new ReactorClientHttpConnector(httpClient))
                .apply(observationWebClientCustomizer::customize)  // http clientのメトリクスを収集
                .build();
    }

management:
  metrics:
    distribution:
      percentiles:
        # 取得するパーセンタイルの設定（この例だと50%ileと99%ile）
        "http.client.requests": 0.5,0.99

dependencies {
    ...
    // spring-boot-starter-aopを依存に追加する
    implementation 'org.springframework.boot:spring-boot-starter-aop'
    ...
}

@Configuration
public class MetricsAutoConfiguration {
     // @Timedを利用する場合にBean登録が必要
    @Bean
    public TimedAspect timedAspect(MeterRegistry registry) {
        return new TimedAspect(registry);
    }

    // // @Countedを利用する場合にBean登録が必要
    @Bean
    public CountedAspect countedAspect(MeterRegistry registry) {
        return new CountedAspect(registry);
    }
}

    @Timed(
            // メトリクス名
            value = "timed.metrics",
            // パーセンタイルを計測したい場合に指定（例では50%ileと99%ileを指定）
            percentiles = {0.5, 0.99}
    )
    public String timedMethod() {
    }

    @Counted(
            // メトリクス名
            value = "counted.metrics"
    )
    public String counted() {
    }