Skip to content

Commit 146f1a6

Browse files
sincejunesfc-gh-sili
sincejune
authored and
sfc-gh-sili
committed
[chore] Replace AssertMetrics with AssertEqualMetric series functions (open-telemetry#12184)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description A follow-up PR of open-telemetry#12179 , cc @bogdandrutu Note: This PR also removes those metric assertions which is actually testing metrics that doesn't belong to the package. They might be added due to the limitation of the AssertMetrics function. e.g. changes in `processor/memorylimitprocessor/memorylimiter_test.go` <!-- Issue number if applicable --> #### Link to tracking issue Relevant to open-telemetry#12179 <!--Describe what testing was performed and which tests were added.--> #### Testing Updated <!--Describe the documentation added.--> #### Documentation n/a <!--Please delete paragraphs that you did not use before submitting.-->
1 parent cfe7564 commit 146f1a6

File tree

10 files changed

+340
-853
lines changed

10 files changed

+340
-853
lines changed

‎cmd/mdatagen/internal/samplereceiver/metrics_test.go

Lines changed: 11 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -30,39 +30,22 @@ func TestComponentTelemetry(t *testing.T) {
3030
factory := NewFactory()
3131
receiver, err := factory.CreateMetrics(context.Background(), tt.NewSettings(), componenttest.NewNopHost(), new(consumertest.MetricsSink))
3232
require.NoError(t, err)
33-
tt.AssertMetrics(t, []metricdata.Metrics{
34-
{
35-
Name: "otelcol_batch_size_trigger_send",
36-
Description: "Number of times the batch was sent due to a size trigger [deprecated since v0.110.0]",
37-
Unit: "{times}",
38-
Data: metricdata.Sum[int64]{
39-
Temporality: metricdata.CumulativeTemporality,
40-
IsMonotonic: true,
41-
DataPoints: []metricdata.DataPoint[int64]{
42-
{
43-
Value: 1,
44-
},
45-
},
33+
metadatatest.AssertEqualBatchSizeTriggerSend(t, tt.Telemetry,
34+
[]metricdata.DataPoint[int64]{
35+
{
36+
Value: 1,
4637
},
47-
},
48-
{
49-
Name: "otelcol_process_runtime_total_alloc_bytes",
50-
Description: "Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')",
51-
Unit: "By",
52-
Data: metricdata.Sum[int64]{
53-
Temporality: metricdata.CumulativeTemporality,
54-
IsMonotonic: true,
55-
DataPoints: []metricdata.DataPoint[int64]{
56-
{
57-
Value: 2,
58-
},
59-
},
38+
}, metricdatatest.IgnoreTimestamp())
39+
metadatatest.AssertEqualProcessRuntimeTotalAllocBytes(t, tt.Telemetry,
40+
[]metricdata.DataPoint[int64]{
41+
{
42+
Value: 2,
6043
},
61-
},
62-
}, metricdatatest.IgnoreTimestamp())
44+
}, metricdatatest.IgnoreTimestamp())
6345
rcv, ok := receiver.(nopReceiver)
6446
require.True(t, ok)
6547
rcv.initOptionalMetric()
48+
// TODO: this needs to be replaces once the optional metric is supported in AssertMetricEqual functions.
6649
tt.AssertMetrics(t, []metricdata.Metrics{
6750
{
6851
Name: "otelcol_batch_size_trigger_send",

‎processor/batchprocessor/batch_processor_test.go

Lines changed: 164 additions & 291 deletions
Large diffs are not rendered by default.

‎processor/memorylimiterprocessor/memorylimiter_test.go

Lines changed: 7 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -227,53 +227,14 @@ func TestMetricsTelemetry(t *testing.T) {
227227
}
228228
require.NoError(t, metrics.Shutdown(context.Background()))
229229

230-
tel.AssertMetrics(t, []metricdata.Metrics{
231-
{
232-
Name: "otelcol_processor_accepted_metric_points",
233-
Description: "Number of metric points successfully pushed into the next component in the pipeline. [deprecated since v0.110.0]",
234-
Unit: "{datapoints}",
235-
Data: metricdata.Sum[int64]{
236-
Temporality: metricdata.CumulativeTemporality,
237-
IsMonotonic: true,
238-
DataPoints: []metricdata.DataPoint[int64]{
239-
{
240-
Value: 10,
241-
Attributes: attribute.NewSet(attribute.String("processor", "memory_limiter")),
242-
},
243-
},
230+
metadatatest.AssertEqualProcessorAcceptedMetricPoints(t, tel.Telemetry,
231+
[]metricdata.DataPoint[int64]{
232+
{
233+
Value: 10,
234+
Attributes: attribute.NewSet(attribute.String("processor", "memory_limiter")),
244235
},
245-
},
246-
{
247-
Name: "otelcol_processor_incoming_items",
248-
Description: "Number of items passed to the processor. [alpha]",
249-
Unit: "{items}",
250-
Data: metricdata.Sum[int64]{
251-
Temporality: metricdata.CumulativeTemporality,
252-
IsMonotonic: true,
253-
DataPoints: []metricdata.DataPoint[int64]{
254-
{
255-
Value: 10,
256-
Attributes: attribute.NewSet(attribute.String("processor", "memory_limiter"), attribute.String("otel.signal", "metrics")),
257-
},
258-
},
259-
},
260-
},
261-
{
262-
Name: "otelcol_processor_outgoing_items",
263-
Description: "Number of items emitted from the processor. [alpha]",
264-
Unit: "{items}",
265-
Data: metricdata.Sum[int64]{
266-
Temporality: metricdata.CumulativeTemporality,
267-
IsMonotonic: true,
268-
DataPoints: []metricdata.DataPoint[int64]{
269-
{
270-
Value: 10,
271-
Attributes: attribute.NewSet(attribute.String("processor", "memory_limiter"), attribute.String("otel.signal", "metrics")),
272-
},
273-
},
274-
},
275-
},
276-
}, metricdatatest.IgnoreTimestamp())
236+
}, metricdatatest.IgnoreTimestamp())
237+
277238
require.NoError(t, tel.Shutdown(context.Background()))
278239
}
279240

‎processor/processorhelper/logs_test.go

Lines changed: 24 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -128,38 +128,20 @@ func TestLogs_RecordInOut(t *testing.T) {
128128
assert.NoError(t, lp.ConsumeLogs(context.Background(), incomingLogs))
129129
assert.NoError(t, lp.Shutdown(context.Background()))
130130

131-
testTelemetry.AssertMetrics(t, []metricdata.Metrics{
132-
{
133-
Name: "otelcol_processor_incoming_items",
134-
Description: "Number of items passed to the processor. [alpha]",
135-
Unit: "{items}",
136-
Data: metricdata.Sum[int64]{
137-
Temporality: metricdata.CumulativeTemporality,
138-
IsMonotonic: true,
139-
DataPoints: []metricdata.DataPoint[int64]{
140-
{
141-
Value: 3,
142-
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "logs")),
143-
},
144-
},
131+
metadatatest.AssertEqualProcessorIncomingItems(t, testTelemetry.Telemetry,
132+
[]metricdata.DataPoint[int64]{
133+
{
134+
Value: 3,
135+
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "logs")),
145136
},
146-
},
147-
{
148-
Name: "otelcol_processor_outgoing_items",
149-
Description: "Number of items emitted from the processor. [alpha]",
150-
Unit: "{items}",
151-
Data: metricdata.Sum[int64]{
152-
Temporality: metricdata.CumulativeTemporality,
153-
IsMonotonic: true,
154-
DataPoints: []metricdata.DataPoint[int64]{
155-
{
156-
Value: 1,
157-
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "logs")),
158-
},
159-
},
137+
}, metricdatatest.IgnoreTimestamp())
138+
metadatatest.AssertEqualProcessorOutgoingItems(t, testTelemetry.Telemetry,
139+
[]metricdata.DataPoint[int64]{
140+
{
141+
Value: 1,
142+
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "logs")),
160143
},
161-
},
162-
}, metricdatatest.IgnoreTimestamp())
144+
}, metricdatatest.IgnoreTimestamp())
163145
}
164146

165147
func TestLogs_RecordIn_ErrorOut(t *testing.T) {
@@ -184,36 +166,18 @@ func TestLogs_RecordIn_ErrorOut(t *testing.T) {
184166
require.Error(t, lp.ConsumeLogs(context.Background(), incomingLogs))
185167
require.NoError(t, lp.Shutdown(context.Background()))
186168

187-
testTelemetry.AssertMetrics(t, []metricdata.Metrics{
188-
{
189-
Name: "otelcol_processor_incoming_items",
190-
Description: "Number of items passed to the processor. [alpha]",
191-
Unit: "{items}",
192-
Data: metricdata.Sum[int64]{
193-
Temporality: metricdata.CumulativeTemporality,
194-
IsMonotonic: true,
195-
DataPoints: []metricdata.DataPoint[int64]{
196-
{
197-
Value: 3,
198-
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "logs")),
199-
},
200-
},
169+
metadatatest.AssertEqualProcessorIncomingItems(t, testTelemetry.Telemetry,
170+
[]metricdata.DataPoint[int64]{
171+
{
172+
Value: 3,
173+
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "logs")),
201174
},
202-
},
203-
{
204-
Name: "otelcol_processor_outgoing_items",
205-
Description: "Number of items emitted from the processor. [alpha]",
206-
Unit: "{items}",
207-
Data: metricdata.Sum[int64]{
208-
Temporality: metricdata.CumulativeTemporality,
209-
IsMonotonic: true,
210-
DataPoints: []metricdata.DataPoint[int64]{
211-
{
212-
Value: 0,
213-
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "logs")),
214-
},
215-
},
175+
}, metricdatatest.IgnoreTimestamp())
176+
metadatatest.AssertEqualProcessorOutgoingItems(t, testTelemetry.Telemetry,
177+
[]metricdata.DataPoint[int64]{
178+
{
179+
Value: 0,
180+
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "logs")),
216181
},
217-
},
218-
}, metricdatatest.IgnoreTimestamp())
182+
}, metricdatatest.IgnoreTimestamp())
219183
}

‎processor/processorhelper/metrics_test.go

Lines changed: 24 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -128,38 +128,20 @@ func TestMetrics_RecordInOut(t *testing.T) {
128128
assert.NoError(t, mp.ConsumeMetrics(context.Background(), incomingMetrics))
129129
assert.NoError(t, mp.Shutdown(context.Background()))
130130

131-
testTelemetry.AssertMetrics(t, []metricdata.Metrics{
132-
{
133-
Name: "otelcol_processor_incoming_items",
134-
Description: "Number of items passed to the processor. [alpha]",
135-
Unit: "{items}",
136-
Data: metricdata.Sum[int64]{
137-
Temporality: metricdata.CumulativeTemporality,
138-
IsMonotonic: true,
139-
DataPoints: []metricdata.DataPoint[int64]{
140-
{
141-
Value: 2,
142-
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "metrics")),
143-
},
144-
},
131+
metadatatest.AssertEqualProcessorIncomingItems(t, testTelemetry.Telemetry,
132+
[]metricdata.DataPoint[int64]{
133+
{
134+
Value: 2,
135+
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "metrics")),
145136
},
146-
},
147-
{
148-
Name: "otelcol_processor_outgoing_items",
149-
Description: "Number of items emitted from the processor. [alpha]",
150-
Unit: "{items}",
151-
Data: metricdata.Sum[int64]{
152-
Temporality: metricdata.CumulativeTemporality,
153-
IsMonotonic: true,
154-
DataPoints: []metricdata.DataPoint[int64]{
155-
{
156-
Value: 3,
157-
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "metrics")),
158-
},
159-
},
137+
}, metricdatatest.IgnoreTimestamp())
138+
metadatatest.AssertEqualProcessorOutgoingItems(t, testTelemetry.Telemetry,
139+
[]metricdata.DataPoint[int64]{
140+
{
141+
Value: 3,
142+
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "metrics")),
160143
},
161-
},
162-
}, metricdatatest.IgnoreTimestamp())
144+
}, metricdatatest.IgnoreTimestamp())
163145
}
164146

165147
func TestMetrics_RecordIn_ErrorOut(t *testing.T) {
@@ -183,36 +165,18 @@ func TestMetrics_RecordIn_ErrorOut(t *testing.T) {
183165
require.Error(t, mp.ConsumeMetrics(context.Background(), incomingMetrics))
184166
require.NoError(t, mp.Shutdown(context.Background()))
185167

186-
testTelemetry.AssertMetrics(t, []metricdata.Metrics{
187-
{
188-
Name: "otelcol_processor_incoming_items",
189-
Description: "Number of items passed to the processor. [alpha]",
190-
Unit: "{items}",
191-
Data: metricdata.Sum[int64]{
192-
Temporality: metricdata.CumulativeTemporality,
193-
IsMonotonic: true,
194-
DataPoints: []metricdata.DataPoint[int64]{
195-
{
196-
Value: 2,
197-
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "metrics")),
198-
},
199-
},
168+
metadatatest.AssertEqualProcessorIncomingItems(t, testTelemetry.Telemetry,
169+
[]metricdata.DataPoint[int64]{
170+
{
171+
Value: 2,
172+
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "metrics")),
200173
},
201-
},
202-
{
203-
Name: "otelcol_processor_outgoing_items",
204-
Description: "Number of items emitted from the processor. [alpha]",
205-
Unit: "{items}",
206-
Data: metricdata.Sum[int64]{
207-
Temporality: metricdata.CumulativeTemporality,
208-
IsMonotonic: true,
209-
DataPoints: []metricdata.DataPoint[int64]{
210-
{
211-
Value: 0,
212-
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "metrics")),
213-
},
214-
},
174+
}, metricdatatest.IgnoreTimestamp())
175+
metadatatest.AssertEqualProcessorOutgoingItems(t, testTelemetry.Telemetry,
176+
[]metricdata.DataPoint[int64]{
177+
{
178+
Value: 0,
179+
Attributes: attribute.NewSet(attribute.String("processor", "processorhelper"), attribute.String("otel.signal", "metrics")),
215180
},
216-
},
217-
}, metricdatatest.IgnoreTimestamp())
181+
}, metricdatatest.IgnoreTimestamp())
218182
}

0 commit comments

Comments
 (0)