Skip to content

Commit 228b8eb

Browse files
Polish log correlation docs
Docs related to gh-33280 (log correlation) and gh-35593 (application name in each log line) need some polishing: - Fix project names - Show how to avoid having the application name duplicated in logs - Call out that a trailing space is needed in the correlation pattern Closes gh-36035 See gh-33280 See gh-35593
1 parent 89164dd commit 228b8eb

File tree

2 files changed

+10
-5
lines changed
  • spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator
  • spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator

2 files changed

+10
-5
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/tracing.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,22 +69,26 @@ Press the "Show" button to see the details of that trace.
6969

7070
[[actuator.micrometer-tracing.logging]]
7171
=== Logging Correlation IDs
72-
Correlation IDs provide a helpful way to link lines in your log files to distributed traces.
73-
By default, as long as configprop:management.tracing.enabled[] has not been set to `false`, Spring Boot will include correlation IDs in your logs whenever you are using Micrometer tracing.
72+
Correlation IDs provide a helpful way to link lines in your log files to spans/traces.
73+
By default, as long as configprop:management.tracing.enabled[] has not been set to `false`, Spring Boot will include correlation IDs in your logs whenever you are using Micrometer Tracing.
7474

7575
The default correlation ID is built from `traceId` and `spanId` https://logback.qos.ch/manual/mdc.html[MDC] values.
76-
For example, if Micrometer tracing has added an MDC `traceId` of `803B448A0489F84084905D3093480352` and an MDC `spanId` of `3425F23BB2432450` the log output will include the correlation ID `[803B448A0489F84084905D3093480352-3425F23BB2432450]`.
76+
For example, if Micrometer Tracing has added an MDC `traceId` of `803B448A0489F84084905D3093480352` and an MDC `spanId` of `3425F23BB2432450` the log output will include the correlation ID `[803B448A0489F84084905D3093480352-3425F23BB2432450]`.
7777

7878
If you prefer to use a different format for your correlation ID, you can use the configprop:logging.pattern.correlation[] property to define one.
79-
For example, the following will provide a correlation ID for Logback in format previously used by Spring Sleuth:
79+
For example, the following will provide a correlation ID for Logback in format previously used by Spring Cloud Sleuth:
8080

8181
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
8282
----
8383
logging:
8484
pattern:
85-
correlation: "[${spring.application.name:},%X{traceId:-},%X{spanId:-}]"
85+
correlation: "[${spring.application.name:},%X{traceId:-},%X{spanId:-}] "
86+
include-application-name: false
8687
----
8788

89+
NOTE: In the example above, configprop:logging.include-application-name[] is set to `false` to avoid the application name being duplicated in the log messages (configprop:logging.pattern.correlation[] already contains it).
90+
It's also worth mentioning that configprop:logging.pattern.correlation[] contains a trailing space so that it is separated from the logger name that comes right after it by default.
91+
8892

8993

9094
[[actuator.micrometer-tracing.tracer-implementations]]

spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/build.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ dependencies {
1111
implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-security"))
1212
implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-web"))
1313
implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-validation"))
14+
implementation 'io.micrometer:micrometer-tracing-bridge-brave'
1415

1516
runtimeOnly("com.h2database:h2")
1617

0 commit comments

Comments
 (0)