使用 OpenTelemetry 在 Spring Boot 中添加 Tracer bean

Question

上下文：我必须将 Java EE 中的父库重写为 Spring Boot 中更现代的库。 例如，它有一些不推荐使用的依赖项和 CDI 部分，与 Spring 不兼容的 Microprofiles。

问题：我几乎没有使用过 OpenTelemetry 和 OpenTracing。 我只了解高级概念，但我从未编写过这样的东西。 我在重写涉及 OpenTracing 的部分时遇到了麻烦。 我知道 OpenTracing 已被弃用，我应该使用 OpenTelemetry。 有一个称为“ Tracer Resolver ”的依赖项。

它来自 Github 的描述： Resolver API for OpenTracing Tracer implementations。 注意： Tracer Resolver 机制仅用于应用程序启动/初始化时。 这个责任应该由应用程序处理，可能使用一些特定于运行时的支持（例如在 Spring Boot 中提供 Tracer @Bean 或 CDI 生产者）。 用于仪器特定技术的框架集成不应使用此库，而应允许注入 Tracer，并回退到 GlobalTracer。

在代码中唯一的 OpenTracing 依赖项：

<dependency>
    <groupId>io.opentracing.contrib</groupId>
    <artifactId>opentracing-tracerresolver</artifactId>
    <version>0.1.8</version>
</dependency>

我发现代码中的用法如下：

@ApplicationScoped
public class OpenTraceResolver {

    @Inject
    private Instance<Tracer> tracerInstance;

...

或者

@Provider
public class OpenTraceErrorResponseFilter implements ContainerResponseFilter {

    @Inject
    private Tracer configuredTracer;

...

我应该如何对 OpenTelemetry 做同样的事情？ 有没有办法以如此简单的方式使用它？

谢谢您的帮助！

Answer 1

首先 Spring 使用Spring Cloud Sleuth项目来实现分布式跟踪，您需要在配置开放遥测之前将其添加到您的项目中。 默认情况下，Spring Cloud Sleuth 默认使用OpenZipkin Brave ，这与 OpenTelemetry (Otel) 实现不同。

要将您的项目配置为使用OpenTelemetry ，您需要决定是使用更容易的自动仪器（不使用代理）还是使用手动仪器，从而为您提供更大的灵活性。

使用自动检测，您只需更改pom.xml并在application.yaml中配置导出器后端，它将自动为您生成和导出跟踪。

应用程序.yaml

spring.sleuth.otel.exporter.otlp.endpoint=[URL TO YOUR OTEL BACKEND]

您可以发送痕迹做 zipkin、grafana tempo 等。

pom.xml

 <properties> <spring-cloud.version>2021.0.0-M2</spring-cloud.version> <spring-cloud-sleuth-otel.version>1.1.0-M3</spring-cloud-sleuth-otel.version> <opentelemetry-exporter-otlp>1.7.0</opentelemetry-exporter-otlp> <grpc-netty-shaded>1.41.0</grpc-netty-shaded> </properties> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>${spring-cloud.version}</version> <type>pom</type> <scope>import</scope> </dependency> <!-- Spring Cloud Sleuth OTel requires a Spring Cloud Sleuth OTel BOM --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-sleuth-otel-dependencies</artifactId> <version>${spring-cloud-sleuth-otel.version}</version> <scope>import</scope> <type>pom</type> </dependency> </dependencies> </dependencyManagement> <!-- Sleuth with Brave tracer implementation --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-sleuth</artifactId> <exclusions> <!-- Exclude Brave (the default) --> <exclusion> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-sleuth-brave</artifactId> </exclusion> </exclusions> </dependency> <!-- Add OpenTelemetry tracer --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-sleuth-otel-autoconfigure</artifactId> </dependency> <!-- https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp --> <dependency> <groupId>io.opentelemetry</groupId> <artifactId>opentelemetry-exporter-otlp</artifactId> <version>${opentelemetry-exporter-otlp}</version> </dependency> <!-- https://mvnrepository.com/artifact/io.grpc/grpc-netty --> <dependency> <groupId>io.grpc</groupId> <artifactId>grpc-netty-shaded</artifactId> <version>${grpc-netty-shaded}</version> </dependency> <repositories> <repository> <id>spring-snapshots</id> <url>https://repo.spring.io/snapshot</url> <snapshots> <enabled>true</enabled> </snapshots> </repository> <repository> <id>spring-milestones</id> <url>https://repo.spring.io/milestone</url> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>spring-snapshots</id> <url>https://repo.spring.io/snapshot</url> </pluginRepository> <pluginRepository> <id>spring-milestones</id> <url>https://repo.spring.io/milestone</url> </pluginRepository> </pluginRepositories>

更多参考资料

• https://opentelemetry.io/docs/instrumentation/java/
• https://github.com/spring-projects-experimental/spring-cloud-sleuth-otel