Spring 使用 Spring 引导进行侦查（日志关联）- Traceid 和 SpanId 未显示

Question

我有一个现有的 Spring 引导 (2.2.0) 应用程序并尝试集成 Spring 云侦探以获得自动跟踪和跨度 ID。 logback文件如下-

<configuration>

<property name="LOGS" value="./logs" />

<appender name="Console"
          class="ch.qos.logback.core.ConsoleAppender">
    <layout class="ch.qos.logback.classic.PatternLayout">
        <Pattern>
            %black(%d{ISO8601}) %highlight(%-5level) [%blue(%t)] %yellow(%C{1.}): %msg%n%throwable
        </Pattern>
    </layout>
</appender>

<appender name="RollingFile"
          class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${LOGS}/spring-boot-logger.log</file>
    <encoder
            class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
        <Pattern>%d %p %C{1.} [%t] %m%n</Pattern>
    </encoder>

    <rollingPolicy
            class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <!-- rollover daily and when the file reaches 100 MegaBytes -->
        <fileNamePattern>${LOGS}/archived/spring-boot-logger-%d{yyyy-MM-dd}.%i.log
        </fileNamePattern>
        <timeBasedFileNamingAndTriggeringPolicy
                class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            <maxFileSize>100MB</maxFileSize>
        </timeBasedFileNamingAndTriggeringPolicy>
    </rollingPolicy>
</appender>

<!-- LOG everything at specified level level -->
<root level="info">
    <appender-ref ref="RollingFile" />
    <appender-ref ref="Console" />
</root>

此 logback 配置未按预期 log/display traceId。
据我所知，除了更新到 pom.xml 之外，不需要其他任何东西，如下 -

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-sleuth</artifactId>
            <version>2.2.0.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

和

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

令人惊讶的是，如果我在 logback 配置中包含以下内容 -

<include resource="org/springframework/boot/logging/logback/base.xml"/>

traceid、spanid 和应用程序名称显示在控制台上。可能来自 base.xml 配置。

知道我的 logback 文件或任何其他配置可能有什么问题吗？配置中是否缺少任何内容？

感谢任何帮助。

Answer 1

Well sleuth 通过 overwriting/extending 日志模式的日志级别 "field"（在 org.springframework.cloud.sleuth.autoconfig.TraceEnvironmentPostProcessor 内）

将 traceId 和 spanId 获取到日志中

所以在 defaults.xml 中（在 base.xml 中导入）spring 将 pattern 定义为：

    <property name="CONSOLE_LOG_PATTERN" value="${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}}"/>

如您所见，如果定义了变量 LOG_LEVEL_PATTERN，它就是被采用的那个（然后 TraceEnvironmentPostProcessor 中的 overwritten/extended，如果没有，它默认为默认级别模式 %5p

所以如果你不包含base.xml侦探将无法"adjust"日志级别模式LOG_LEVEL_PATTERN然后只是模式中不存在。

如文档所述 (https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto-logging)，您始终应该在您的自定义 logback.xml 中包含 base.xml，这样就没问题了。

不推荐：
尝试将您的日志级别模式定义为 ${LOG_LEVEL_PATTERN:-%5p} 而不仅仅是 %5p 或 %-5level（但如果您问我，包含 base.xml 的解决方案是正确的解决方案。

还有：
https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-custom-log-configuration 列出 application.(properties|yml) 字段以调整 spring- 从属性启动日志记录。

例如我有自定义 BaggageFields 用于向下游传播，我的 application.properties 用于在日志文件中查看它们我定义应用程序属性如下：（我不定义自定义 logback.xml!)

侦探 2.0+

logging:
  pattern:
    level: "%5p [${spring.zipkin.service.name:${spring.application.name:-}},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}] [%X{ddd:-},%X{bp:-},%X{bpids:-}] [%X{op:-},%X{chunk:-},%X{i:-}]"

侦探 3.0+

logging:
  pattern:
    level: "%5p [${spring.zipkin.service.name:${spring.application.name:}},%X{traceId:-},%X{spanId:-}] [%X{ddd:-},%X{bp:-},%X{bpids:-}] [%X{op:-},%X{chunk:-},%X{i:-}]"

Answer 2

万一有人在寻找解决方案，我可以通过以下更改获得它 - 给你logback添加以下内容-spring.xml

 <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />

然后在您的日志模式中使用以下变量 -

%clr(${LOG_LEVEL_PATTERN:-%5p})

例如：-

<Pattern>%d %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(%-40.40logger{39}) %clr([%20.20t]) %clr(:) %m%n</Pattern>

希望这对某人有所帮助。

Spring 使用 Spring 引导进行侦查（日志关联）- Traceid 和 SpanId 未显示

Spring sleuth with SpringBoot (log correlation) - Traceid & SpanId Not displayed

logback

spring-boot

spring-cloud-sleuth