10.7. OpenTelemetry 追踪应用程序开发

流程

1. 在 CLI 中，使用 mvn 命令来设置 Maven 项目。此命令为项目创建目录结构，以及 pom.xml 配置文件。

   语法

   $ mvn archetype:generate \
   -DgroupId=<group-to-which-your-application-belongs> \
   -DartifactId=<name-of-your-application> \
   -DarchetypeGroupId=org.apache.maven.archetypes \
   -DarchetypeArtifactId=maven-archetype-webapp \
   -DinteractiveMode=false

   Example

   $ mvn archetype:generate \
   -DgroupId=com.example.opentelemetry \
   -DartifactId=simple-tracing-example \
   -DarchetypeGroupId=org.apache.maven.archetypes \
   -DarchetypeArtifactId=maven-archetype-webapp \
   -DinteractiveMode=false

2. 导航到应用程序根目录。

   语法

   $ cd <name-of-your-application>

   Example

   $ cd simple-tracing-example

3. 更新生成的 pom.xml 文件。

   1. 设置以下属性：

      <properties>
          <maven.compiler.source>1.8</maven.compiler.source>
          <maven.compiler.target>1.8</maven.compiler.target>
          <failOnMissingWebXml>false</failOnMissingWebXml>
          <version.server.bom>4.0.0.GA</version.server.bom>
          <version.wildfly-jar.maven.plugin>6.1.1.Final</version.wildfly-jar.maven.plugin>
      </properties>

   2. 设置以下依赖项：

      <dependencies>
          <dependency>
              <groupId>jakarta.enterprise</groupId>
              <artifactId>jakarta.enterprise.cdi-api</artifactId>
              <version>2.0.2</version>
              <scope>provided</scope>
          </dependency>
      
          <dependency>
              <groupId>org.jboss.spec.javax.ws.rs</groupId>
              <artifactId>jboss-jaxrs-api_2.1_spec</artifactId>
              <version>2.0.2.Final</version>
              <scope>provided</scope>
          </dependency>
      
          <dependency>
              <groupId>io.opentelemetry</groupId>
              <artifactId>opentelemetry-api</artifactId>
              <version>1.5.0</version>
              <scope>provided</scope>
          </dependency>
      </dependencies>

   3. 将以下构建配置设置为使用 mvn widlfy:deploy 来部署应用程序：

      <build>
        <!-- Set the name of the archive -->
        <finalName>${project.artifactId}</finalName>
        <plugins>
          <!-- Allows to use mvn wildfly:deploy -->
          <plugin>
            <groupId>org.wildfly.plugins</groupId>
            <artifactId>wildfly-maven-plugin</artifactId>
          </plugin>
        </plugins>
      </build>

流程

1. 在 & lt;application_root > 中，创建一个用于存储 Java 文件的目录。

   语法

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

   Example

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

2. 前往新目录。

   语法

   $ cd src/main/java/com/example/opentelemetry

   Example

   $ cd src/main/java/com/example/opentelemetry

3. 创建包含以下内容的 JakartaRestApplication.java 文件：此 JakartaRestApplication 类将应用声明为 Jakarta RESTful Web Services 应用。

   package com.example.opentelemetry;
   
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   @ApplicationPath("/")
   public class JakartaRestApplication extends Application {
   }

4. 创建包含以下内容的 ExplicitlyTracedBean.java 文件，其内容为 class ExplicitlyTracedBean。此类通过注入 Tracer 类来创建自定义 span。

   package com.example.opentelemetry;
   
   import javax.enterprise.context.RequestScoped;
   import javax.inject.Inject;
   import io.opentelemetry.api.trace.Span;
   import io.opentelemetry.api.trace.Tracer;
   
   @RequestScoped
   public class ExplicitlyTracedBean {
   
       @Inject
       private Tracer tracer; 

   1

   
   
       public String getHello() {
           Span prepareHelloSpan = tracer.spanBuilder("prepare-hello").startSpan(); 

   2

   
           prepareHelloSpan.makeCurrent();
   
           String hello = "hello";
   
           Span processHelloSpan = tracer.spanBuilder("process-hello").startSpan(); 

   3

   
           processHelloSpan.makeCurrent();
   
           hello = hello.toUpperCase();
   
           processHelloSpan.end();
           prepareHelloSpan.end();
   
           return hello;
       }
   }

   1

   注入 Tracer 类以创建自定义范围。

   2

   创建名为 prepare-hello 的 span，以指示方法 getHello （） 被调用。

   3

   创建名为 process-hello 的 span，以指示值 hello 已分配给名为 hello 的新 String 对象。

5. 为 TracedResource.java 类创建包含以下内容的 TracedResource.java 文件。此文件注入 ExplicitlyTracedBean 类，并声明两个端点： traced 和 cdi-trace。

   package com.example.opentelemetry;
   
   import javax.enterprise.context.RequestScoped;
   import javax.inject.Inject;
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import javax.ws.rs.core.MediaType;
   
   @Path("/hello")
   @RequestScoped
   public class TracedResource {
       @Inject
       private ExplicitlyTracedBean tracedBean;
   
       @GET
       @Path("/traced")
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "hello";
       }
   
       @GET
       @Path("/cdi-trace")
       @Produces(MediaType.TEXT_PLAIN)
       public String cdiHello() {
           return tracedBean.getHello();
       }
   }

6. 导航到应用程序根目录。

   语法

   $ cd <path_to_application_root>/<application_root>

   Example

   $ cd ~/applications/simple-tracing-example

7. 使用以下命令编译并部署应用程序：

   $ mvn clean package wildfly:deploy

8. 启动 Jaeger 控制台。

   $ docker run -d --name jaeger \
     -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
     -p 5775:5775/udp \
     -p 6831:6831/udp \
     -p 6832:6832/udp \
     -p 5778:5778 \
     -p 16686:16686 \
     -p 14268:14268 \
     -p 14250:14250 \
     -p 9411:9411 \
     jaegertracing/all-in-one:1.29

9. 在浏览器中，导航到 \localhost:8080/simple-tracing-example/hello/cdi-trace。
10. 在一个浏览器中，打开位于 http://localhost:16686/search 的 Jaeger 控制台。
11. 在 Jaeger 控制台中，选择 JBoss EAP XP 并点 Find Traces。
12. 单击 3 Spans。

13. Jaeger 控制台显示以下 trace：

    |GET /hello/cdi-trace 

    1

    
    -
     | prepare-hello 

    2

    
      -
       | process-hello 

    3

    1

    这是自动隐式追踪的范围。

    2

    自定义 span prepare-hello 表示方法 getHello （） 被调用。它是自动隐式追踪的 span 子级。

    3

    自定义 span process-hello 表示值 hello 已分配给一个新的 String 对象 hello。它是 prepare-hello 范围的子项。