-
Notifications
You must be signed in to change notification settings - Fork 208
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
164 additions
and
8 deletions.
There are no files selected for viewing
67 changes: 67 additions & 0 deletions
67
plugins/processors/awsapplicationsignals/internal/aggregation/aggregation_mutator.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
// SPDX-License-Identifier: MIT | ||
|
||
package aggregation | ||
|
||
import ( | ||
"context" | ||
|
||
"go.opentelemetry.io/collector/pdata/pcommon" | ||
"go.opentelemetry.io/collector/pdata/pmetric" | ||
) | ||
|
||
type aggregationType int | ||
|
||
const ( | ||
defaultAggregation aggregationType = iota | ||
lastValueAggregation | ||
) | ||
|
||
// AggregationMutator is used to convert predefined ObservableUpDownCounter metrics to use LastValue aggregation. This | ||
// is necessary for cases where metrics are instrumented as cumulative, yet reported with snapshot values. | ||
// | ||
// For example, metrics like DotNetGCGen0HeapSize may report values such as 1000, 2000, 1000, with cumulative temporality | ||
// When exporters, such as the EMF exporter, detect these as cumulative, they convert the values to deltas, | ||
// resulting in outputs like -, 1000, -1000, which misrepresent the data. | ||
// | ||
// Normally, this issue could be resolved by configuring a view with LastValue aggregation within the SDK. | ||
// However, since the view feature is not fully supported in .NET, this workaround implements the required | ||
// conversion to LastValue aggregation to ensure accurate metric reporting. | ||
// See https://github.com/open-telemetry/opentelemetry-dotnet/issues/2618. | ||
type AggregationMutator struct { | ||
Check failure on line 31 in plugins/processors/awsapplicationsignals/internal/aggregation/aggregation_mutator.go GitHub Actions / Check lint
|
||
includes map[string]aggregationType | ||
} | ||
|
||
func NewAggregationMutator() AggregationMutator { | ||
return newAggregationMutatorWithConfig(map[string]aggregationType{ | ||
"DotNetGCGen0HeapSize": lastValueAggregation, | ||
"DotNetGCGen1HeapSize": lastValueAggregation, | ||
"DotNetGCGen2HeapSize": lastValueAggregation, | ||
"DotNetGCLOHHeapSize": lastValueAggregation, | ||
"DotNetGCPOHHeapSize": lastValueAggregation, | ||
"DotNetThreadCount": lastValueAggregation, | ||
"DotNetThreadQueueLength": lastValueAggregation, | ||
}) | ||
} | ||
|
||
func newAggregationMutatorWithConfig(includes map[string]aggregationType) AggregationMutator { | ||
return AggregationMutator{ | ||
includes, | ||
} | ||
} | ||
|
||
func (t *AggregationMutator) ProcessMetrics(_ context.Context, m pmetric.Metric, _ pcommon.Map) { | ||
aggType, exists := t.includes[m.Name()] | ||
if !exists || aggType == defaultAggregation { | ||
return | ||
} | ||
switch m.Type() { | ||
case pmetric.MetricTypeSum: | ||
switch aggType { | ||
case lastValueAggregation: | ||
m.Sum().SetAggregationTemporality(pmetric.AggregationTemporalityDelta) | ||
default: | ||
} | ||
default: | ||
} | ||
} |
84 changes: 84 additions & 0 deletions
84
plugins/processors/awsapplicationsignals/internal/aggregation/aggregation_mutator_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
// SPDX-License-Identifier: MIT | ||
|
||
package aggregation | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"go.opentelemetry.io/collector/pdata/pcommon" | ||
"go.opentelemetry.io/collector/pdata/pmetric" | ||
) | ||
|
||
func TestAggregationMutator_ProcessMetrics(t *testing.T) { | ||
tests := []struct { | ||
name string | ||
config map[string]aggregationType | ||
metrics []pmetric.Metric | ||
expectedTemporality map[string]pmetric.AggregationTemporality | ||
}{ | ||
{ | ||
"testCumulativeToDelta", | ||
map[string]aggregationType{ | ||
"test0": lastValueAggregation, | ||
}, | ||
|
||
[]pmetric.Metric{ | ||
generateMetricWithSumAggregation("test0", pmetric.AggregationTemporalityCumulative), | ||
}, | ||
map[string]pmetric.AggregationTemporality{ | ||
"test0": pmetric.AggregationTemporalityDelta, | ||
}, | ||
}, | ||
{ | ||
"testNoChange", | ||
map[string]aggregationType{ | ||
"test0": lastValueAggregation, | ||
"test1": defaultAggregation, | ||
}, | ||
[]pmetric.Metric{ | ||
generateMetricWithSumAggregation("test0", pmetric.AggregationTemporalityDelta), | ||
generateMetricWithSumAggregation("test1", pmetric.AggregationTemporalityCumulative), | ||
generateMetricWithSumAggregation("test2", pmetric.AggregationTemporalityCumulative), | ||
}, | ||
map[string]pmetric.AggregationTemporality{ | ||
"test0": pmetric.AggregationTemporalityDelta, | ||
"test1": pmetric.AggregationTemporalityCumulative, | ||
"test2": pmetric.AggregationTemporalityCumulative, | ||
}, | ||
}, | ||
} | ||
for _, tt := range tests { | ||
t.Run(tt.name, func(t1 *testing.T) { | ||
mutator := newAggregationMutatorWithConfig(tt.config) | ||
|
||
for _, m := range tt.metrics { | ||
mutator.ProcessMetrics(nil, m, pcommon.NewMap()) | ||
Check failure on line 57 in plugins/processors/awsapplicationsignals/internal/aggregation/aggregation_mutator_test.go GitHub Actions / Check lint
|
||
assert.Equal(t1, tt.expectedTemporality[m.Name()], m.Sum().AggregationTemporality()) | ||
} | ||
}) | ||
} | ||
|
||
mutator := NewAggregationMutator() | ||
|
||
m := generateMetricWithSumAggregation("DotNetGCGen0HeapSize", pmetric.AggregationTemporalityCumulative) | ||
mutator.ProcessMetrics(nil, m, pcommon.NewMap()) | ||
Check failure on line 66 in plugins/processors/awsapplicationsignals/internal/aggregation/aggregation_mutator_test.go GitHub Actions / Check lint
|
||
assert.Equal(t, pmetric.MetricTypeSum, m.Type()) | ||
assert.Equal(t, pmetric.AggregationTemporalityDelta, m.Sum().AggregationTemporality()) | ||
|
||
m.SetEmptyHistogram() | ||
m.Histogram().SetAggregationTemporality(pmetric.AggregationTemporalityCumulative) | ||
mutator.ProcessMetrics(nil, m, pcommon.NewMap()) | ||
Check failure on line 72 in plugins/processors/awsapplicationsignals/internal/aggregation/aggregation_mutator_test.go GitHub Actions / Check lint
|
||
assert.Equal(t, pmetric.MetricTypeHistogram, m.Type()) | ||
assert.Equal(t, pmetric.AggregationTemporalityCumulative, m.Histogram().AggregationTemporality()) | ||
|
||
} | ||
|
||
func generateMetricWithSumAggregation(metricName string, temporality pmetric.AggregationTemporality) pmetric.Metric { | ||
m := pmetric.NewMetrics().ResourceMetrics().AppendEmpty().ScopeMetrics().AppendEmpty().Metrics().AppendEmpty() | ||
m.SetName(metricName) | ||
m.SetEmptySum() | ||
m.Sum().SetAggregationTemporality(temporality) | ||
return m | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters