Set LOG_CORRELATION_PATTERN only when correlation ID is expected #39333
Conversation
Prior to this commit, if `logging.pattern.correlation` has been set, then the correlation ID is logged regardless of the flag `logging.expect-correlation-id`. This is different from what happens with the default correlation patterns. This commit updates LoggingSystemProperties so that the system property `LOG_CORRELATION_PATTERN` is set when `logging.expect-correlation-id` is `true`. If it is `false` then the correlation ID won't be logged in any cases.
spring-projects-issues
added
the
status: waiting-for-triage
Format the code by running the `format` Gradle task.
|
Thanks for the PR. This looks sensible to me but I'd like to double-check with the rest of the team and @jonatan-ivanov. |
wilkinsona
added
the
for: team-attention
philwebb
changed the title
LOG_CORRELATION_PATTERN only when correlation ID is expected
philwebb
removed
the
for: team-attention
philwebb
added
for: team-meeting
|
Sorry for the delay in reviewing this one. Looking again, I'm not sure that we should make this change. The If we change that logic, we could break existing application that want to set correlation IDs even if they aren't using Micrometer tracing. @danielhcx Was there a specific use-case that caused you to submit this pull-request. If so, perhaps we can find a different way of solving it. |
philwebb
added
status: waiting-for-triage
philwebb
added
status: waiting-for-feedback
|
I'm going to close this one for now. If there's a specific need identified for why we need to make this change we can reopen the issue. |
philwebb
added
status: declined
Prior to this commit, if
logging.pattern.correlationhas been set, then the correlation ID is logged regardless of the flaglogging.expect-correlation-id. This is different from what happens with the default correlation patterns.This commit updates LoggingSystemProperties so that the system property
LOG_CORRELATION_PATTERNis set whenlogging.expect-correlation-idistrue. If it isfalsethen the correlation ID won't be logged in any cases.This also follows gh-38641 from the perspective of logging.