From 020481b193dc3f3c8c3f7845668d84d7f7751338 Mon Sep 17 00:00:00 2001 From: Stanley Liu Date: Wed, 20 Mar 2024 16:28:17 -0400 Subject: [PATCH 1/3] Edit docs and release note with clarification --- pkg/config/config_template.yaml | 4 ++-- releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/pkg/config/config_template.yaml b/pkg/config/config_template.yaml index 3fbeeb32f7bee9..c4f2322df4fcf6 100644 --- a/pkg/config/config_template.yaml +++ b/pkg/config/config_template.yaml @@ -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 diff --git a/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml b/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml index dbd10f75f9f6c9..11b4371e73ba36 100644 --- a/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml +++ b/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml @@ -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 if both `disable_otlp_compute_top_level_by_span_kind` and `apm_config.compute_stats_by_span_kind` are enabled, stats will still be computed by span kind for OTel traces. From 53e52aa7a17499f222dcd4fab80ed8aa4528dcd4 Mon Sep 17 00:00:00 2001 From: Stanley Liu Date: Wed, 20 Mar 2024 16:34:00 -0400 Subject: [PATCH 2/3] Update release note --- releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml b/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml index 11b4371e73ba36..d4a8f7c63ee4fd 100644 --- a/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml +++ b/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml @@ -11,4 +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 if both `disable_otlp_compute_top_level_by_span_kind` and `apm_config.compute_stats_by_span_kind` are enabled, stats will still be computed by span kind for OTel traces. + - 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. From 3b821bf7f694646cb974765869ccda0a94b3af93 Mon Sep 17 00:00:00 2001 From: Stanley Liu Date: Thu, 21 Mar 2024 10:44:28 -0400 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: May Lee --- pkg/config/config_template.yaml | 4 ++-- releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/config/config_template.yaml b/pkg/config/config_template.yaml index c4f2322df4fcf6..affd3a9b337749 100644 --- a/pkg/config/config_template.yaml +++ b/pkg/config/config_template.yaml @@ -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: 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. + ## NOTE: Stats are computed by span kind for OTel traces by default. + ## If you are sending OTel traces and do not want stats computed by span kind, you need to disable this flag and enable the "disable_otlp_compute_top_level_by_span_kind" APM feature. # compute_stats_by_span_kind: false ## @param peer_service_aggregation - bool - default: false diff --git a/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml b/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml index d4a8f7c63ee4fd..9c6741074f0211 100644 --- a/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml +++ b/releasenotes/notes/otel-top-level-spans-3e391e77dd7ebf83.yaml @@ -11,4 +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. + - To disable computing stats by span kind for OTel traces, enable `disable_otlp_compute_top_level_by_span_kind` and disable `apm_config.compute_stats_by_span_kind`.