SpringCloud链路追踪SkyWalking-第六章-日志采集

参考

文档：https://skyapm.github.io/document-cn-translation-of-skywalking/zh/8.0.0/setup/service-agent/java-agent/Application-toolkit-logback-1.x.html
官方文档：https://github.com/apache/skywalking/blob/v8.5.0/docs/en/setup/service-agent/java-agent/Application-toolkit-logback-1.x.md

9.1.0文档：https://skywalking.apache.org/docs/skywalking-java/latest/en/setup/service-agent/java-agent/readme/

引入依赖，版本要在8.4.0以上

版本需要对应skywalking-agent的版本，最新是8.11.0

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

添加logback配置文件

修改application.yml

logging:
  # 如果不配置如下，默认读取logback.xml
  #config: classpath:logback.xml

修改logback.yml

重点是设置输出tid，可以在任何位置设置打印。
当你使用-javaagent激活skywalking tracer后，logback将会输出traceId（如果存在的话）。如果tracer未激活，输出将是TID: N/A

方法一 按需设置打印

编写logback⽇志配置⽂件。在resources下新建⼀个logback-spring.xml⽂件，根据官⽹⽂档编写配置⽂件，可以写作以下两种。TraceIdMDCPatternLogbackLayout，需要将[%tid]改为[%X{tid}]

• 在logback.xml的Pattern部分中设置%tid

    <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>%d{yyyy-MM-dd HH:mm:ss.SSS} [%tid] [%thread] %-5level %logger{36} -%msg%n</Pattern>
            </layout>
        </encoder>
    </appender>

• 使用MDC，在logback.xml的Pattern部分中设置%X{tid}
  MDC采⽤Map的⽅式存储上下⽂，线程独⽴的，⼦线程会从⽗线程拷贝上下⽂

    <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.mdc.TraceIdMDCPatternLogbackLayout">
                <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{tid}] [%thread] %-5level %logger{36} -%msg%n</Pattern>
            </layout>
        </encoder>
    </appender>

方法二 搜集所有日志

这种方式会把所有日志都集成到skywalking了。
我们在logback.xml中单独定义添加如下

<!--  skywalking采集日志  -->
    <appender name="grpc-log" class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.log.GRPCLogClientAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{tid}] [%thread] %-5level %logger{36} -%msg%n</pattern>
            </layout>
        </encoder>
    </appender>
<!-- 设置appender -->
<springProfile name="dev">
        <root level="info">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="DEBUG_FILE"/>
            <appender-ref ref="INFO_FILE"/>
            <appender-ref ref="WARN_FILE"/>
            <appender-ref ref="ERROR_FILE"/>
            <appender-ref ref="grpc-log"/>
        </root>
    </springProfile>

修改agent配置文件

假如skywalking没有部署在本地，就需要作如下配置
打开agent/config/agent.config配置文件，添加如下配置信息

8.8.0以上版本

配置项说明：https://skywalking.apache.org/docs/skywalking-java/latest/en/setup/service-agent/java-agent/configurations/

8.8.0以下版本

Add config of the plugin or use default

plugin.toolkit.log.grpc.reporter.server_host=${SW_GRPC_LOG_SERVER_HOST:127.0.0.1}
plugin.toolkit.log.grpc.reporter.server_port=${SW_GRPC_LOG_SERVER_PORT:11800}
plugin.toolkit.log.grpc.reporter.max_message_size=${SW_GRPC_LOG_MAX_MESSAGE_SIZE:10485760}
plugin.toolkit.log.grpc.reporter.upstream_timeout=${SW_GRPC_LOG_GRPC_UPSTREAM_TIMEOUT:30}

分析

我们发送请求之后在控制台会输入如下：

在skywalking中可以看到如下：

问题

SpringGateway无法打印tid

参考：SpringCloudGateway使用Skywalking时日志打印traceId