Eclipse Vert.x ランタイムガイド

手順

1. pom.xml ファイルを開き、io.vertx:vertx-dependencies アーティファクトを <dependencyManagement> セクションに追加します。type を pom として指定し、scope を import として指定します。

   <project>
     ...
     <dependencyManagement>
       <dependencies>
         <dependency>
           <groupId>io.vertx</groupId>
           <artifactId>vertx-dependencies</artifactId>
           <version>${vertx.version}</version>
           <type>pom</type>
           <scope>import</scope>
         </dependency>
       </dependencies>
     </dependencyManagement>
     ...
   </project>

   Copy to Clipboard Toggle word wrap

2. 以下のプロパティーを追加して、使用する Eclipse Vert.x および Eclipse Vert.x Maven Plugin のバージョンを追跡します。

   プロパティーを使用して、リリースごとに変更する値を設定できます。たとえば、製品またはプラグインのバージョンです。

   <project>
     ...
     <properties>
       <vertx.version>${vertx.version}</vertx.version>
       <vertx-maven-plugin.version>${vertx-maven-plugin.version}</vertx-maven-plugin.version>
     </properties>
     ...
   </project>

   Copy to Clipboard Toggle word wrap

3. アプリケーションのパッケージ化に使用されるプラグインとして vertx-maven-plugin を指定します。

   <project>
     ...
     <build>
       <plugins>
           ...
           <plugin>
               <groupId>io.reactiverse</groupId>
               <artifactId>vertx-maven-plugin</artifactId>
               <version>${vertx-maven-plugin.version}</version>
               <executions>
                   <execution>
                       <id>vmp</id>
                       <goals>
                           <goal>initialize</goal>
                           <goal>package</goal>
                       </goals>
                   </execution>
               </executions>
               <configuration>
                   <redeploy>true</redeploy>
               </configuration>
           </plugin>
           ...
       </plugins>
     </build>
     ...
   </project>

   Copy to Clipboard Toggle word wrap

4. repositories および pluginRepositories を追加して、アプリケーションをビルドするためのアーティファクトおよびプラグインが含まれるリポジトリーを指定します。

   <project>
   ...
     <repositories>
       <repository>
         <id>redhat-ga</id>
         <name>Red Hat GA Repository</name>
         <url>https://maven.repository.redhat.com/ga/</url>
       </repository>
     </repositories>
     <pluginRepositories>
       <pluginRepository>
         <id>redhat-ga</id>
         <name>Red Hat GA Repository</name>
         <url>https://maven.repository.redhat.com/ga/</url>
       </pluginRepository>
     </pluginRepositories>
   ...
   </project>

   Copy to Clipboard Toggle word wrap

手順

1. 新しいディレクトリー myApp を作成し、そのディレクトリーに移動します。

   $ mkdir myApp
   $ cd myApp

   Copy to Clipboard Toggle word wrap

   これは、アプリケーションのルートディレクトリーです。

2. ルートディレクトリーにディレクトリー構造 src/main/java/com/example/ を作成し、これに移動します。

   $ mkdir -p src/main/java/com/example/
   $ cd src/main/java/com/example/

   Copy to Clipboard Toggle word wrap

3. アプリケーションコードを含む Java クラスファイル MyApp.java を作成します。

   package com.example;
   
   import io.vertx.core.AbstractVerticle;
   import io.vertx.core.Promise;
   
   public class MyApp extends AbstractVerticle {
   
       @Override
       public void start(Promise<Void> promise) {
           vertx
               .createHttpServer()
               .requestHandler(r ->
                   r.response().end("Greetings!"))
               .listen(8080, result -> {
                   if (result.succeeded()) {
                       promise.complete();
                   } else {
                       promise.fail(result.cause());
                   }
               });
       }
   }

   Copy to Clipboard Toggle word wrap

4. 以下の内容を含むアプリケーションルートディレクトリー myApp に pom.xml ファイルを作成します。

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
   
     <groupId>com.example</groupId>
     <artifactId>my-app</artifactId>
     <version>1.0.0-SNAPSHOT</version>
     <packaging>jar</packaging>
   
     <name>My Application</name>
     <description>Example application using Vert.x</description>
   
     <properties>
       <vertx.version>4.2.7.redhat-00003</vertx.version>
       <vertx-maven-plugin.version>1.0.24</vertx-maven-plugin.version>
       <vertx.verticle>com.example.MyApp</vertx.verticle>
   
       <!-- Specify the JDK builder image used to build your application. -->
       <jkube.generator.from>registry.access.redhat.com/ubi8/openjdk-11</jkube.generator.from>
   
       <maven.compiler.source>1.8</maven.compiler.source>
       <maven.compiler.target>1.8</maven.compiler.target>
       <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
       <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
     </properties>
   
     <!-- Import dependencies from the Vert.x BOM. -->
     <dependencyManagement>
       <dependencies>
         <dependency>
           <groupId>io.vertx</groupId>
           <artifactId>vertx-dependencies</artifactId>
           <version>${vertx.version}</version>
           <type>pom</type>
           <scope>import</scope>
         </dependency>
       </dependencies>
     </dependencyManagement>
   
     <!-- Specify the Vert.x artifacts that your application depends on. -->
     <dependencies>
       <dependency>
         <groupId>io.vertx</groupId>
         <artifactId>vertx-core</artifactId>
       </dependency>
       <dependency>
         <groupId>io.vertx</groupId>
         <artifactId>vertx-web</artifactId>
       </dependency>
     </dependencies>
   
     <!-- Specify the repositories containing Vert.x artifacts. -->
     <repositories>
       <repository>
         <id>redhat-ga</id>
         <name>Red Hat GA Repository</name>
         <url>https://maven.repository.redhat.com/ga/</url>
       </repository>
     </repositories>
   
     <!-- Specify the repositories containing the plugins used to execute the build of your application. -->
     <pluginRepositories>
       <pluginRepository>
         <id>redhat-ga</id>
         <name>Red Hat GA Repository</name>
         <url>https://maven.repository.redhat.com/ga/</url>
       </pluginRepository>
     </pluginRepositories>
   
     <!-- Configure your application to be packaged using the Vert.x Maven Plugin. -->
     <build>
       <plugins>
         <plugin>
           <groupId>io.reactiverse</groupId>
           <artifactId>vertx-maven-plugin</artifactId>
           <version>${vertx-maven-plugin.version}</version>
           <executions>
             <execution>
               <id>vmp</id>
               <goals>
                 <goal>initialize</goal>
                 <goal>package</goal>
               </goals>
             </execution>
           </executions>
         </plugin>
       </plugins>
     </build>
   </project>

   Copy to Clipboard Toggle word wrap

5. アプリケーションのルートディレクトリーから Maven を使用してアプリケーションをビルドします。

   $ mvn vertx:run

   Copy to Clipboard Toggle word wrap

6. アプリケーションが実行していることを確認します。

   curl またはブラウザーを使用して、アプリケーションが http://localhost:8080 で稼働していることを確認します。

   $ curl http://localhost:8080
   Greetings!

   Copy to Clipboard Toggle word wrap

手順

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>

   Copy to Clipboard Toggle word wrap

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);
           }
       });
   }

   Copy to Clipboard Toggle word wrap

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
   
         });
       });
     }
   }

   Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap

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

   $ mvn vertx:run

   Copy to Clipboard Toggle word wrap

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

   $ curl http://localhost:8080/
   Hello

   Copy to Clipboard Toggle word wrap

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 に関する情報を公開します。