From 88f96d57f758b977c482494edda62cd008ec6cda Mon Sep 17 00:00:00 2001 From: Yang Song Date: Thu, 29 Feb 2024 10:05:54 -0500 Subject: [PATCH] [connector/datadog] Clean up feature gate (#31416) Move feature gate connector.datadogconnector.performance to stable stage and remove use of the feature gate. Also mark datadogconnector as no longer mutating trace data. --- .chloggen/datadogconnector-feature-gate.yaml | 27 ++++ .chloggen/datadogconnector-mutates-data.yaml | 27 ++++ connector/datadogconnector/connector.go | 14 +- .../datadogconnector/traces_connector.go | 13 +- exporter/datadogexporter/factory.go | 9 +- .../datadogexporter/integrationtest/go.mod | 4 +- .../integrationtest/integration_test.go | 138 +++++++----------- exporter/datadogexporter/metrics_exporter.go | 5 +- internal/datadog/agent.go | 6 +- 9 files changed, 122 insertions(+), 121 deletions(-) create mode 100644 .chloggen/datadogconnector-feature-gate.yaml create mode 100644 .chloggen/datadogconnector-mutates-data.yaml diff --git a/.chloggen/datadogconnector-feature-gate.yaml b/.chloggen/datadogconnector-feature-gate.yaml new file mode 100644 index 000000000000..aa7c6165d4dd --- /dev/null +++ b/.chloggen/datadogconnector-feature-gate.yaml @@ -0,0 +1,27 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: breaking + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: datadogconnector + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: "Move feature gate `connector.datadogconnector.performance` to stable stage." + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [31414] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: "`connector.datadogconnector.performance` will be removed in the next release" + +# If your change doesn't affect end users or the exported elements of any package, +# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. +# Optional: The change log or logs in which this entry should be included. +# e.g. '[user]' or '[user, api]' +# Include 'user' if the change is relevant to end users. +# Include 'api' if there is a change to a library API. +# Default: '[user]' +change_logs: [] diff --git a/.chloggen/datadogconnector-mutates-data.yaml b/.chloggen/datadogconnector-mutates-data.yaml new file mode 100644 index 000000000000..40a19ead22f4 --- /dev/null +++ b/.chloggen/datadogconnector-mutates-data.yaml @@ -0,0 +1,27 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: enhancement + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: datadogconnector + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: datadogconnector no longer mutates the input traces in trace-to-trace pipelines. + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [31414] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: + +# If your change doesn't affect end users or the exported elements of any package, +# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. +# Optional: The change log or logs in which this entry should be included. +# e.g. '[user]' or '[user, api]' +# Include 'user' if the change is relevant to end users. +# Include 'api' if there is a change to a library API. +# Default: '[user]' +change_logs: [] diff --git a/connector/datadogconnector/connector.go b/connector/datadogconnector/connector.go index 51df15427d6f..b24b0842d269 100644 --- a/connector/datadogconnector/connector.go +++ b/connector/datadogconnector/connector.go @@ -125,15 +125,11 @@ func (c *traceToMetricConnector) run() { } var mx pmetric.Metrics var err error - if datadog.ConnectorPerformanceFeatureGate.IsEnabled() { - c.logger.Debug("Received stats payload", zap.Any("stats", stats)) - mx, err = c.translator.StatsToMetrics(stats) - if err != nil { - c.logger.Error("Failed to convert stats to metrics", zap.Error(err)) - continue - } - } else { - mx = c.translator.StatsPayloadToMetrics(stats) + c.logger.Debug("Received stats payload", zap.Any("stats", stats)) + mx, err = c.translator.StatsToMetrics(stats) + if err != nil { + c.logger.Error("Failed to convert stats to metrics", zap.Error(err)) + continue } // APM stats as metrics ctx := context.TODO() diff --git a/connector/datadogconnector/traces_connector.go b/connector/datadogconnector/traces_connector.go index dfa32f7b94b2..34e57eb65d20 100644 --- a/connector/datadogconnector/traces_connector.go +++ b/connector/datadogconnector/traces_connector.go @@ -12,10 +12,6 @@ import ( "go.uber.org/zap" ) -// keyStatsComputed specifies the resource attribute key which indicates if stats have been -// computed for the resource spans. -const keyStatsComputed = "_dd.stats_computed" - type traceToTraceConnector struct { logger *zap.Logger tracesConsumer consumer.Traces // the next component in the pipeline to ingest traces after connector @@ -42,17 +38,10 @@ func (c *traceToTraceConnector) Shutdown(_ context.Context) error { // Capabilities implements the consumer interface. // tells use whether the component(connector) will mutate the data passed into it. if set to true the connector does modify the data func (c *traceToTraceConnector) Capabilities() consumer.Capabilities { - return consumer.Capabilities{MutatesData: true} // ConsumeTraces puts a new attribute _dd.stats_computed + return consumer.Capabilities{MutatesData: false} } // ConsumeTraces implements the consumer interface. func (c *traceToTraceConnector) ConsumeTraces(ctx context.Context, traces ptrace.Traces) error { - for i := 0; i < traces.ResourceSpans().Len(); i++ { - rs := traces.ResourceSpans().At(i) - // Stats will be computed for p. Mark the original resource spans to ensure that they don't - // get computed twice in case these spans pass through here again. - rs.Resource().Attributes().PutBool(keyStatsComputed, true) - - } return c.tracesConsumer.ConsumeTraces(ctx, traces) } diff --git a/exporter/datadogexporter/factory.go b/exporter/datadogexporter/factory.go index e64d96b896c0..3bd2916f0f9b 100644 --- a/exporter/datadogexporter/factory.go +++ b/exporter/datadogexporter/factory.go @@ -297,12 +297,9 @@ func (f *factory) createMetricsExporter( set.Logger.Debug("Starting Datadog Trace-Agent StatsWriter") go statsWriter.Run() - var statsIn chan []byte - if datadog.ConnectorPerformanceFeatureGate.IsEnabled() { - statsIn = make(chan []byte, 1000) - statsv := set.BuildInfo.Command + set.BuildInfo.Version - f.consumeStatsPayload(ctx, statsIn, statsToAgent, statsv, acfg.AgentVersion, set.Logger) - } + statsIn := make(chan []byte, 1000) + statsv := set.BuildInfo.Command + set.BuildInfo.Version + f.consumeStatsPayload(ctx, statsIn, statsToAgent, statsv, acfg.AgentVersion, set.Logger) pcfg := newMetadataConfigfromConfig(cfg) metadataReporter, err := f.Reporter(set, pcfg) if err != nil { diff --git a/exporter/datadogexporter/integrationtest/go.mod b/exporter/datadogexporter/integrationtest/go.mod index 168bd7dc2ad0..181fac0b7a3f 100644 --- a/exporter/datadogexporter/integrationtest/go.mod +++ b/exporter/datadogexporter/integrationtest/go.mod @@ -6,7 +6,6 @@ require ( github.com/DataDog/datadog-agent/pkg/proto v0.52.0-devel github.com/open-telemetry/opentelemetry-collector-contrib/connector/datadogconnector v0.95.0 github.com/open-telemetry/opentelemetry-collector-contrib/exporter/datadogexporter v0.95.0 - github.com/open-telemetry/opentelemetry-collector-contrib/internal/datadog v0.95.0 github.com/open-telemetry/opentelemetry-collector-contrib/processor/tailsamplingprocessor v0.95.0 github.com/stretchr/testify v1.8.4 github.com/tinylib/msgp v1.1.9 @@ -16,7 +15,6 @@ require ( go.opentelemetry.io/collector/connector v0.95.0 go.opentelemetry.io/collector/exporter v0.95.0 go.opentelemetry.io/collector/exporter/debugexporter v0.95.0 - go.opentelemetry.io/collector/featuregate v1.2.0 go.opentelemetry.io/collector/otelcol v0.95.0 go.opentelemetry.io/collector/processor v0.95.0 go.opentelemetry.io/collector/processor/batchprocessor v0.95.0 @@ -113,6 +111,7 @@ require ( github.com/open-telemetry/opentelemetry-collector-contrib/internal/aws/ecsutil v0.95.0 // indirect github.com/open-telemetry/opentelemetry-collector-contrib/internal/common v0.95.0 // indirect github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal v0.95.0 // indirect + github.com/open-telemetry/opentelemetry-collector-contrib/internal/datadog v0.95.0 // indirect github.com/open-telemetry/opentelemetry-collector-contrib/internal/filter v0.95.0 // indirect github.com/open-telemetry/opentelemetry-collector-contrib/internal/k8sconfig v0.95.0 // indirect github.com/open-telemetry/opentelemetry-collector-contrib/internal/metadataproviders v0.95.0 // indirect @@ -161,6 +160,7 @@ require ( go.opentelemetry.io/collector/consumer v0.95.0 // indirect go.opentelemetry.io/collector/extension v0.95.0 // indirect go.opentelemetry.io/collector/extension/auth v0.95.0 // indirect + go.opentelemetry.io/collector/featuregate v1.2.0 // indirect go.opentelemetry.io/collector/pdata v1.2.0 // indirect go.opentelemetry.io/collector/semconv v0.95.0 // indirect go.opentelemetry.io/collector/service v0.95.0 // indirect diff --git a/exporter/datadogexporter/integrationtest/integration_test.go b/exporter/datadogexporter/integrationtest/integration_test.go index eb96e604790b..45e87a66cea1 100644 --- a/exporter/datadogexporter/integrationtest/integration_test.go +++ b/exporter/datadogexporter/integrationtest/integration_test.go @@ -24,7 +24,6 @@ import ( "go.opentelemetry.io/collector/connector" "go.opentelemetry.io/collector/exporter" "go.opentelemetry.io/collector/exporter/debugexporter" - "go.opentelemetry.io/collector/featuregate" "go.opentelemetry.io/collector/otelcol" "go.opentelemetry.io/collector/otelcol/otelcoltest" "go.opentelemetry.io/collector/processor" @@ -42,103 +41,72 @@ import ( "github.com/open-telemetry/opentelemetry-collector-contrib/connector/datadogconnector" "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/datadogexporter" "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/datadogexporter/internal/testutil" - "github.com/open-telemetry/opentelemetry-collector-contrib/internal/datadog" "github.com/open-telemetry/opentelemetry-collector-contrib/processor/tailsamplingprocessor" ) func TestIntegration(t *testing.T) { - tests := []struct { - name string - featureGateEnabled bool - }{ - { - name: "with feature gate enabled", - featureGateEnabled: true, - }, - { - name: "with feature gate disabled", - featureGateEnabled: false, - }, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - // 1. Set up mock Datadog server - // See also https://github.com/DataDog/datadog-agent/blob/49c16e0d4deab396626238fa1d572b684475a53f/cmd/trace-agent/test/backend.go - apmstatsRec := &testutil.HTTPRequestRecorderWithChan{Pattern: testutil.APMStatsEndpoint, ReqChan: make(chan []byte)} - tracesRec := &testutil.HTTPRequestRecorderWithChan{Pattern: testutil.TraceEndpoint, ReqChan: make(chan []byte)} - server := testutil.DatadogServerMock(apmstatsRec.HandlerFunc, tracesRec.HandlerFunc) - defer server.Close() + // 1. Set up mock Datadog server + // See also https://github.com/DataDog/datadog-agent/blob/49c16e0d4deab396626238fa1d572b684475a53f/cmd/trace-agent/test/backend.go + apmstatsRec := &testutil.HTTPRequestRecorderWithChan{Pattern: testutil.APMStatsEndpoint, ReqChan: make(chan []byte)} + tracesRec := &testutil.HTTPRequestRecorderWithChan{Pattern: testutil.TraceEndpoint, ReqChan: make(chan []byte)} + server := testutil.DatadogServerMock(apmstatsRec.HandlerFunc, tracesRec.HandlerFunc) + defer server.Close() - // 2. Start in-process collector - factories := getIntegrationTestComponents(t) - app, confFilePath := getIntegrationTestCollector(t, server.URL, factories) - if tt.featureGateEnabled { - err := featuregate.GlobalRegistry().Set(datadog.ConnectorPerformanceFeatureGate.ID(), true) - assert.NoError(t, err) - defer func() { - _ = featuregate.GlobalRegistry().Set(datadog.ConnectorPerformanceFeatureGate.ID(), false) - }() - } - go func() { - assert.NoError(t, app.Run(context.Background())) - }() - defer app.Shutdown() - defer os.Remove(confFilePath) - waitForReadiness(app) + // 2. Start in-process collector + factories := getIntegrationTestComponents(t) + app, confFilePath := getIntegrationTestCollector(t, server.URL, factories) + go func() { + assert.NoError(t, app.Run(context.Background())) + }() + defer app.Shutdown() + defer os.Remove(confFilePath) + waitForReadiness(app) - // 3. Generate and send traces - sendTraces(t) + // 3. Generate and send traces + sendTraces(t) - // 4. Validate traces and APM stats from the mock server - var spans []*pb.Span - var stats []*pb.ClientGroupedStats + // 4. Validate traces and APM stats from the mock server + var spans []*pb.Span + var stats []*pb.ClientGroupedStats - // 5 sampled spans + APM stats on 10 spans are sent to datadog exporter - for len(spans) < 5 || len(stats) < 10 { - select { - case tracesBytes := <-tracesRec.ReqChan: - gz := getGzipReader(t, tracesBytes) - slurp, err := io.ReadAll(gz) - require.NoError(t, err) - var traces pb.AgentPayload - require.NoError(t, proto.Unmarshal(slurp, &traces)) - for _, tps := range traces.TracerPayloads { - for _, chunks := range tps.Chunks { - spans = append(spans, chunks.Spans...) - for _, span := range chunks.Spans { - assert.Equal(t, "true", span.Meta["_dd.stats_computed"]) - } - } - } + // 5 sampled spans + APM stats on 10 spans are sent to datadog exporter + for len(spans) < 5 || len(stats) < 10 { + select { + case tracesBytes := <-tracesRec.ReqChan: + gz := getGzipReader(t, tracesBytes) + slurp, err := io.ReadAll(gz) + require.NoError(t, err) + var traces pb.AgentPayload + require.NoError(t, proto.Unmarshal(slurp, &traces)) + for _, tps := range traces.TracerPayloads { + for _, chunks := range tps.Chunks { + spans = append(spans, chunks.Spans...) + } + } - case apmstatsBytes := <-apmstatsRec.ReqChan: - gz := getGzipReader(t, apmstatsBytes) - var spl pb.StatsPayload - require.NoError(t, msgp.Decode(gz, &spl)) - for _, csps := range spl.Stats { - assert.Equal(t, "datadogexporter-otelcol-tests", spl.AgentVersion) - for _, csbs := range csps.Stats { - stats = append(stats, csbs.Stats...) - for _, stat := range csbs.Stats { - assert.True(t, strings.HasPrefix(stat.Resource, "TestSpan")) - assert.Equal(t, uint64(1), stat.Hits) - assert.Equal(t, uint64(1), stat.TopLevelHits) - if tt.featureGateEnabled { - // Peer tags aggregation is supported only when the feature gate is enabled (it's enabled by default) - assert.Equal(t, "client", stat.SpanKind) - assert.Equal(t, []string{"extra_peer_tag:tag_val", "peer.service:svc"}, stat.PeerTags) - } - } - } + case apmstatsBytes := <-apmstatsRec.ReqChan: + gz := getGzipReader(t, apmstatsBytes) + var spl pb.StatsPayload + require.NoError(t, msgp.Decode(gz, &spl)) + for _, csps := range spl.Stats { + assert.Equal(t, "datadogexporter-otelcol-tests", spl.AgentVersion) + for _, csbs := range csps.Stats { + stats = append(stats, csbs.Stats...) + for _, stat := range csbs.Stats { + assert.True(t, strings.HasPrefix(stat.Resource, "TestSpan")) + assert.Equal(t, uint64(1), stat.Hits) + assert.Equal(t, uint64(1), stat.TopLevelHits) + assert.Equal(t, "client", stat.SpanKind) + assert.Equal(t, []string{"extra_peer_tag:tag_val", "peer.service:svc"}, stat.PeerTags) } } } - - // Verify we don't receive more than the expected numbers - assert.Len(t, spans, 5) - assert.Len(t, stats, 10) - }) + } } + + // Verify we don't receive more than the expected numbers + assert.Len(t, spans, 5) + assert.Len(t, stats, 10) } func getIntegrationTestComponents(t *testing.T) otelcol.Factories { diff --git a/exporter/datadogexporter/metrics_exporter.go b/exporter/datadogexporter/metrics_exporter.go index 9835d52e1997..332bffd9ed14 100644 --- a/exporter/datadogexporter/metrics_exporter.go +++ b/exporter/datadogexporter/metrics_exporter.go @@ -31,7 +31,6 @@ import ( "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/datadogexporter/internal/metrics" "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/datadogexporter/internal/metrics/sketches" "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/datadogexporter/internal/scrub" - "github.com/open-telemetry/opentelemetry-collector-contrib/internal/datadog" ) type metricsExporter struct { @@ -86,9 +85,7 @@ func translatorFromConfig(set component.TelemetrySettings, cfg *Config, attrsTra options = append(options, otlpmetrics.WithInitialCumulMonoValueMode( otlpmetrics.InitialCumulMonoValueMode(cfg.Metrics.SumConfig.InitialCumulativeMonotonicMode))) - if datadog.ConnectorPerformanceFeatureGate.IsEnabled() { - options = append(options, otlpmetrics.WithStatsOut(statsOut)) - } + options = append(options, otlpmetrics.WithStatsOut(statsOut)) return otlpmetrics.NewTranslator(set, attrsTranslator, options...) } diff --git a/internal/datadog/agent.go b/internal/datadog/agent.go index b9c80029265c..ab715d65edd4 100644 --- a/internal/datadog/agent.go +++ b/internal/datadog/agent.go @@ -36,11 +36,11 @@ type TraceAgent struct { exit chan struct{} } -// ConnectorPerformanceFeatureGate uses optimized code paths for the Datadog Connector. -var ConnectorPerformanceFeatureGate = featuregate.GlobalRegistry().MustRegister( +var _ = featuregate.GlobalRegistry().MustRegister( "connector.datadogconnector.performance", - featuregate.StageBeta, + featuregate.StageStable, featuregate.WithRegisterDescription("Datadog Connector will use optimized code"), + featuregate.WithRegisterToVersion("0.97.0"), ) // newAgent creates a new unstarted traceagent using the given context. Call Start to start the traceagent.