Spring Boot 如何启用分布式跟踪并让日志输出关联的 Correlation ID【免费下载链接】spring-bootSpring Boot helps you to create Spring-powered, production-grade applications and services with absolute minimum fuss.项目地址: https://gitcode.com/gh_mirrors/sp/spring-boot如果你的 Spring Boot 应用需要把 HTTP 请求上报为分布式追踪trace并希望每行日志都带有可以和追踪关联的 Correlation ID本文给出官方文档中的完整操作路径添加追踪 starter 依赖、配置采样率、启动追踪后端、在 Zipkin UI 中确认 trace以及理解/定制 Correlation ID 的日志格式。主路径使用 OpenZipkin Brave Zipkin 组合这是 Spring Boot 文档示例采用的组合OpenTelemetry OTLP 组合作为可选分支简要说明。先准备一个带日志输出的示例应用追踪效果依赖日志中的 Correlation ID所以示例应用要在处理请求时打一条日志。文档中的示例代码如下源文件见 MyApplication.javaimport org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; RestController SpringBootApplication public class MyApplication { private static final Log logger LogFactory.getLog(MyApplication.class); RequestMapping(/) String home() { logger.info(home() has been called); return Hello World!; } public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } }关键点home()方法里的logger.info(...)语句就是后面用来观察 Correlation ID 的日志来源不要省略。添加追踪依赖并配置采样Spring Boot Actuator 为 Micrometer Tracing 提供了依赖管理和自动配置并内置以下 tracer 的自动配置OpenTelemetry通过 OTLP 上报starter 为org.springframework.boot:spring-boot-starter-opentelemetryOpenZipkin Brave上报到 Zipkinstarter 为org.springframework.boot:spring-boot-starter-zipkin。主路径选用 Brave Zipkin在构建文件中添加dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-zipkin/artifactId /dependency然后添加以下application.yml配置management: tracing: sampling: probability: 1.0原因Spring Boot 默认只采样 10% 的请求以避免压垮追踪后端。把management.tracing.sampling.probability设为1.0后每个请求都会发送到追踪后端。如果你只需要部分请求上报可以调低这个值但要留意被采样丢弃的请求不会出现在后端里。可选分支如果选用 OpenTelemetry则改用org.springframework.boot:spring-boot-starter-opentelemetry依赖用management.opentelemetry.tracing.export.otlp.*系列属性配置 OTLP 上报并可以通过management.opentelemetry.tracing.sampler选择采样器默认值为parent-based-trace-id-ratio即按management.tracing.sampling.probability的比例采样。启动追踪后端并验证 traceCorrelation ID 之外要看到完整的 trace 还需要一个运行中的追踪后端。文档以 Zipkin 为例按 Zipkin Quickstart guide 的说明在本地启动一个 Zipkin 实例文档中 UI 地址为http://localhost:9411。Zipkin 启动后再启动你的应用然后做两步验证用浏览器打开http://localhost:8080看到输出Hello World!文档示例输出。这一步同时触发了一次 HTTP 请求的 observation它会被桥接到 Brave 并上报一条新 trace 到 Zipkin。打开 Zipkin UIhttp://localhost:9411点击 Run Query 列出所有已收集的 trace应该能看到一条 trace点击 Show 可以查看这条 trace 的细节见 tracing.adoc 的 Getting Started 一节。让日志输出关联的 Correlation ID启用 Micrometer Tracing 后Spring Boot 默认就会把 Correlation ID 写进日志把日志行与 span/trace 关联起来这一步不需要额外代码。默认格式的构成默认 Correlation ID 由traceId和spanId两个 MDC 值组成形如[traceId-spanId]。例如文档中的示例MDCtraceId为803B448A0489F84084905D3093480352、spanId为3425F23BB2432450时日志输出会包含 Correlation ID[803B448A0489F84084905D3093480352-3425F23BB2432450]这是文档给出的示例值实际运行中 ID 会不同。默认的 Correlation ID 格式会跟随 MDC 键名并自动把键名填充到 32 和 16 个字符因此无需额外配置就能继续工作。两个需要注意的边界Brave 的 baggage 影响 MDC 键名使用 Brave 时MDC 键名只在 baggage 开启时生效。把management.tracing.baggage.enabled设为false会阻止 Brave 把 trace/span ID 写入 MDC从而直接禁用日志关联。如果你依赖日志里的 Correlation ID不要关闭 baggage。自定义 MDC 键名可以用management.tracing.mdc.trace-id-key和management.tracing.mdc.span-id-key两个属性自定义traceId/spanId的 MDC 键名默认 Correlation ID 格式会自动跟随新键名。如果你想要别的格式例如 Spring Cloud Sleuth 曾经使用的格式用logging.pattern.correlation属性自定义。注意自己设置的值会优先于从 MDC 键名推导的格式所以它必须自行引用你自定义过的键名。文档给出的 Logback 示例logging: pattern: correlation: [${spring.application.name:},%X{traceId:-},%X{spanId:-}] include-application-name: false两点说明logging.pattern.correlation值末尾的空格用于把它和紧随其后的 logger 名称隔开logging.include-application-name设为false是为了避免应用名在日志里重复出现因为上面的 correlation 格式里已经包含了${spring.application.name}。Correlation ID 依赖上下文传播context propagation。如果你的应用跨线程或使用响应式管线见 observability.adoc 的 Context Propagation 一节默认情况下ThreadLocal值不会自动在响应式算子间恢复可以通过spring.reactor.context-propagation设为auto启用自动传播使用自动配置的AsyncTaskExecutor处理Async方法时需要用spring.task.execution.propagate-context显式开启上下文传播。跨服务调用时传播 trace要让 trace 在网络上自动传播即下游服务收到请求时延续同一个 trace客户端必须用自动配置的构造器创建注入自动配置的RestClient.Builder来构造RestClient注入自动配置的WebClient.Builder来构造WebClient。文档明确警告如果不用自动配置的 builder 而直接创建RestClient或WebClient自动的 trace 传播不会生效。限制与测试场景说明采样默认 10% 采样率验证阶段建议先设为1.0确认行为后再按需调低。使用SpringBootTest时会上报数据的追踪组件不会被自动配置测试中的追踪行为与生产运行不同见 testing/spring-boot-applications.adoc 的 Tracing 一节。OpenTelemetry 组合下还可以用management.opentelemetry.tracing.limits.*控制每个 span 的属性数、事件数、链接数上限及字符串属性值最大长度。以上配置完成后日志行里的[traceId-spanId]段就是 Correlation ID拿它去 Zipkin UI 的 trace 详情中即可对应到具体的 span。更多细节Baggage、自定义 span 等见 tracing.adoc。【免费下载链接】spring-bootSpring Boot helps you to create Spring-powered, production-grade applications and services with absolute minimum fuss.项目地址: https://gitcode.com/gh_mirrors/sp/spring-boot创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
Spring Boot 如何启用分布式跟踪并让日志输出关联的 Correlation ID【免费下载链接】spring-bootSpring Boot helps you to create Spring-powered, production-grade applications and services with absolute minimum fuss.项目地址: https://gitcode.com/gh_mirrors/sp/spring-boot如果你的 Spring Boot 应用需要把 HTTP 请求上报为分布式追踪trace并希望每行日志都带有可以和追踪关联的 Correlation ID本文给出官方文档中的完整操作路径添加追踪 starter 依赖、配置采样率、启动追踪后端、在 Zipkin UI 中确认 trace以及理解/定制 Correlation ID 的日志格式。主路径使用 OpenZipkin Brave Zipkin 组合这是 Spring Boot 文档示例采用的组合OpenTelemetry OTLP 组合作为可选分支简要说明。先准备一个带日志输出的示例应用追踪效果依赖日志中的 Correlation ID所以示例应用要在处理请求时打一条日志。文档中的示例代码如下源文件见 MyApplication.javaimport org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; RestController SpringBootApplication public class MyApplication { private static final Log logger LogFactory.getLog(MyApplication.class); RequestMapping(/) String home() { logger.info(home() has been called); return Hello World!; } public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } }关键点home()方法里的logger.info(...)语句就是后面用来观察 Correlation ID 的日志来源不要省略。添加追踪依赖并配置采样Spring Boot Actuator 为 Micrometer Tracing 提供了依赖管理和自动配置并内置以下 tracer 的自动配置OpenTelemetry通过 OTLP 上报starter 为org.springframework.boot:spring-boot-starter-opentelemetryOpenZipkin Brave上报到 Zipkinstarter 为org.springframework.boot:spring-boot-starter-zipkin。主路径选用 Brave Zipkin在构建文件中添加dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-zipkin/artifactId /dependency然后添加以下application.yml配置management: tracing: sampling: probability: 1.0原因Spring Boot 默认只采样 10% 的请求以避免压垮追踪后端。把management.tracing.sampling.probability设为1.0后每个请求都会发送到追踪后端。如果你只需要部分请求上报可以调低这个值但要留意被采样丢弃的请求不会出现在后端里。可选分支如果选用 OpenTelemetry则改用org.springframework.boot:spring-boot-starter-opentelemetry依赖用management.opentelemetry.tracing.export.otlp.*系列属性配置 OTLP 上报并可以通过management.opentelemetry.tracing.sampler选择采样器默认值为parent-based-trace-id-ratio即按management.tracing.sampling.probability的比例采样。启动追踪后端并验证 traceCorrelation ID 之外要看到完整的 trace 还需要一个运行中的追踪后端。文档以 Zipkin 为例按 Zipkin Quickstart guide 的说明在本地启动一个 Zipkin 实例文档中 UI 地址为http://localhost:9411。Zipkin 启动后再启动你的应用然后做两步验证用浏览器打开http://localhost:8080看到输出Hello World!文档示例输出。这一步同时触发了一次 HTTP 请求的 observation它会被桥接到 Brave 并上报一条新 trace 到 Zipkin。打开 Zipkin UIhttp://localhost:9411点击 Run Query 列出所有已收集的 trace应该能看到一条 trace点击 Show 可以查看这条 trace 的细节见 tracing.adoc 的 Getting Started 一节。让日志输出关联的 Correlation ID启用 Micrometer Tracing 后Spring Boot 默认就会把 Correlation ID 写进日志把日志行与 span/trace 关联起来这一步不需要额外代码。默认格式的构成默认 Correlation ID 由traceId和spanId两个 MDC 值组成形如[traceId-spanId]。例如文档中的示例MDCtraceId为803B448A0489F84084905D3093480352、spanId为3425F23BB2432450时日志输出会包含 Correlation ID[803B448A0489F84084905D3093480352-3425F23BB2432450]这是文档给出的示例值实际运行中 ID 会不同。默认的 Correlation ID 格式会跟随 MDC 键名并自动把键名填充到 32 和 16 个字符因此无需额外配置就能继续工作。两个需要注意的边界Brave 的 baggage 影响 MDC 键名使用 Brave 时MDC 键名只在 baggage 开启时生效。把management.tracing.baggage.enabled设为false会阻止 Brave 把 trace/span ID 写入 MDC从而直接禁用日志关联。如果你依赖日志里的 Correlation ID不要关闭 baggage。自定义 MDC 键名可以用management.tracing.mdc.trace-id-key和management.tracing.mdc.span-id-key两个属性自定义traceId/spanId的 MDC 键名默认 Correlation ID 格式会自动跟随新键名。如果你想要别的格式例如 Spring Cloud Sleuth 曾经使用的格式用logging.pattern.correlation属性自定义。注意自己设置的值会优先于从 MDC 键名推导的格式所以它必须自行引用你自定义过的键名。文档给出的 Logback 示例logging: pattern: correlation: [${spring.application.name:},%X{traceId:-},%X{spanId:-}] include-application-name: false两点说明logging.pattern.correlation值末尾的空格用于把它和紧随其后的 logger 名称隔开logging.include-application-name设为false是为了避免应用名在日志里重复出现因为上面的 correlation 格式里已经包含了${spring.application.name}。Correlation ID 依赖上下文传播context propagation。如果你的应用跨线程或使用响应式管线见 observability.adoc 的 Context Propagation 一节默认情况下ThreadLocal值不会自动在响应式算子间恢复可以通过spring.reactor.context-propagation设为auto启用自动传播使用自动配置的AsyncTaskExecutor处理Async方法时需要用spring.task.execution.propagate-context显式开启上下文传播。跨服务调用时传播 trace要让 trace 在网络上自动传播即下游服务收到请求时延续同一个 trace客户端必须用自动配置的构造器创建注入自动配置的RestClient.Builder来构造RestClient注入自动配置的WebClient.Builder来构造WebClient。文档明确警告如果不用自动配置的 builder 而直接创建RestClient或WebClient自动的 trace 传播不会生效。限制与测试场景说明采样默认 10% 采样率验证阶段建议先设为1.0确认行为后再按需调低。使用SpringBootTest时会上报数据的追踪组件不会被自动配置测试中的追踪行为与生产运行不同见 testing/spring-boot-applications.adoc 的 Tracing 一节。OpenTelemetry 组合下还可以用management.opentelemetry.tracing.limits.*控制每个 span 的属性数、事件数、链接数上限及字符串属性值最大长度。以上配置完成后日志行里的[traceId-spanId]段就是 Correlation ID拿它去 Zipkin UI 的 trace 详情中即可对应到具体的 span。更多细节Baggage、自定义 span 等见 tracing.adoc。【免费下载链接】spring-bootSpring Boot helps you to create Spring-powered, production-grade applications and services with absolute minimum fuss.项目地址: https://gitcode.com/gh_mirrors/sp/spring-boot创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
