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

Clarify usage of Distributed Tracing Extension by OpenTelemetry #1

Merged
merged 5 commits into from Nov 19, 2021

Conversation

joaopgrassi
Copy link
Member

@joaopgrassi joaopgrassi commented Nov 17, 2021

From the last messaging workgroup meeting, it was pointed out that now that we are close to merge the CloudEvents Semantic Conventions PR, we should make it clear in the CloudEvents spec that the Distributed Tracing Extension is used by OTel.

The reason for this "linking" between specs is that the extension caused confusion in the past and was even asked to be removed: cloudevents#751. Basically the idea is that OpenTelemetry "claims" this extension and by providing the semantic conventions, its usage becomes more clear.

Here is the recording of the meeting where this subject came up: https://youtu.be/gjz3Fz_hz_8?t=937

So, in this PR I intended to:

  • Remove instructions and extra clarifications on how this is used - It's now in the semantic conventions
  • Clear some wording (context, propagation, distributed tracing) by using the text from the OpenTelemetry specification. (For the case people aren't aware of OpenTelemetry nor heard these terms before)
  • Add link to the semantic conventions document where users will find out how to use it

Copy link
Member

@pirgeo pirgeo left a comment

Choose a reason for hiding this comment

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

Looking good to me. I guess this will only be merged after the spec PR, right? the link is currently dead because the cloudevents.md is not yet merged.

extensions/distributed-tracing.md Show resolved Hide resolved
extensions/distributed-tracing.md Outdated Show resolved Hide resolved
extensions/distributed-tracing.md Outdated Show resolved Hide resolved
extensions/distributed-tracing.md Outdated Show resolved Hide resolved
extensions/distributed-tracing.md Outdated Show resolved Hide resolved
extensions/distributed-tracing.md Outdated Show resolved Hide resolved
Changed also the introduction a bit to "link" this extension with OTel more clearly.
extensions/distributed-tracing.md Show resolved Hide resolved
@joaopgrassi joaopgrassi changed the title Clarify usage of Distributed Tracing Extension Clarify usage of Distributed Tracing Extension by OpenTelemetry Nov 19, 2021
@joaopgrassi joaopgrassi merged commit 6c0c753 into otel_semconv_dte Nov 19, 2021
@joaopgrassi joaopgrassi deleted the otel_semconv_dte_review branch November 19, 2021 12:58
joaopgrassi added a commit that referenced this pull request Nov 19, 2021
Signed-off-by: Joao Grassi <joao.grassi@dynatrace.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants