Convert OTel semantic convention to Datadog's #3273
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
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #3273 +/- ##
========================================
Coverage 98.22% 98.22%
========================================
Files 1253 1253
Lines 72290 72393 +103
Branches 3361 3393 +32
========================================
+ Hits 71009 71111 +102
- Misses 1281 1282 +1 ☔ View full report in Codecov by Sentry. |
TonyCTHsu
approved these changes
Nov 22, 2023
| # semantic convention for span kind and span attributes. | ||
| # @see https://opentelemetry.io/docs/specs/semconv/general/trace/ | ||
|
|
||
| # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity |
There was a problem hiding this comment.
Perhaps we could revisit this later to break this method into smaller pieces.
| kwargs[:service] = attributes['service.name'] if attributes.key?('service.name') | ||
| kwargs[:type] = attributes['span.type'] if attributes.key?('span.type') | ||
|
|
||
| attributes.reject! { |key, _| OpenTelemetry::Trace::Span::DATADOG_SPAN_ATTRIBUTE_OVERRIDES.include?(key) } | ||
|
|
||
| # DEV: There's no `flat_map!`; we have to split it into two operations |
There was a problem hiding this comment.
For later: Would it be possible to complete this with a single operation with reduce or each_with_object?
There was a problem hiding this comment.
This is an interesting line because I built it to support arbitrarily nested arrays, but that's actually not required for OTel, so I might simplify it later. But I wasn't able to in time for this PR.
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?
This PR parses the relevant OpenTelemetry semantic conventions for tracing and converts those values into appropriate Datadog APM values.
Most changes come from parsing OTel Span attributes to derive a Datadog Span operation name.
For example, from Semantic Conventions for Database Client Calls:
If an OTel span has the attribute
db.systemand the Span kind:client,then the respective Datadog Span will have the operation name
"#{otel_span.attributes['db.system']}.query".This PR also introduces a few reserved attributes that can be set on an OTel Span to modify a Datadog Span field, for example
resource.namecan be set to modify the Datadog Span's resource name.There are also a few fixes to attribute parsing, for cross-language consistency.
Motivation:
OpenTelemetry consistent, both with the OpenTelemetry semantic conventions and with other Datadog APM languages.
How to test the change?
There are unit test and system-tests for this change: DataDog/system-tests#1456
For Datadog employees:
credentials of any kind, I've requested a review from
@DataDog/security-design-and-guidance.Unsure? Have a question? Request a review!