#与 TraceID 相关的业务日志

#背景

• 为了正确将多个自动发送的跨度（在单次请求中调用的不同模块/节点/服务）关联到一个单独的跟踪中，服务的 HTTP 请求头将包括 TraceID 及其他用于关联跟踪的信息。

• 一个跟踪代表单次请求的调用过程，TraceID 是标识该请求的唯一 ID。通过日志中的 TraceID，可以将跟踪信息与应用程序日志关联。

基于以上背景，本文将说明如何从 HTTP 请求头中获取 TraceID 并将其添加到应用程序日志中，从而允许您在平台上使用 TraceID 精确查询日志数据。

#将 TraceID 添加到 Java 应用程序日志

方法 1：配置 logging.pattern.level

在您的应用程序配置中修改 logging.pattern.level 参数如下：

方法 2：配置 CONSOLE_LOG_PATTERN

1. 修改 logback 配置文件如下。

   TIP

   控制台输出作为示例，此处的 %X{trace_id} 表示从 MDC 中检索到的 trace_id 的值。

   <property name="CONSOLE_LOG_PATTERN"
       value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} [trace_id=%X{trace_id}] %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
   

2. 在需要输出日志的类中，添加 @Slf4j 注解，并使用日志对象输出日志，如下所示：

   @RestController
   @Slf4j
   public class ProviderController {
   
       @GetMapping("/hello")
       public String hello(HttpServletRequest request) {
           log.info("request /hello");
           return "hello world";
       }
   }
   

#将 TraceID 添加到 Python 应用程序日志

1. 在应用程序代码中，添加以下代码以从请求头中获取 TraceID。示例代码如下，可根据需要进行调整：

   TIP

   getForwardHeaders 函数从请求头中检索跟踪信息，其中 x-b3-traceid 的值是 TraceID。

      def getForwardHeaders(request):
          headers = {}
          incoming_headers = [
              'x-request-id',  # 所有应用程序都应传递 x-request-id 以供访问日志和一致的跟踪/日志采样决策
              'x-b3-traceid',  # B3 跟踪头，兼容 Zipkin、OpenCensusAgent 和 Stackdriver 配置
              'x-b3-spanid',
              'x-b3-parentspanid',
              'x-b3-sampled',
              'x-b3-flags',
          ]
          for ihdr in incoming_headers:
              val = request.headers.get(ihdr)
              if val is not None:
                  headers[ihdr] = val
   
          return headers
   

2. 在应用程序代码中，添加以下代码，以将获取的 TraceID 包含在日志中。示例代码如下，可根据需要进行调整：

   headers = getForwardHeaders(request) tracing_section = ' [%(x-b3-traceid)s,%(x-b3-spanid)s] ' % headers logging.info(tracing_section + "Oops, unexpected error happens.")

#验证方法

1. 点击左侧导航栏中的 Tracing。

2. 在查询条件中，选择 TraceID，输入 TraceID 进行查询，然后点击 Add to query。

3. 在下方显示的跟踪数据中，点击 TraceID 旁的 View Log。

4. 在 Log Query 页面，勾选 Contain Trace ID; 系统将仅显示包含 TraceID 的日志数据。