Deprecation notice for B3 propagation configuration #2454
Merged
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.
This PR renames the configuration options for the distributed tracing propagation styles
B3
andB3 single header
to align with OpenTelemetry.The existing names will still be supported, but a deprecation warning will be issued.
There are no changes the propagation styles themselves, only configuration name changes.
A change to the environment variables used to configure propagation styles was also done, as to standardize them across other Datadog languages.
Changes
B3
becomesb3multi
, as is represent B3 over multiple headers.B3
remains a valid, but deprecated alias.B3 single header
becomesb3
. This does not conflict withB3
as this configuration is case sensitive.B3 single header
remains a valid, but deprecated alias.DD_PROPAGATION_STYLE_INJECT
becomesDD_TRACE_PROPAGATION_STYLE_INJECT
.DD_PROPAGATION_STYLE_INJECT
remains as a valid, but deprecated alias.DD_PROPAGATION_STYLE_EXTRACT
becomesDD_TRACE_PROPAGATION_STYLE_EXTRACT
.DD_PROPAGATION_STYLE_EXTRACT
remains as a valid, but deprecated alias.One more thing
I introduced a formal deprecation logger:
By default, it logs to
Datadog.logger.warn
.I also created a simple way to assert it: