如何使用OpenTelemetry将Trace ID自动写入日志

Java

更多信息

• 使用Log4j2
  1. 在pom.xml中添加OpenTelemetry Log4j2依赖，请将OPENTELEMETRY_VERSION替换为最新版本。示例如下：

     <artifactId>opentelemetry-log4j-context-data-2.17-autoconfigure</artifactId>

  2. 修改log4j2.xml配置，在pattern中添加%X{trace_id} ，可以将Trace ID自动写入日志。

     日志格式示例如下：

      pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} trace_id=%X{trace_id} trace_flags=%X{trace_flags} - %msg%n"

• 使用Logback
  1. 在pom.xml中添加OpenTelemetry Logback依赖。请将OPENTELEMETRY_VERSION替换为最新版本。
     1. 示例如下：

        <artifactId>opentelemetry-logback-mdc-1.0</artifactId>

     2. 修改log4j2.xml配置，在pattern中添加%X{trace_id} ，可以将Trace ID自动写入日志。

        日志格式示例如下：

        <pattern>%d{HH:mm:ss.SSS} trace_id=%X{trace_id} span_id=%X{span_id} trace_flags=%X{trace_flags} %msg%n</pattern>

• 使用Logback（SpringBoot项目）

  Spring Boot项目已经内置了日志框架，默认使用Logback实现日志相关功能。因此，只需增加少量配置即可实现Trace ID写入日志。

  在application.properties中设置logging.pattern.level，添加%mdc{trace_id}与%mdc{span_id}到日志中。示例如下：

  logging.pattern.level=trace_id=%mdc{trace_id} %5p

GO

OpenTelemetry Go需要在记录日志时手动添加Trace ID。

1. 引入依赖。

   import (
        oteltrace "go.opentelemetry.io/otel/trace"    "github.com/sirupsen/logrus"
   )

2. 创建工具函数，从Span中提取Trace ID，并添加到Logrus日志字段。

   func LogrusFields(span oteltrace.Span) logrus.Fields {
        return logrus.Fields{
            "trace_id": span.SpanContext().TraceID().String(),         
        }
    }

3. 创建一个Span后，即可记录带有Trace ID的日志。

   ... 
   defer span.End() 
   logEntry := logrus.WithFields(LogrusFields(span)) 
   logEntry.Info("This is an info message with trace ID") 
   ...

Python

OpenTelemetry Python支持自动将Trace ID写入日志中。如需要获取更多信息，请参见 OpenTelemetry 日志的简介。