OpenTelemetry Java日志集成：管理日志级别与传统框架的最佳实践

<dependencies>
    <!-- Spring Boot Starter Web, Logback是其默认日志实现 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- OpenTelemetry BOM (可选，但推荐用于管理所有OTel依赖版本) -->
    <dependency>
        <groupId>io.opentelemetry</groupId>
        <artifactId>opentelemetry-bom</artifactId>
        <version>1.37.0</version> <!-- 替换为最新版本 -->
        <type>pom</type>
        <scope>import</scope>
    </dependency>

    <!-- OpenTelemetry Logback Appender -->
    <dependency>
        <groupId>io.opentelemetry.instrumentation</groupId>
        <artifactId>opentelemetry-logback-appender-1.0</artifactId>
        <version>1.37.0</version> <!-- 替换为与BOM一致的版本 -->
    </dependency>

    <!-- OpenTelemetry SDK 和 Exporter (如果需要直接导出日志，而不仅仅是注入MDC) -->
    <dependency>
        <groupId>io.opentelemetry</groupId>
        <artifactId>opentelemetry-sdk</artifactId>
    </dependency>
    <dependency>
        <groupId>io.opentelemetry</groupId>
        <artifactId>opentelemetry-exporter-otlp</artifactId>
    </dependency>
</dependencies>

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 控制台Appender，用于本地开发调试 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!-- 包含traceId和spanId的日志格式 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - [%X{traceId:-},%X{spanId:-}] %msg%n</pattern>
        </encoder>
    </appender>

    <!-- OpenTelemetry Logback Appender -->
    <!-- 这个Appender会将日志事件发送到OpenTelemetry SDK进行处理和导出 -->
    <appender name="OTEL" class="io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender">
        <!-- 默认情况下，OpenTelemetryAppender会将traceId和spanId注入到MDC中 -->
        <!-- 如果您需要将日志直接导出到OpenTelemetry Collector，可以配置Exporter -->
        <!-- <exporter class="io.opentelemetry.sdk.logs.export.OtlpLogExporter" /> -->
    </appender>

    <!-- 设置根日志级别 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="OTEL"/> <!-- 将日志也发送给OpenTelemetry Appender -->
    </root>

    <!-- 可以为特定包设置不同的日志级别 -->
    <logger name="com.example.myapp" level="DEBUG" additivity="false">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="OTEL"/>
    </logger>

    <logger name="org.springframework" level="WARN"/>
    <logger name="org.hibernate" level="WARN"/>

</configuration>

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.trace.SdkTracerProvider;
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
import io.opentelemetry.sdk.logs.SdkLoggerProvider;
import io.opentelemetry.sdk.logs.export.SimpleLogProcessor;
import io.opentelemetry.exporter.otlp.logs.OtlpGrpcLogExporter;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.semconv.resource.attributes.ResourceAttributes;

public class OpenTelemetryConfig {

    public static OpenTelemetry initOpenTelemetry() {
        Resource resource = Resource.getDefault()
                .toBuilder()
                .put(ResourceAttributes.SERVICE_NAME, "my-spring-service")
                .put(ResourceAttributes.SERVICE_VERSION, "1.0.0")
                .build();

        // 配置TracerProvider
        SdkTracerProvider tracerProvider = SdkTracerProvider.builder()
                .addSpanProcessor(SimpleSpanProcessor.create(OtlpGrpcSpanExporter.builder().build()))
                .setResource(resource)
                .build();

        // 配置LoggerProvider (用于日志导出)
        // 注意：这里的LoggerProvider是用于OpenTelemetry自身的日志导出，
        // 而非传统日志框架的日志生成。
        SdkLoggerProvider loggerProvider = SdkLoggerProvider.builder()
                .addLogProcessor(SimpleLogProcessor.create(OtlpGrpcLogExporter.builder().build()))
                .setResource(resource)
                .build();

        OpenTelemetrySdk openTelemetrySdk = OpenTelemetrySdk.builder()
                .setTracerProvider(tracerProvider)
                .setLoggerProvider(loggerProvider)
                .buildAndRegisterGlobal();

        // 在应用关闭时关闭TracerProvider和LoggerProvider
        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
            tracerProvider.shutdown();
            loggerProvider.shutdown();
        }));

        return openTelemetrySdk;
    }
}