From 12790ef7811fabf8c38ab5eda271c0d1bbba8694 Mon Sep 17 00:00:00 2001 From: sh0rez Date: Tue, 24 Sep 2024 09:36:56 +0200 Subject: [PATCH] [processor/deltatocumulative]: do not drop Gauge, Summary (#35372) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description:** As an oversight, https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/33286 not only started dropping metrics without datapoints, but also all Gauges and Summaries. This change correctly passes those types through unaltered. **Link to tracking Issue:** Fixes #35284 **Testing:** `TestIgnore` was added _before_ fixing. It fails on current main, passes after this change **Documentation:** not needed --------- Co-authored-by: Juraci Paixão Kröhling --- .chloggen/deltatocumulative-fix-drops.yaml | 29 +++++++++++++++++++ processor/deltatocumulativeprocessor/go.mod | 1 + .../deltatocumulativeprocessor/processor.go | 5 ++++ .../processor_test.go | 26 +++++++++++++++++ .../testdata/notemporality-ignored/in.yaml | 27 +++++++++++++++++ .../testdata/notemporality-ignored/out.yaml | 27 +++++++++++++++++ 6 files changed, 115 insertions(+) create mode 100644 .chloggen/deltatocumulative-fix-drops.yaml create mode 100644 processor/deltatocumulativeprocessor/testdata/notemporality-ignored/in.yaml create mode 100644 processor/deltatocumulativeprocessor/testdata/notemporality-ignored/out.yaml diff --git a/.chloggen/deltatocumulative-fix-drops.yaml b/.chloggen/deltatocumulative-fix-drops.yaml new file mode 100644 index 000000000000..9045a7c331a7 --- /dev/null +++ b/.chloggen/deltatocumulative-fix-drops.yaml @@ -0,0 +1,29 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: bug_fix + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: deltatocumulative + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: do not drop gauges and summaries + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [35284] + +# (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: | + Gauges and Summaries are no longer dropped from processor output. + Instead, they are passed through as-is + +# 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: [user] diff --git a/processor/deltatocumulativeprocessor/go.mod b/processor/deltatocumulativeprocessor/go.mod index 24ec443293ed..7886d8139ef0 100644 --- a/processor/deltatocumulativeprocessor/go.mod +++ b/processor/deltatocumulativeprocessor/go.mod @@ -5,6 +5,7 @@ go 1.22.0 require ( github.com/google/go-cmp v0.6.0 github.com/open-telemetry/opentelemetry-collector-contrib/internal/exp/metrics v0.109.0 + github.com/open-telemetry/opentelemetry-collector-contrib/pkg/golden v0.109.0 github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatatest v0.109.0 github.com/stretchr/testify v1.9.0 go.opentelemetry.io/collector/component v0.110.0 diff --git a/processor/deltatocumulativeprocessor/processor.go b/processor/deltatocumulativeprocessor/processor.go index e0448b350c32..219f657df964 100644 --- a/processor/deltatocumulativeprocessor/processor.go +++ b/processor/deltatocumulativeprocessor/processor.go @@ -138,7 +138,10 @@ func (p *Processor) ConsumeMetrics(ctx context.Context, md pmetric.Metrics) erro var errs error metrics.Filter(md, func(m metrics.Metric) bool { var n int + //exhaustive:enforce switch m.Type() { + case pmetric.MetricTypeGauge: + n = m.Gauge().DataPoints().Len() case pmetric.MetricTypeSum: sum := m.Sum() if sum.AggregationTemporality() == pmetric.AggregationTemporalityDelta { @@ -163,6 +166,8 @@ func (p *Processor) ConsumeMetrics(ctx context.Context, md pmetric.Metrics) erro expo.SetAggregationTemporality(pmetric.AggregationTemporalityCumulative) } n = expo.DataPoints().Len() + case pmetric.MetricTypeSummary: + n = m.Summary().DataPoints().Len() } return n > 0 }) diff --git a/processor/deltatocumulativeprocessor/processor_test.go b/processor/deltatocumulativeprocessor/processor_test.go index 9b95e615fea5..a25c95eb9f67 100644 --- a/processor/deltatocumulativeprocessor/processor_test.go +++ b/processor/deltatocumulativeprocessor/processor_test.go @@ -7,6 +7,7 @@ import ( "context" "math" "math/rand" + "path/filepath" "strconv" "testing" "time" @@ -20,6 +21,7 @@ import ( "go.opentelemetry.io/collector/processor/processortest" "github.com/open-telemetry/opentelemetry-collector-contrib/internal/exp/metrics/identity" + "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/golden" self "github.com/open-telemetry/opentelemetry-collector-contrib/processor/deltatocumulativeprocessor" "github.com/open-telemetry/opentelemetry-collector-contrib/processor/deltatocumulativeprocessor/internal/data" "github.com/open-telemetry/opentelemetry-collector-contrib/processor/deltatocumulativeprocessor/internal/data/datatest/compare" @@ -282,3 +284,27 @@ func stream() SumBuilder { _, base := sum.Stream() return SumBuilder{Metric: sum, base: base} } + +func TestIgnore(t *testing.T) { + proc, sink := setup(t, nil) + + dir := "./testdata/notemporality-ignored" + open := func(file string) pmetric.Metrics { + t.Helper() + md, err := golden.ReadMetrics(filepath.Join(dir, file)) + require.NoError(t, err) + return md + } + + in := open("in.yaml") + out := open("out.yaml") + + ctx := context.Background() + + err := proc.ConsumeMetrics(ctx, in) + require.NoError(t, err) + + if diff := compare.Diff([]pmetric.Metrics{out}, sink.AllMetrics()); diff != "" { + t.Fatal(diff) + } +} diff --git a/processor/deltatocumulativeprocessor/testdata/notemporality-ignored/in.yaml b/processor/deltatocumulativeprocessor/testdata/notemporality-ignored/in.yaml new file mode 100644 index 000000000000..095de3947de0 --- /dev/null +++ b/processor/deltatocumulativeprocessor/testdata/notemporality-ignored/in.yaml @@ -0,0 +1,27 @@ +resourceMetrics: + - schemaUrl: https://test.com/resource + resource: + attributes: + - key: resattr + value: { stringValue: stringoo } + scopeMetrics: + - schemaUrl: https://test.com/scope + scope: + name: Test + version: 1.2.3 + attributes: + - key: scopeattr + value: { stringValue: string } + metrics: + - name: test.gauge + gauge: + dataPoints: + - timeUnixNano: 1 + asDouble: 1 + - name: test.summary + summary: + dataPoints: + - timeUnixNano: 1 + quantileValues: + - quantile: 0.25 + value: 25 diff --git a/processor/deltatocumulativeprocessor/testdata/notemporality-ignored/out.yaml b/processor/deltatocumulativeprocessor/testdata/notemporality-ignored/out.yaml new file mode 100644 index 000000000000..095de3947de0 --- /dev/null +++ b/processor/deltatocumulativeprocessor/testdata/notemporality-ignored/out.yaml @@ -0,0 +1,27 @@ +resourceMetrics: + - schemaUrl: https://test.com/resource + resource: + attributes: + - key: resattr + value: { stringValue: stringoo } + scopeMetrics: + - schemaUrl: https://test.com/scope + scope: + name: Test + version: 1.2.3 + attributes: + - key: scopeattr + value: { stringValue: string } + metrics: + - name: test.gauge + gauge: + dataPoints: + - timeUnixNano: 1 + asDouble: 1 + - name: test.summary + summary: + dataPoints: + - timeUnixNano: 1 + quantileValues: + - quantile: 0.25 + value: 25