From a2f1cf2a0a599eb521f8aa5351396ad6079a1a04 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Thu, 4 Aug 2022 10:32:12 -0600 Subject: [PATCH 1/2] Remove deprecated Flags API --- pdata/internal/metrics.go | 87 ---------------------------------- pdata/internal/metrics_test.go | 34 +------------ pdata/pmetric/alias.go | 28 ----------- 3 files changed, 1 insertion(+), 148 deletions(-) diff --git a/pdata/internal/metrics.go b/pdata/internal/metrics.go index 8aeedbb2eba..0f571b1f1b7 100644 --- a/pdata/internal/metrics.go +++ b/pdata/internal/metrics.go @@ -183,54 +183,6 @@ 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. // @@ -287,45 +239,6 @@ func (ms MetricDataPointFlagsStruct) String() string { return otlpmetrics.DataPointFlags(*ms.orig).String() } -// MetricDataPointFlags defines how a metric aggregator reports aggregated values. -// It describes how those values relate to the time interval over which they are aggregated. -type MetricDataPointFlags uint32 - -const ( - // MetricDataPointFlagsNone is the default MetricDataPointFlags. - MetricDataPointFlagsNone = MetricDataPointFlags(otlpmetrics.DataPointFlags_FLAG_NONE) -) - -// NewMetricDataPointFlags returns a new MetricDataPointFlags combining the flags passed -// in as parameters. -func NewMetricDataPointFlags(flags ...MetricDataPointFlag) MetricDataPointFlags { - var flag MetricDataPointFlags - for _, f := range flags { - flag |= MetricDataPointFlags(f) - } - return flag -} - -// HasFlag returns true if the MetricDataPointFlags contains the specified flag -func (d MetricDataPointFlags) HasFlag(flag MetricDataPointFlag) bool { - return d&MetricDataPointFlags(flag) != 0 -} - -// String returns the string representation of the MetricDataPointFlags. -func (d MetricDataPointFlags) String() string { - return otlpmetrics.DataPointFlags(d).String() -} - -// MetricDataPointFlag allow users to configure DataPointFlags. This is achieved via NewMetricDataPointFlags. -// The separation between MetricDataPointFlags and MetricDataPointFlag exists to prevent users accidentally -// comparing the value of individual flags with MetricDataPointFlags. Instead, users must use the HasFlag method. -type MetricDataPointFlag uint32 - -const ( - // MetricDataPointFlagNoRecordedValue is flag for a metric aggregator which reports changes since last report time. - MetricDataPointFlagNoRecordedValue = MetricDataPointFlag(otlpmetrics.DataPointFlags_FLAG_NO_RECORDED_VALUE) -) - // NumberDataPointValueType specifies the type of NumberDataPoint value. type NumberDataPointValueType int32 diff --git a/pdata/internal/metrics_test.go b/pdata/internal/metrics_test.go index 2452c00c03c..e64f49decba 100644 --- a/pdata/internal/metrics_test.go +++ b/pdata/internal/metrics_test.go @@ -692,7 +692,7 @@ func TestMetricsDataPointFlags(t *testing.T) { gauge := generateTestGauge() assert.False(t, gauge.DataPoints().At(0).FlagsStruct().NoRecordedValue()) - assert.Equal(t, "FLAG_NONE", gauge.DataPoints().At(0).Flags().String()) + assert.Equal(t, "FLAG_NONE", gauge.DataPoints().At(0).FlagsStruct().String()) gauge.DataPoints().At(1).FlagsStruct().SetNoRecordedValue(true) assert.True(t, gauge.DataPoints().At(1).FlagsStruct().NoRecordedValue()) @@ -710,38 +710,6 @@ 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()) diff --git a/pdata/pmetric/alias.go b/pdata/pmetric/alias.go index 3594ce139be..1f3e1cba19a 100644 --- a/pdata/pmetric/alias.go +++ b/pdata/pmetric/alias.go @@ -57,34 +57,6 @@ type MetricDataPointFlagsStruct = internal.MetricDataPointFlagsStruct // NewMetricDataPointFlagsStruct returns a new empty MetricDataPointFlagsStruct. var NewMetricDataPointFlagsStruct = internal.NewMetricDataPointFlagsStruct -// MetricDataPointFlags defines how a metric aggregator reports aggregated values. -// It describes how those values relate to the time interval over which they are aggregated. -// Deprecated: [v0.57.0] Use MetricDataPointFlagsStruct instead. -type MetricDataPointFlags = internal.MetricDataPointFlags - -const ( - // MetricDataPointFlagsNone is the default MetricDataPointFlags. - // Deprecated: [v0.57.0] Use MetricDataPointFlagsStruct.NoRecordedValue instead. - MetricDataPointFlagsNone = internal.MetricDataPointFlagsNone -) - -// NewMetricDataPointFlags returns a new MetricDataPointFlags combining the flags passed -// in as parameters. -// Deprecated: [v0.57.0] Use NewMetricDataPointFlagsStruct and MetricDataPointFlagsStruct.SetNoRecordedValue instead. -var NewMetricDataPointFlags = internal.NewMetricDataPointFlags - -// MetricDataPointFlag allow users to configure DataPointFlags. This is achieved via NewMetricDataPointFlags. -// The separation between MetricDataPointFlags and MetricDataPointFlag exists to prevent users accidentally -// comparing the value of individual flags with MetricDataPointFlags. Instead, users must use the HasFlag method. -// Deprecated: [v0.57.0] Use MetricDataPointFlagsStruct instead. -type MetricDataPointFlag = internal.MetricDataPointFlag - -const ( - // MetricDataPointFlagNoRecordedValue is flag for a metric aggregator which reports changes since last report time. - // Deprecated: [v0.57.0] Use MetricDataPointFlagsStruct.NoRecordedValue instead. - MetricDataPointFlagNoRecordedValue = internal.MetricDataPointFlagNoRecordedValue -) - // NumberDataPointValueType specifies the type of NumberDataPoint value. type NumberDataPointValueType = internal.NumberDataPointValueType From 4a3b9f41c615bf94981b62dd06b9cf0c51c5c3a0 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Thu, 4 Aug 2022 10:35:06 -0600 Subject: [PATCH 2/2] Update changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c4128e3e236..e52e655dc04 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ - `component.WithLogsProcessorAndStabilityLevel` - ABI breaking change: `featuregate.Registry.Apply` returns error now. - Update minimum go version to 1.18 (#5795) +- Remove deprecated `Flags` API from pdata (#5814) ### 🚩 Deprecations 🚩