docs: link distributed tracing extension to otel semconv #1304
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.
Replacement for #912
Proposed Changes
This follows the same idea/goal as #912 - Point to the OpenTelemetry CloudEvents semantic conventions to help people to understand how to use the extension and how a trace structure should look like in systems using CloudEvents.
I took a slight different approach with this PR where I left most of the existing text. We have now finalized the CloudEvents semconv in OTel. The group there decided to only mention the distributed tracing extension as an additional mechanism to propagate context, but the definition of it should stay here. OTel also doesn't document/specify other means of propagation in messaging systems for example, we rather only mention it. That's why we followed the same for CloudEvents.
The document now points to the CloudEvents OTel semconv which basically tells to follow the messaging semantic conventions.
Release Note
Note: The PR #912 is very old and I had many conflicts trying to rebase it. So I'm opening this new one. CC @duglin
Note 2: The link to the OTel website doesn't contain the last version of the CloudEvents semantic conventions. The version that will go live soon is here: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/cloudevents/cloudevents-spans.md