Tracing

概览

本模块主要提供Tracing最终的配置和定制化的指引。可以选择zipkin、skywalking接入。

  • macula-boot-starter-sleuth 接入zipkin
  • macula-boot-starter-skywalking 接入skywalking

组件坐标

Sleuth

<dependency>
    <groupId>dev.macula.boot</groupId>
    <artifactId>macula-boot-starter-sleuth</artifactId>
    <version>${macula.version}</version>
</dependency>

Skywalking

<dependency>
    <groupId>dev.macula.boot</groupId>
    <artifactId>macula-boot-starter-skywalking</artifactId>
    <version>${macula.version}</version>
</dependency>

使用配置

Sleuth

可以参考网上的文章。

接入zipkin

配置zipkin地址，支持http、kafka、rabbitmq等上报方式，高并发时建议使用kafaka

spring:
	zipkin:
    base-url: http://ip:port    #zipkin server 的地址
    sender:
      type: web    #如果ClassPath里没有kafka, active MQ, 默认是web的方式
    sleuth:
      sampler:
        probability: 1.0  #100%取样，生产环境应该低一点,用不着全部取出来

引入依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-sleuth-zipkin</artifactId>
</dependency>

可以参考官网进一步了解详细配置

Skywaking

接入Skywalking

接入Skywalking需要在启动命令行添加-javaagent参数，具体可参考官网

将日志发送到Skywalking（不推荐）

添加macula-boot-starter-skywalking依赖，在你的logback-spring.xml的配置文件中，加入include

<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<include resource="logback-appender.xml" />
<root level="INFO">
    <appender-ref ref="skywalking-console"/>
    <appender-ref ref="skywalking-grpc"/>
</root>

上述include的内容如下：

<included>
    <!-- 控制台输出 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.mdc.TraceIdMDCPatternLogbackLayout">
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            </layout>
        </encoder>
    </appender>

    <!-- 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.mdc.TraceIdMDCPatternLogbackLayout">
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            </layout>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="stdout"/>
        <appender-ref ref="grpc-log"/>
    </root>
</included>

核心功能

Sleuth

日志中添加traceid

默认情况下，引入上述依赖后，日志格式中已经添加了traceid。通过TraceEnvironmentPostProcessor类自动修改logging.pattern.level。

自定义埋点

请参考官方文档

Skywalking

日志中添加traceid

默认情况下，引入上述依赖后，日志格式中已经添加了traceid。

自定义埋点

请参考官方文档

依赖引入

Sleuth

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-sleuth</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-sleuth-zipkin</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

Skywalking

<dependencies>
    <!-- skywalking 整合 logback -->
    <dependency>
        <groupId>org.apache.skywalking</groupId>
        <artifactId>apm-toolkit-logback-1.x</artifactId>
    </dependency>
    <dependency>
        <groupId>org.apache.skywalking</groupId>
        <artifactId>apm-toolkit-trace</artifactId>
    </dependency>
</dependencies>

版权说明