Skip to content

Update compute_stats_by_span_kind documentation #23945

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 21, 2024
Merged

Update compute_stats_by_span_kind documentation #23945

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
020481b
Edit docs and release note with clarification
liustanley Mar 20, 2024
53e52aa
Update release note
liustanley Mar 20, 2024
3b821bf
Apply suggestions from code review
liustanley Mar 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pkg/config/config_template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1553,8 +1553,8 @@ api_key:
## @env DD_APM_COMPUTE_STATS_BY_SPAN_KIND - bool - default: false
## [BETA] Enables an additional stats computation check on spans to see they have an eligible `span.kind` (server, consumer, client, producer).
## If enabled, a span with an eligible `span.kind` will have stats computed. If disabled, only top-level and measured spans will have stats computed.
## NOTE: For stats computed from OTel traces, only top-level spans are considered when this option is off.
## If you are sending OTel traces and want stats on non-top-level spans, this flag will need to be enabled.
## NOTE: Stats are now computed by span kind for OTel traces by default.
## If you are sending OTel traces and do not want stats computed by span kind, this flag will need to be disabled and the "disable_otlp_compute_top_level_by_span_kind" APM Feature will need to be enabled.
# compute_stats_by_span_kind: false

## @param peer_service_aggregation - bool - default: false
Expand Down
1 change: 1 addition & 0 deletions releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ features:
OTLP ingest now identifies top-level spans by span kind for OpenTelemetry spans by default. This is both a breaking change and a bug fix that may increase the number of spans that generate trace metrics. This new logic can be disabled if needed by adding `disable_otlp_compute_top_level_by_span_kind` in DD_APM_FEATURES.
- With this new logic, root spans and spans with a server or consumer `span.kind` will be marked as top-level. Additionally, spans with a client or producer `span.kind` will have stats computed.
- If `disable_otlp_compute_top_level_by_span_kind` is enabled, this new logic will be disabled and OpenTelemetry spans may be misidentified as top-level.
- Please note that in order to disable computing stats by span kind for OTel traces, `disable_otlp_compute_top_level_by_span_kind` needs to be enabled and `apm_config.compute_stats_by_span_kind` needs to be disabled.