Eclipse Vert.x Runtime Guide

流程

1. 打开 pom.xml 文件，将 io.vertx:vertx-dependencies 构件添加到 < dependencyManagement> 部分。将 类型指定为 pom，范围 指定为 导入。

   <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>

2. 包含以下属性来跟踪 Eclipse Vert.x 和 Eclipse Vert.x Maven 插件的版本。

   属性可用于设置在每个版本中更改的值。例如，产品或插件的版本。

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

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>

4. 包含 软件仓库 和插件， 以指定包含工件和插件的存储库以构建应用程序：

   <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>

流程

1. 创建新目录 myApp，并导航到它。

   $ mkdir myApp
   $ cd myApp

   这是应用的根目录。

2. 在根目录中创建目录结构 src/main/java/com/example/，然后导航到.

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

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

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.3.7.redhat-00002</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>

5. 从应用的根目录使用 Maven 构建应用。

   $ mvn vertx:run

6. 验证应用是否正在运行。

   使用 curl 或您的浏览器，验证您的应用程序正在 http://localhost:8080 中运行。

   $ curl http://localhost:8080
   Greetings!

流程

1. 将 vertx-micrometer 和 vertx-web 依赖项包含到应用程序的 pom.xml 文件中：

   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 选项。

   在 custom 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. 多次调用 traced 端点：

   $ 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 的信息。