spring-cloud-sleuth简单使用

快速开始

一、导入依赖

            <!--链路追踪 start-->

            <dependency>

                <groupId>org.springframework.cloud</groupId>

                <artifactId>spring-cloud-sleuth</artifactId>

                <version>2.0.0.RELEASE</version>

                <type>pom</type>

                <scope>import</scope>

            </dependency>

            <!--链路追踪 end-->

如果是多module的记得在相应的module的pom文件添加

        <dependency>

            <groupId>org.springframework.cloud</groupId>

            <artifactId>spring-cloud-starter-sleuth</artifactId>

        </dependency>

二、此时，启动你的项目

你应该就可以在日志文件看见traceId了

日志

如果你的日志文件是有做过格式设置的，可能一开始看不到traceId的输出，可以使用下述的日志格式。

<configuration>

    <!-- TraceId:%X{X-B3-TraceId:-} SpanId：%X{X-B3-SpanId:-}-->

    <property name="CONSOLE_LOG_PATTERN"

              value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [traceId= %X{X-B3-TraceId:-}] [SpanId= %X{X-B3-SpanId:-}] %logger{5} - %msg%n"/>

    <appender name="rollingAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <file>${LOG_PATH}/billmanager.log</file>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

            <fileNamePattern>/logs/heuristic-%d{yyyy-MM-dd}.log</fileNamePattern>

            <maxHistory>30</maxHistory>

        </rollingPolicy>

        <!-- 必须指定，否则不会往文件输出内容 -->

        <encoder>

            <pattern>${CONSOLE_LOG_PATTERN}</pattern>

            <charset>utf8</charset>

        </encoder>

        <append>false</append>

        <prudent>false</prudent>

    </appender>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">

        <encoder>

            <pattern>${CONSOLE_LOG_PATTERN}</pattern>

            <charset>utf8</charset>

        </encoder>

    </appender>

    <root level="info">

        <appender-ref ref="STDOUT"/>

        <appender-ref ref="rollingAppender"/>

    </root>

</configuration>

获取当前的traceId

sleuth 多用于分部署系统，和 zipkin 配合使用，不过有时候我们可能也需要在项目中获取traceId，可以参考下述的方式。

import brave.Tracer;

@Service

public class Breadcrumb {

  @Autowired

  private Tracer tracer;

  public String breadcrumbId() {

    return tracer.currentSpan().context().traceIdString();

  }

}