[pdata] Deprecate Flags and SetFlags (#5790)

* Deprecate Flags and SetFlags * Update changelog * Fix lint
open-telemetry · Aug 2, 2022 · 27fdc2e · 27fdc2e
1 parent 6b847a1
commit 27fdc2e
Show file tree

Hide file tree

Showing 6 changed files with 85 additions and 94 deletions.
diff --git 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
@@ -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
diff --git a/pdata/internal/generated_pmetric_test.go b/pdata/internal/generated_pmetric_test.go
diff --git 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
@@ -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())