SkyWalking--打印traceId到日志/获取traceId

青旅半醒 2022-09-10 09:22 6阅读 0赞

原文网址[：SkyWalking--打印traceId到日志/获取traceId\_IT利刃出鞘的博客-CSDN博客][SkyWalking--_traceId_traceId_IT_-CSDN]

# 简介 #

本处，我的skywalking服务端版本为8.7.0.

# 打印traceId到日志 #

**其他网址**

[skywalking项目打印traceId\_xixingzhe2的博客-CSDN博客][skywalking_traceId_xixingzhe2_-CSDN]  
[Skywalking无侵入式打印traceId到日志 - 知乎][Skywalking_traceId_ -]

## **简介** ##

Skywalking可以直接在界面上看执行的链路，也可以将traceId输出到日志，这样的话，在日志里就可以分辨哪些是同一个请求。

本处，我使用logback，只配置将traceId日志输出到控制台，实际也可以写到日志文件的，方法差不多。logback配置方法见：

[Java日志--logback--配置/介绍/说明/基础\_IT利刃出鞘的博客-CSDN博客][Java_--logback--_IT_-CSDN]

[Java日志--logback--SpringBoot--整合/使用/用法/实例/示例/实战\_IT利刃出鞘的博客-CSDN博客][Java_--logback--SpringBoot--_IT_-CSDN]

## **实例** ##

**pom.xml**

<dependency>
        <groupId>org.apache.skywalking</groupId>
        <artifactId>apm-toolkit-logback-1.x</artifactId>
        <version>8.7.0</version>
    </dependency>

**logback-spring.xml（放到resources目录下）**

> 添加此配置
> 
>     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
>         <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
>             <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
>                 <pattern>[%tid] ${CONSOLE_LOG_PATTERN:-%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %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}}</pattern>
>             </layout>
>         </encoder>
>     </appender>
> 
>  *  使用\[%tid\] 来占trace-id的位置，默认为TID:N/A，当有请求调用时，会显示trace-id。

> 所有配置
> 
>     <?xml version="1.0" encoding="UTF-8"?>
>     <configuration>
>     
>         
>     
>         <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
>         
>         
>     
>         <springProperty scope="context" name="appName" source="spring.application.name"/>
>     
>         <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
>             <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
>                 <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
>                     <pattern>[%tid] ${CONSOLE_LOG_PATTERN:-%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %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}}</pattern>
>                 </layout>
>             </encoder>
>         </appender>
>     
>         <root level="INFO">
>             <appender-ref ref="STDOUT"/>
>         </root>
>     </configuration>

**启动结果**

> ![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASVTliKnliIPlh7rpnpg_size_20_color_FFFFFF_t_70_g_se_x_16][]
> 
> 可以发现，没有请求的时候，打印的是：\[TID:N/A\]，有请求进来时，打印traceId

# 代码中获取traceId #

**其他网址**

> [skywalking获取traceId(tid)的方式\_lijunwyf的专栏-CSDN博客][skywalking_traceId_tid_lijunwyf_-CSDN]  
> [skywalking04 - skywalking自定义链路追踪@Trace\_过了这个村没这个老王的博客-CSDN博客][skywalking04 - skywalking_Trace_-CSDN]

## **简介** ##

> 我们可以在代码中获取到traceId，这样一来，我们可以做如下操作：
> 
>  *  将traceId传给前端。
>  *  将traceId连同本次请求的信息记录到操作日志中
> 
> 有了traceId，我们就可以直接到skywalking的界面中根据traceId来搜索了：
> 
> ![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASVTliKnliIPlh7rpnpg_size_20_color_FFFFFF_t_70_g_se_x_16 1][]

## **用法** ##

**步骤1：在想获取traceId的地方加@Trace注解**

> 例如：
> 
>     @PostMapping("create")
>     @Trace
>     public Result create(Order order) {
>         orderService.create(order);
>         return new Result().message("创建订单成功");
>     }
> 
> Trace所在包：import org.apache.skywalking.apm.toolkit.trace.Trace;

**步骤2：获得注解**

> 例：
> 
>     @PostMapping("create")
>     @Trace
>     public Result create(Order order) {
>         orderService.create(order);
>         String traceId = TraceContext.traceId();
>         return new Result().message("创建订单成功");
>     }
> 
> TraceContext所在包：import org.apache.skywalking.apm.toolkit.trace.TraceContext;

> TraceContext可以获得spanId等其他信息：
> 
> ![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASVTliKnliIPlh7rpnpg_size_16_color_FFFFFF_t_70_g_se_x_16][]

## 项目应用 ##

实际上，项目中不需要每个方法都加@Trace这个注解来获得traceId，只需要在全局响应的地方来获取即可。

下边展示项目中的实际用法（我是实测过的，可以获取到traceId）。

package com.example.common.advice;
    
    import com.example.common.entity.Result;
    import com.fasterxml.jackson.core.JsonProcessingException;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import lombok.extern.slf4j.Slf4j;
    import org.apache.skywalking.apm.toolkit.trace.Trace;
    import org.apache.skywalking.apm.toolkit.trace.TraceContext;
    import org.springframework.core.MethodParameter;
    import org.springframework.http.MediaType;
    import org.springframework.http.converter.HttpMessageConverter;
    import org.springframework.http.server.ServerHttpRequest;
    import org.springframework.http.server.ServerHttpResponse;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
    
    @Slf4j
    @ControllerAdvice
    public class GlobalResponseBodyAdvice implements ResponseBodyAdvice<Object> {
        @Override
        public boolean supports(MethodParameter returnType,
                                Class<? extends HttpMessageConverter<?>> converterType) {
            // 若接口返回的类型本身就是ResultWrapper，则无需操作，返回false
            // return !returnType.getParameterType().equals(ResultWrapper.class);
            return true;
        }
    
        @Override
        @ResponseBody
        @Trace
        public Object beforeBodyWrite(Object body, MethodParameter returnType,
                                      MediaType selectedContentType,
                                      Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                      ServerHttpRequest request, ServerHttpResponse response) {
    
            String traceId = TraceContext.traceId();
    
            if (body instanceof String) {
                // 若返回值为String类型，需要包装为String类型返回。否则会报错
                try {
                    ObjectMapper objectMapper = new ObjectMapper();
                    Result<Object> result = new Result<>().data(body).traceId(traceId);
                    return objectMapper.writeValueAsString(result);
                } catch (JsonProcessingException e) {
                    throw new RuntimeException("序列化String错误");
                }
            } else if (body instanceof Result) {
                return ((Result)body).traceId(traceId);
            }
    
            return new Result<>().traceId(traceId).data(body);
        }
    }

[SkyWalking--_traceId_traceId_IT_-CSDN]: https://knife.blog.csdn.net/article/details/120147462
[skywalking_traceId_xixingzhe2_-CSDN]: https://blog.csdn.net/xixingzhe2/article/details/114640591
[Skywalking_traceId_ -]: https://zhuanlan.zhihu.com/p/347660650
[Java_--logback--_IT_-CSDN]: https://knife.blog.csdn.net/article/details/120446335
[Java_--logback--SpringBoot--_IT_-CSDN]: https://knife.blog.csdn.net/article/details/120446300
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASVTliKnliIPlh7rpnpg_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/02d3d998d23642eaab3439ad7487128f.png
[skywalking_traceId_tid_lijunwyf_-CSDN]: https://blog.csdn.net/lijunwyf/article/details/107954543
[skywalking04 - skywalking_Trace_-CSDN]: https://blog.csdn.net/a17816876003/article/details/113702511
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASVTliKnliIPlh7rpnpg_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220829/34dedb3264334d29a145edd95ec77847.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASVTliKnliIPlh7rpnpg_size_16_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/811eaa2e8cc64c5c8e58a27609f98d11.png