Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[pdata] Remove deprecated Flags API #5814

Merged
merged 4 commits into from
Aug 5, 2022
Merged

[pdata] Remove deprecated Flags API #5814

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a2f1cf2
Remove deprecated Flags API
TylerHelmuth Aug 4, 2022
4a3b9f4
Update changelog
TylerHelmuth Aug 4, 2022
9b543aa
Merge branch 'main' into remove-deprecated-flags
bogdandrutu Aug 4, 2022
8736945
Merge branch 'main' into remove-deprecated-flags
bogdandrutu Aug 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,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 🚩

Expand Down
87 changes: 0 additions & 87 deletions pdata/internal/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
//
Expand Down Expand Up @@ -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

Expand Down
34 changes: 1 addition & 33 deletions pdata/internal/metrics_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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())
Expand All @@ -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())
Expand Down
28 changes: 0 additions & 28 deletions pdata/pmetric/alias.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down