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

Remove unused headers: X-B3-ParentSpanId and X-OrigSpanId #778

Merged
merged 2 commits into from
Sep 16, 2021

Conversation

carterkozak
Copy link
Contributor

X-B3-ParentSpanId isn't standard zipkin, and doesn't provide
any data we don't already have. The parent span of an incoming
request span is the value of the X-B3-SpanId header. There's
no reason for additional header values.

X-OrigSpanId is a custom header added to provide some amount of
tracing functionality when traces aren't sampled, however it
hasn't quite worked and isn't supported by alternative tracing
engines.

==COMMIT_MSG==
Remove unused headers: X-B3-ParentSpanId and X-OrigSpanId
==COMMIT_MSG==

`X-B3-ParentSpanId` isn't standard zipkin, and doesn't provide
any data we don't already have. The parent span of an incoming
request span is the value of the `X-B3-SpanId` header. There's
no reason for additional header values.

`X-OrigSpanId` is a custom header added to provide some amount of
tracing functionality when traces aren't sampled, however it
hasn't quite worked and isn't supported by alternative tracing
engines.
@changelog-app
Copy link

changelog-app bot commented Sep 15, 2021

Generate changelog in changelog/@unreleased

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Remove unused headers: X-B3-ParentSpanId and X-OrigSpanId

Check the box to generate changelog(s)

  • Generate changelog entry

@policy-bot policy-bot bot requested a review from tetigi September 15, 2021 15:23
@carterkozak
Copy link
Contributor Author

carterkozak commented Sep 15, 2021

@CRogers This PR should reduce some of the cruft discussed on palantir/witchcraft-java-logging#46 :-)

*
* @deprecated Use the variant without an originating span id
*/
@SuppressWarnings("InlineMeSuggester")

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's this magic?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error prone has an inlineme annotation to document replacements on undesirable call sites. We don’t want to automate this migration because there’s potentially other data that can be removed.

@bulldozer-bot bulldozer-bot bot merged commit 93b9295 into develop Sep 16, 2021
@bulldozer-bot bulldozer-bot bot deleted the ckozak/unused_headers branch September 16, 2021 11:05
@svc-autorelease
Copy link
Collaborator

Released 6.4.0

@sfackler
Copy link
Member

sfackler commented Sep 16, 2021

X-B3-ParentSpanId is absolutely a part of standard zipkin but it's only used in an older style of propagation, where the server doesn't make a new span but rather "joins" onto the span the client created.

https://github.com/openzipkin/b3-propagation#parentspanid

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants