pkg/trace/api: add support for OpenTelemetry Span Links. #15767
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
estherk15
reviewed
Feb 24, 2023
releasenotes/notes/apm-span-links-support-78478b81bf08e26f.yaml
Outdated
Show resolved
Hide resolved
estherk15
approved these changes
Feb 24, 2023
dinooliva
changed the title
dineshg13
reviewed
Feb 27, 2023
songy23
reviewed
Mar 1, 2023
….span_links' based on revised rfc.
|
As requested by @dineshg13 , attaching a screenshot of the span link encoding from a test case.
|
gbbr
changed the title
gbbr
reviewed
Mar 6, 2023
…oding hex-encoded strings. Additionally, update variable declarations to be idiomatic Go.
…n decoding hex-encoded strings.
…st all combinations of optional fields.
gbbr
approved these changes
Mar 7, 2023
pkg/trace/api/otlp_test.go
Outdated
| @@ -1274,6 +1397,138 @@ func trimSpaces(str string) string { | |||
| return out.String() | |||
| } | |||
|
|
|||
| func makeSpanLinkSlice(traceId, spanId, traceState string, attrs map[string]string, dropped uint32) ptrace.SpanLinkSlice { | |||
There was a problem hiding this comment.
nit: I usually think it's a good practice to test helper functions too. If it's a test helper, it doesn't mean it is reliable to work correctly 🙂
There was a problem hiding this comment.
I was on the fence about this one since, if there were any problems with it, then TestMarshalSpanLinks would likely fail but it certainly doesn't hurt to add some basic testing.
Done.
mackjmr
added a commit
to mackjmr/opentelemetry-collector-contrib
that referenced
this pull request
Mar 23, 2023
…to stable. This PR graduates feature gate `exporter.datadog.hostname.preview` to Stable. This is a follow up to [PR1](DataDog/opentelemetry-mapping-go#21) and [PR2](DataDog/datadog-agent#16159). **Note:** This PR pins a pseudoversion of `github.com/DataDog/datadog-agent/pkg/trace` in order to use take advantage of changes ([commit](DataDog/datadog-agent@8b27e87)) done in preparation of this PR. This pseudoversion also contains a change to add support for span links ([PR](DataDog/datadog-agent#15767)), which has been added to the changelog.
mx-psi
added a commit
to open-telemetry/opentelemetry-collector-contrib
that referenced
this pull request
Mar 23, 2023
…to stable. (#20286) * exporter/datadogexporter: Graduate exporter.datadog.hostname.preview to stable. This PR graduates feature gate `exporter.datadog.hostname.preview` to Stable. This is a follow up to [PR1](DataDog/opentelemetry-mapping-go#21) and [PR2](DataDog/datadog-agent#16159). **Note:** This PR pins a pseudoversion of `github.com/DataDog/datadog-agent/pkg/trace` in order to use take advantage of changes ([commit](DataDog/datadog-agent@8b27e87)) done in preparation of this PR. This pseudoversion also contains a change to add support for span links ([PR](DataDog/datadog-agent#15767)), which has been added to the changelog. * add PR # to changelog * run make gotidy * Update .chloggen/datadog-exporter-span-links-support.yaml Co-authored-by: Pablo Baeyens <[email protected]> --------- Co-authored-by: Pablo Baeyens <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
Adds support for OpenTelemetry span links to the Trace Agent.
During the conversion from OTLP to the Datadog trace protobuf, any span with span links will have the span links added to the metadata with the key '_dd.span_links'.
Motivation
This change is part of an ongoing effort to support OpenTelemetry Span Links at Datadog.
Additional Notes
Span links will be JSON encoded as:
{ "trace_id":
trace_id, "span_id":span_id[,"trace_state":trace_state][,"attributes":{ (
key:value)+ }] [,"dropped_attributes_count":uint64] }where
trace_id&span_idare hex-encoded unsigned ints,trace_stateis the W3C TraceState encoding as a string, andkey&valueare arbitrary strings.Note that "trace_state", "attributes", and "dropped_attributes_count" are optional and will only be present if they contain non-empty/non-zero values.
Possible Drawbacks / Trade-offs
This change only affects the OTel path and only for spans that contain span links so it will only impact a small percentage of spans. The main possible drawback will be the added processing overhead (converting span links to JSON) and the added metadata.
Describe how to test/QA your changes
Send a span with span links from an OpenTelemetry service and check the resulting converted span has the links in the metadata.
Reviewer's Checklist
Triagemilestone is set.major_changelabel if your change either has a major impact on the code base, is impacting multiple teams or is changing important well-established internals of the Agent. This label will be use during QA to make sure each team pay extra attention to the changed behavior. For any customer facing change use a releasenote.changelog/no-changeloglabel has been applied.qa/skip-qalabel is not applied.team/..label has been applied, indicating the team(s) that should QA this change.need-change/operatorandneed-change/helmlabels have been applied.k8s/<min-version>label, indicating the lowest Kubernetes version compatible with this feature.