5.2. Eclipse Vert.x での Prometheus を使用したアプリケーションメトリクスの公開

手順

1. アプリケーションの pom.xml ファイルに vertx-micrometer 依存関係および vertx-web 依存関係を含めます。

   pom.xml

   <dependency>
     <groupId>io.vertx</groupId>
     <artifactId>vertx-micrometer-metrics</artifactId>
   </dependency>
   <dependency>
     <groupId>io.vertx</groupId>
     <artifactId>vertx-web</artifactId>
   </dependency>

2. バージョン 3.5.4 以降、Prometheus のメトリクスを公開するには、カスタム Launcher クラスで Eclipse Vert.x オプションを設定する必要があります。

   カスタム Launcher クラスの beforeStartingVertx メソッドおよび afterStartingVertx メソッドを上書きして、メトリクスエンジンを設定します。以下に例を示します。

   CustomLauncher.java ファイルの例

   package org.acme;
   
   import io.micrometer.core.instrument.Meter;
   import io.micrometer.core.instrument.config.MeterFilter;
   import io.micrometer.core.instrument.distribution.DistributionStatisticConfig;
   import io.micrometer.prometheus.PrometheusMeterRegistry;
   import io.vertx.core.Vertx;
   import io.vertx.core.VertxOptions;
   import io.vertx.core.http.HttpServerOptions;
   import io.vertx.micrometer.MicrometerMetricsOptions;
   import io.vertx.micrometer.VertxPrometheusOptions;
   import io.vertx.micrometer.backends.BackendRegistries;
   
   public class CustomLauncher extends Launcher {
   
     @Override
     public void beforeStartingVertx(VertxOptions options) {
       options.setMetricsOptions(new MicrometerMetricsOptions()
         .setPrometheusOptions(new VertxPrometheusOptions().setEnabled(true)
           .setStartEmbeddedServer(true)
           .setEmbeddedServerOptions(new HttpServerOptions().setPort(8081))
           .setEmbeddedServerEndpoint("/metrics"))
         .setEnabled(true));
     }
   
     @Override
     public void afterStartingVertx(Vertx vertx) {
       PrometheusMeterRegistry registry = (PrometheusMeterRegistry) BackendRegistries.getDefaultNow();
       registry.config().meterFilter(
         new MeterFilter() {
           @Override
           public DistributionStatisticConfig configure(Meter.Id id, DistributionStatisticConfig config) {
             return DistributionStatisticConfig.builder()
               .percentilesHistogram(true)
               .build()
               .merge(config);
           }
       });
   }

3. カスタムの Verticle クラスを作成し、メトリクスを収集するために start メソッドを上書きします。たとえば、Timer クラスを使用して実行時間を測定します。

   CustomVertxApp.java ファイルの例

   package org.acme;
   
   import io.micrometer.core.instrument.MeterRegistry;
   import io.micrometer.core.instrument.Timer;
   import io.vertx.core.AbstractVerticle;
   import io.vertx.core.Vertx;
   import io.vertx.core.VertxOptions;
   import io.vertx.core.http.HttpServerOptions;
   import io.vertx.micrometer.backends.BackendRegistries;
   
   public class CustomVertxApp extends AbstractVerticle {
   
     @Override
     public void start() {
       MeterRegistry registry = BackendRegistries.getDefaultNow();
       Timer timer = Timer
         .builder("my.timer")
         .description("a description of what this timer does")
         .register(registry);
   
       vertx.setPeriodic(1000, l -> {
         timer.record(() -> {
   
           // Do something
   
         });
       });
     }
   }

4. アプリケーションの pom.xml ファイルの <vertx.verticle> プロパティーおよび <vertx.launcher> プロパティーを設定して、カスタムクラスを参照します。

   <properties>
     ...
     <vertx.verticle>org.acme.CustomVertxApp</vertx.verticle>
     <vertx.launcher>org.acme.CustomLauncher</vertx.launcher>
     ...
   </properties>

5. アプリケーションを起動します。

   $ mvn vertx:run

6. トレースされたエンドポイントを複数回呼び出します。

   $ curl http://localhost:8080/
   Hello

7. コレクションが発生するまで 15 秒以上待機し、Prometheus UI でメトリクスを確認します。

   1. http://localhost:9090/ で Prometheus UI を開き、Expression ボックスに hello と入力します。
   2. 提案から、たとえば application:hello_count を選択し、Execute をクリックします。
   3. 表示される表で、リソースメソッドが呼び出された回数を確認できます。
   4. application:hello_time_mean_seconds を選択して、すべての呼び出しの平均時間を確認します。

   作成したすべてのメトリクスの前には application: があることに注意してください。Eclipse MicroProfile Metrics 仕様が要求するように、Eclipse Vert.x によって自動的に公開される他のメトリックがあります。これらのメトリクスには base: および vendor: という接頭辞が付けられ、アプリケーションが実行する JVM に関する情報を公開します。