From 27fdc2e2ded2b0900d165edebbf4c26ffc83c2d0 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Tue, 2 Aug 2022 16:00:31 -0600 Subject: [PATCH] [pdata] Deprecate Flags and SetFlags (#5790) * Deprecate Flags and SetFlags * Update changelog * Fix lint --- CHANGELOG.md | 6 ++- .../cmd/pdatagen/internal/metrics_structs.go | 13 ----- pdata/internal/generated_pmetric.go | 44 ----------------- pdata/internal/generated_pmetric_test.go | 36 -------------- pdata/internal/metrics.go | 48 +++++++++++++++++++ pdata/internal/metrics_test.go | 32 +++++++++++++ 6 files changed, 85 insertions(+), 94 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d65d5a2428c..c29eed2a26b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,11 +20,15 @@ ### 🚩 Deprecations 🚩 -- Deprecated the current Flag API. The new API provides functions to check and set Flags: +- Deprecated the current Flag API. The new API provides functions to check and set Flags (#5790) (#5602): - `NumberDataPoint.Flags` -> `NumberDataPoint.FlagsStruct` + - `NumberDataPoint.SetFlags` -> `NumberDataPoint.FlagsStruct` - `HistogramDataPoint.Flags` -> `HistogramDataPoint.FlagsStruct` + - `HistogramDataPoint.SetFlags` -> `HistogramDataPoint.FlagsStruct` - `ExponentialHistogramDataPoint.Flags` -> `ExponentialHistogramDataPoint.FlagsStruct` + - `ExponentialHistogramDataPoint.SetFlags` -> `ExponentialHistogramDataPoint.FlagsStruct` - `SummaryDataPoint.Flags` -> `SummaryDataPoint.FlagsStruct` + - `SummaryDataPoint.SetFlags` -> `SummaryDataPoint.FlagsStruct` - `MetricDataPointFlags` -> `MetricDataPointFlagsStruct` - `NewMetricDataPointFlags` -> `NewMetricDataPointFlagsStruct` - `MetricDataPointFlagsNone` -> `MetricDataPointFlagsStruct.NoRecordedValue` diff --git a/pdata/internal/cmd/pdatagen/internal/metrics_structs.go b/pdata/internal/cmd/pdatagen/internal/metrics_structs.go index e6c1b2b9a5b..57b7151b205 100644 --- a/pdata/internal/cmd/pdatagen/internal/metrics_structs.go +++ b/pdata/internal/cmd/pdatagen/internal/metrics_structs.go @@ -266,7 +266,6 @@ var numberDataPoint = &messageValueStruct{ }, }, exemplarsField, - dataPointFlagsField, dataPointFlagsFieldStruct, }, } @@ -289,7 +288,6 @@ var histogramDataPoint = &messageValueStruct{ bucketCountsField, explicitBoundsField, exemplarsField, - dataPointFlagsField, dataPointFlagsFieldStruct, &optionalPrimitiveValue{ fieldName: "Min", @@ -365,7 +363,6 @@ var exponentialHistogramDataPoint = &messageValueStruct{ returnMessage: bucketsValues, }, exemplarsField, - dataPointFlagsField, dataPointFlagsFieldStruct, &optionalPrimitiveValue{ fieldName: "Min", @@ -425,7 +422,6 @@ var summaryDataPoint = &messageValueStruct{ originFieldName: "QuantileValues", returnSlice: quantileValuesSlice, }, - dataPointFlagsField, dataPointFlagsFieldStruct, }, } @@ -575,15 +571,6 @@ var aggregationTemporalityField = &primitiveTypedField{ testVal: "MetricAggregationTemporalityCumulative", } -var dataPointFlagsField = &primitiveTypedField{ - fieldName: "Flags", - originFieldName: "Flags", - returnType: "MetricDataPointFlags", - rawType: "uint32", - defaultVal: "MetricDataPointFlagsNone", - testVal: "MetricDataPointFlagsNone", -} - var optionalDoubleSumField = &optionalPrimitiveValue{ fieldName: "Sum", fieldType: "Double", diff --git a/pdata/internal/generated_pmetric.go b/pdata/internal/generated_pmetric.go index 3a5e974a426..b74f43bf4a6 100644 --- a/pdata/internal/generated_pmetric.go +++ b/pdata/internal/generated_pmetric.go @@ -1200,16 +1200,6 @@ func (ms NumberDataPoint) Exemplars() ExemplarSlice { return newExemplarSlice(&(*ms.orig).Exemplars) } -// Flags returns the flags associated with this NumberDataPoint. -func (ms NumberDataPoint) Flags() MetricDataPointFlags { - return MetricDataPointFlags((*ms.orig).Flags) -} - -// SetFlags replaces the flags associated with this NumberDataPoint. -func (ms NumberDataPoint) SetFlags(v MetricDataPointFlags) { - (*ms.orig).Flags = uint32(v) -} - // FlagsStruct returns the flagsstruct associated with this NumberDataPoint. func (ms NumberDataPoint) FlagsStruct() MetricDataPointFlagsStruct { return newMetricDataPointFlagsStruct(&(*ms.orig).Flags) @@ -1228,7 +1218,6 @@ func (ms NumberDataPoint) CopyTo(dest NumberDataPoint) { } ms.Exemplars().CopyTo(dest.Exemplars()) - dest.SetFlags(ms.Flags()) ms.FlagsStruct().CopyTo(dest.FlagsStruct()) } @@ -1475,16 +1464,6 @@ func (ms HistogramDataPoint) Exemplars() ExemplarSlice { return newExemplarSlice(&(*ms.orig).Exemplars) } -// Flags returns the flags associated with this HistogramDataPoint. -func (ms HistogramDataPoint) Flags() MetricDataPointFlags { - return MetricDataPointFlags((*ms.orig).Flags) -} - -// SetFlags replaces the flags associated with this HistogramDataPoint. -func (ms HistogramDataPoint) SetFlags(v MetricDataPointFlags) { - (*ms.orig).Flags = uint32(v) -} - // FlagsStruct returns the flagsstruct associated with this HistogramDataPoint. func (ms HistogramDataPoint) FlagsStruct() MetricDataPointFlagsStruct { return newMetricDataPointFlagsStruct(&(*ms.orig).Flags) @@ -1547,7 +1526,6 @@ func (ms HistogramDataPoint) CopyTo(dest HistogramDataPoint) { } ms.Exemplars().CopyTo(dest.Exemplars()) - dest.SetFlags(ms.Flags()) ms.FlagsStruct().CopyTo(dest.FlagsStruct()) if ms.HasMin() { dest.SetMin(ms.Min()) @@ -1815,16 +1793,6 @@ func (ms ExponentialHistogramDataPoint) Exemplars() ExemplarSlice { return newExemplarSlice(&(*ms.orig).Exemplars) } -// Flags returns the flags associated with this ExponentialHistogramDataPoint. -func (ms ExponentialHistogramDataPoint) Flags() MetricDataPointFlags { - return MetricDataPointFlags((*ms.orig).Flags) -} - -// SetFlags replaces the flags associated with this ExponentialHistogramDataPoint. -func (ms ExponentialHistogramDataPoint) SetFlags(v MetricDataPointFlags) { - (*ms.orig).Flags = uint32(v) -} - // FlagsStruct returns the flagsstruct associated with this ExponentialHistogramDataPoint. func (ms ExponentialHistogramDataPoint) FlagsStruct() MetricDataPointFlagsStruct { return newMetricDataPointFlagsStruct(&(*ms.orig).Flags) @@ -1877,7 +1845,6 @@ func (ms ExponentialHistogramDataPoint) CopyTo(dest ExponentialHistogramDataPoin ms.Positive().CopyTo(dest.Positive()) ms.Negative().CopyTo(dest.Negative()) ms.Exemplars().CopyTo(dest.Exemplars()) - dest.SetFlags(ms.Flags()) ms.FlagsStruct().CopyTo(dest.FlagsStruct()) if ms.HasMin() { dest.SetMin(ms.Min()) @@ -2168,16 +2135,6 @@ func (ms SummaryDataPoint) QuantileValues() ValueAtQuantileSlice { return newValueAtQuantileSlice(&(*ms.orig).QuantileValues) } -// Flags returns the flags associated with this SummaryDataPoint. -func (ms SummaryDataPoint) Flags() MetricDataPointFlags { - return MetricDataPointFlags((*ms.orig).Flags) -} - -// SetFlags replaces the flags associated with this SummaryDataPoint. -func (ms SummaryDataPoint) SetFlags(v MetricDataPointFlags) { - (*ms.orig).Flags = uint32(v) -} - // FlagsStruct returns the flagsstruct associated with this SummaryDataPoint. func (ms SummaryDataPoint) FlagsStruct() MetricDataPointFlagsStruct { return newMetricDataPointFlagsStruct(&(*ms.orig).Flags) @@ -2191,7 +2148,6 @@ func (ms SummaryDataPoint) CopyTo(dest SummaryDataPoint) { dest.SetCount(ms.Count()) dest.SetSum(ms.Sum()) ms.QuantileValues().CopyTo(dest.QuantileValues()) - dest.SetFlags(ms.Flags()) ms.FlagsStruct().CopyTo(dest.FlagsStruct()) } diff --git a/pdata/internal/generated_pmetric_test.go b/pdata/internal/generated_pmetric_test.go index 00fb0890d9d..454ef8e5d7e 100644 --- a/pdata/internal/generated_pmetric_test.go +++ b/pdata/internal/generated_pmetric_test.go @@ -931,14 +931,6 @@ func TestNumberDataPoint_Exemplars(t *testing.T) { assert.EqualValues(t, testValExemplars, ms.Exemplars()) } -func TestNumberDataPoint_Flags(t *testing.T) { - ms := NewNumberDataPoint() - assert.EqualValues(t, MetricDataPointFlagsNone, ms.Flags()) - testValFlags := MetricDataPointFlagsNone - ms.SetFlags(testValFlags) - assert.EqualValues(t, testValFlags, ms.Flags()) -} - func TestNumberDataPoint_FlagsStruct(t *testing.T) { ms := NewNumberDataPoint() fillTestMetricDataPointFlagsStruct(ms.FlagsStruct()) @@ -1137,14 +1129,6 @@ func TestHistogramDataPoint_Exemplars(t *testing.T) { assert.EqualValues(t, testValExemplars, ms.Exemplars()) } -func TestHistogramDataPoint_Flags(t *testing.T) { - ms := NewHistogramDataPoint() - assert.EqualValues(t, MetricDataPointFlagsNone, ms.Flags()) - testValFlags := MetricDataPointFlagsNone - ms.SetFlags(testValFlags) - assert.EqualValues(t, testValFlags, ms.Flags()) -} - func TestHistogramDataPoint_FlagsStruct(t *testing.T) { ms := NewHistogramDataPoint() fillTestMetricDataPointFlagsStruct(ms.FlagsStruct()) @@ -1371,14 +1355,6 @@ func TestExponentialHistogramDataPoint_Exemplars(t *testing.T) { assert.EqualValues(t, testValExemplars, ms.Exemplars()) } -func TestExponentialHistogramDataPoint_Flags(t *testing.T) { - ms := NewExponentialHistogramDataPoint() - assert.EqualValues(t, MetricDataPointFlagsNone, ms.Flags()) - testValFlags := MetricDataPointFlagsNone - ms.SetFlags(testValFlags) - assert.EqualValues(t, testValFlags, ms.Flags()) -} - func TestExponentialHistogramDataPoint_FlagsStruct(t *testing.T) { ms := NewExponentialHistogramDataPoint() fillTestMetricDataPointFlagsStruct(ms.FlagsStruct()) @@ -1611,14 +1587,6 @@ func TestSummaryDataPoint_QuantileValues(t *testing.T) { assert.EqualValues(t, testValQuantileValues, ms.QuantileValues()) } -func TestSummaryDataPoint_Flags(t *testing.T) { - ms := NewSummaryDataPoint() - assert.EqualValues(t, MetricDataPointFlagsNone, ms.Flags()) - testValFlags := MetricDataPointFlagsNone - ms.SetFlags(testValFlags) - assert.EqualValues(t, testValFlags, ms.Flags()) -} - func TestSummaryDataPoint_FlagsStruct(t *testing.T) { ms := NewSummaryDataPoint() fillTestMetricDataPointFlagsStruct(ms.FlagsStruct()) @@ -2106,7 +2074,6 @@ func fillTestNumberDataPoint(tv NumberDataPoint) { tv.SetTimestamp(Timestamp(1234567890)) tv.SetDoubleVal(float64(17.13)) fillTestExemplarSlice(tv.Exemplars()) - tv.SetFlags(MetricDataPointFlagsNone) fillTestMetricDataPointFlagsStruct(tv.FlagsStruct()) } @@ -2139,7 +2106,6 @@ func fillTestHistogramDataPoint(tv HistogramDataPoint) { tv.SetBucketCounts(NewImmutableUInt64Slice([]uint64{1, 2, 3})) tv.SetExplicitBounds(NewImmutableFloat64Slice([]float64{1, 2, 3})) fillTestExemplarSlice(tv.Exemplars()) - tv.SetFlags(MetricDataPointFlagsNone) fillTestMetricDataPointFlagsStruct(tv.FlagsStruct()) tv.SetMin(float64(9.23)) tv.SetMax(float64(182.55)) @@ -2176,7 +2142,6 @@ func fillTestExponentialHistogramDataPoint(tv ExponentialHistogramDataPoint) { fillTestBuckets(tv.Positive()) fillTestBuckets(tv.Negative()) fillTestExemplarSlice(tv.Exemplars()) - tv.SetFlags(MetricDataPointFlagsNone) fillTestMetricDataPointFlagsStruct(tv.FlagsStruct()) tv.SetMin(float64(9.23)) tv.SetMax(float64(182.55)) @@ -2220,7 +2185,6 @@ func fillTestSummaryDataPoint(tv SummaryDataPoint) { tv.SetCount(uint64(17)) tv.SetSum(float64(17.13)) fillTestValueAtQuantileSlice(tv.QuantileValues()) - tv.SetFlags(MetricDataPointFlagsNone) fillTestMetricDataPointFlagsStruct(tv.FlagsStruct()) } diff --git a/pdata/internal/metrics.go b/pdata/internal/metrics.go index da6748f5952..88637650313 100644 --- a/pdata/internal/metrics.go +++ b/pdata/internal/metrics.go @@ -183,6 +183,54 @@ func (at MetricAggregationTemporality) String() string { return otlpmetrics.AggregationTemporality(at).String() } +// Flags returns the flags associated with this NumberDataPoint. +// Deprecated: [v0.57.0] Use FlagsStruct instead. +func (ms NumberDataPoint) Flags() MetricDataPointFlags { + return MetricDataPointFlags(ms.orig.Flags) +} + +// SetFlags replaces the flags associated with this NumberDataPoint. +// Deprecated: [v0.57.0] Use FlagsStruct instead. +func (ms NumberDataPoint) SetFlags(v MetricDataPointFlags) { + ms.orig.Flags = uint32(v) +} + +// Flags returns the flags associated with this HistogramDataPoint. +// Deprecated: [v0.57.0] Use FlagsStruct instead. +func (ms HistogramDataPoint) Flags() MetricDataPointFlags { + return MetricDataPointFlags(ms.orig.Flags) +} + +// SetFlags replaces the flags associated with this HistogramDataPoint. +// Deprecated: [v0.57.0] Use FlagsStruct instead. +func (ms HistogramDataPoint) SetFlags(v MetricDataPointFlags) { + ms.orig.Flags = uint32(v) +} + +// Flags returns the flags associated with this ExponentialHistogramDataPoint. +// Deprecated: [v0.57.0] Use FlagsStruct instead. +func (ms ExponentialHistogramDataPoint) Flags() MetricDataPointFlags { + return MetricDataPointFlags(ms.orig.Flags) +} + +// SetFlags replaces the flags associated with this ExponentialHistogramDataPoint. +// Deprecated: [v0.57.0] Use FlagsStruct instead. +func (ms ExponentialHistogramDataPoint) SetFlags(v MetricDataPointFlags) { + ms.orig.Flags = uint32(v) +} + +// Flags returns the flags associated with this SummaryDataPoint. +// Deprecated: [v0.57.0] Use FlagsStruct instead. +func (ms SummaryDataPoint) Flags() MetricDataPointFlags { + return MetricDataPointFlags(ms.orig.Flags) +} + +// SetFlags replaces the flags associated with this SummaryDataPoint. +// Deprecated: [v0.57.0] Use FlagsStruct instead. +func (ms SummaryDataPoint) SetFlags(v MetricDataPointFlags) { + ms.orig.Flags = uint32(v) +} + // MetricDataPointFlagsStruct defines how a metric aggregator reports aggregated values. // It describes how those values relate to the time interval over which they are aggregated. // diff --git a/pdata/internal/metrics_test.go b/pdata/internal/metrics_test.go index 34f01217f3e..2452c00c03c 100644 --- a/pdata/internal/metrics_test.go +++ b/pdata/internal/metrics_test.go @@ -710,6 +710,38 @@ func TestMetricsDataPointFlags(t *testing.T) { assert.True(t, gauge.DataPoints().At(1).FlagsStruct().NoRecordedValue()) } +func TestNumberDataPoint_Flags(t *testing.T) { + ms := NewNumberDataPoint() + assert.EqualValues(t, MetricDataPointFlagsNone, ms.Flags()) + testValFlags := MetricDataPointFlagsNone + ms.SetFlags(testValFlags) + assert.EqualValues(t, testValFlags, ms.Flags()) +} + +func TestHistogramDataPoint_Flags(t *testing.T) { + ms := NewHistogramDataPoint() + assert.EqualValues(t, MetricDataPointFlagsNone, ms.Flags()) + testValFlags := MetricDataPointFlagsNone + ms.SetFlags(testValFlags) + assert.EqualValues(t, testValFlags, ms.Flags()) +} + +func TestSummaryDataPoint_Flags(t *testing.T) { + ms := NewSummaryDataPoint() + assert.EqualValues(t, MetricDataPointFlagsNone, ms.Flags()) + testValFlags := MetricDataPointFlagsNone + ms.SetFlags(testValFlags) + assert.EqualValues(t, testValFlags, ms.Flags()) +} + +func TestExponentialHistogramDataPoint_Flags(t *testing.T) { + ms := NewExponentialHistogramDataPoint() + assert.EqualValues(t, MetricDataPointFlagsNone, ms.Flags()) + testValFlags := MetricDataPointFlagsNone + ms.SetFlags(testValFlags) + assert.EqualValues(t, testValFlags, ms.Flags()) +} + func BenchmarkMetricsClone(b *testing.B) { metrics := NewMetrics() fillTestResourceMetricsSlice(metrics.ResourceMetrics())