Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecation notice for B3 propagation configuration #2454

Merged
merged 1 commit into from
Dec 2, 2022

Conversation

marcotc
Copy link
Member

@marcotc marcotc commented Dec 2, 2022

This PR renames the configuration options for the distributed tracing propagation styles B3 and B3 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 becomes b3multi, as is represent B3 over multiple headers. B3 remains a valid, but deprecated alias.
  • B3 single header becomes b3. This does not conflict with B3 as this configuration is case sensitive. B3 single header remains a valid, but deprecated alias.
  • DD_PROPAGATION_STYLE_INJECT becomes DD_TRACE_PROPAGATION_STYLE_INJECT. DD_PROPAGATION_STYLE_INJECT remains as a valid, but deprecated alias.
  • DD_PROPAGATION_STYLE_EXTRACT becomes DD_TRACE_PROPAGATION_STYLE_EXTRACT. DD_PROPAGATION_STYLE_EXTRACT remains as a valid, but deprecated alias.

One more thing

I introduced a formal deprecation logger:

Datadog::Core.log_deprecation { "This is not good anymore. Do this better thing instead." }

By default, it logs to Datadog.logger.warn.

I also created a simple way to assert it:

include_examples 'records deprecated action', 'This is not good'

@marcotc marcotc self-assigned this Dec 2, 2022
@marcotc marcotc requested a review from a team December 2, 2022 01:07
@github-actions github-actions bot added core Involves Datadog core libraries integrations Involves tracing integrations tracing labels Dec 2, 2022
Base automatically changed from w3c-trace-context to master December 2, 2022 22:06
@marcotc marcotc merged commit c213f61 into master Dec 2, 2022
@marcotc marcotc deleted the b3-deprecation-warning branch December 2, 2022 22:07
@github-actions github-actions bot added this to the 1.8.0 milestone Dec 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Involves Datadog core libraries integrations Involves tracing integrations tracing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants