Allow configuring Micrometer Tracing MDC keys#50595
Open
philsttr wants to merge 4 commits into
Open
Conversation
Allow the user to configure the names of the MDC keys in which the trace id and span id are stored when using Micrometer Tracing. Introduce the following new properties: - management.tracing.mdc.trace-id-key (default: "traceId") - management.tracing.mdc.span-id-key (default: "spanId") The properties are honored by both the Brave and OpenTelemetry Micrometer Tracing bridges. The default key names keep backwards compatibility with the previously hardcoded values. Signed-off-by: Phil Clay <philsttr@users.noreply.github.com>
spring-projects-issues
added
the
status: waiting-for-triage
Member
|
Why do you want the keys to be configurable? What would configuring them allow you to do that currently isn't possible or isn't as concise as you'd like? |
wilkinsona
added
the
status: waiting-for-feedback
Author
|
Some ecosystems use Allowing the keys to be configurable (as supported in Micrometer Tracing) allows users to use the same names already in use in those ecosystems. This helps when enabling tracing in Spring Boot apps where a naming pattern has already been established. |
spring-projects-issues
added
status: feedback-provided
wilkinsona
added
status: waiting-for-feedback
…tion Previously, clearing the MDCScopeDecorator builder to allow custom MDC key names for traceId and spanId also discarded any other default correlation fields configured by Brave. The builder is now cleared, the customized traceId and spanId fields are added, and any remaining default fields are re-added to restore the original behavior for non-customized fields. Signed-off-by: Phil Clay <philsttr@users.noreply.github.com>
philsttr
force-pushed
the
configurable_trace_mdc_keys
branch
from
f7c6462 to
8955e1f
Compare
…ustomization" This reverts commit 8955e1f. Signed-off-by: Phil Clay <philsttr@users.noreply.github.com>
Add a unit test to validate that MDCScopeDecorator.newBuilder() only has traceId and spanId fields configured by default. The mdcCorrelationScopeDecoratorBuilder method in BravePropagationConfigurations.PropagationWithBaggage clears the builder's defaults and re-adds only those two fields so their MDC key names can be customized. If Brave adds new default fields in the future, the .clear() call would silently drop them; this test will catch that. Signed-off-by: Phil Clay <philsttr@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Allow the user to configure the names of the MDC keys in which the trace id and span id are stored when using Micrometer Tracing. For example, to use
trace_id/span_idinstead oftraceId/spanIdIntroduce the following new properties:
management.tracing.mdc.trace-id-key(default:traceId)management.tracing.mdc.span-id-key(default:spanId)The default key names keep backwards compatibility with the previously hardcoded values.
Autoconfigurations for both the Brave and OpenTelemetry Micrometer Tracing bridges honor the new properties.