【亲测免费】 OpenTelemetry Java 开源项目教程

项目介绍

OpenTelemetry 是一个开源的观测性框架，旨在提供跨服务和应用的分布式追踪、指标收集和日志记录。OpenTelemetry Java 是 OpenTelemetry 项目针对 Java 语言的实现，它提供了一套 API 和 SDK，用于在 Java 应用中实现自动和手动的数据收集。

OpenTelemetry Java 的主要特点包括：

• 标准化数据模型：确保不同服务和应用之间的数据格式一致。
• 多语言支持：除了 Java，还有针对其他语言的实现，如 Python、Go 等。
• 可扩展性：支持自定义插件和 exporter，方便集成到各种后端系统。

项目快速启动

环境准备

• Java 8 或更高版本
• Maven 或 Gradle 构建工具

添加依赖

在项目的 pom.xml 文件中添加以下依赖：

<dependencies>
    <dependency>
        <groupId>io.opentelemetry</groupId>
        <artifactId>opentelemetry-api</artifactId>
        <version>1.9.1</version>
    </dependency>
    <dependency>
        <groupId>io.opentelemetry</groupId>
        <artifactId>opentelemetry-sdk</artifactId>
        <version>1.9.1</version>
    </dependency>
    <dependency>
        <groupId>io.opentelemetry</groupId>
        <artifactId>opentelemetry-exporter-otlp</artifactId>
        <version>1.9.1</version>
    </dependency>
</dependencies>

初始化 OpenTelemetry

创建一个 OpenTelemetry 实例并配置 exporter：

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.sdk.trace.SdkTracerProvider;
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
import io.opentelemetry.semconv.resource.attributes.ResourceAttributes;

public class OpenTelemetryConfig {
    public static OpenTelemetry initOpenTelemetry() {
        OtlpGrpcSpanExporter spanExporter = OtlpGrpcSpanExporter.builder()
            .setEndpoint("http://localhost:4317")
            .build();

        Resource serviceNameResource = Resource.create(Attributes.of(
            ResourceAttributes.SERVICE_NAME, "my-service"));

        SdkTracerProvider tracerProvider = SdkTracerProvider.builder()
            .addSpanProcessor(SimpleSpanProcessor.create(spanExporter))
            .setResource(Resource.getDefault().merge(serviceNameResource))
            .build();

        OpenTelemetry openTelemetry = OpenTelemetrySdk.builder()
            .setTracerProvider(tracerProvider)
            .buildAndRegisterGlobal();

        return openTelemetry;
    }
}

创建和记录 Span

在代码中创建和记录 Span：

import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.context.Scope;

public class MyClass {
    private static final Tracer tracer = OpenTelemetryConfig.initOpenTelemetry().getTracer("my-tracer");

    public void doWork() {
        Span span = tracer.spanBuilder("my-span").startSpan();
        try (Scope scope = span.makeCurrent()) {
            // 业务逻辑
        } finally {
            span.end();
        }
    }
}

应用案例和最佳实践

案例一：Web 应用监控

在 Spring Boot 应用中集成 OpenTelemetry，实现对 HTTP 请求的自动追踪和监控。通过配置拦截器和 exporter，可以将追踪数据发送到 Jaeger 或 Zipkin 等后端系统。

案例二：数据库操作追踪

在数据库操作中手动创建 Span，记录 SQL 查询和执行时间。