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.

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

aggregateutil: allow filtering against empty attribute set #35006

Merged
merged 13 commits into from
Oct 11, 2024
27 changes: 27 additions & 0 deletions .chloggen/aggregate_labels_empty.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: metricstransform

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: The previously removed functionality of aggregating against an empty label set is restored.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [34430]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
14 changes: 13 additions & 1 deletion internal/coreinternal/aggregateutil/aggregate.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,21 @@ func CopyMetricDetails(from, to pmetric.Metric) {
}

func FilterAttrs(metric pmetric.Metric, filterAttrKeys []string) {
if len(filterAttrKeys) == 0 {
// filterAttrKeys being nil means the filter is to be skipped.
if filterAttrKeys == nil {
return
}
// filterAttrKeys being empty means it is explicitly expected to filter
// against an empty label set, which is functionally the same as removing
// all attributes.
if len(filterAttrKeys) == 0 {
RangeDataPointAttributes(metric, func(attrs pcommon.Map) bool {
attrs.Clear()
return true
})
}
// filterAttrKeys having provided attributes means the filter continues
// as normal.
RangeDataPointAttributes(metric, func(attrs pcommon.Map) bool {
attrs.RemoveIf(func(k string, _ pcommon.Value) bool {
return isNotPresent(k, filterAttrKeys)
Expand Down
4 changes: 1 addition & 3 deletions internal/coreinternal/aggregateutil/aggregate_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,7 @@ func Test_FilterAttributes(t *testing.T) {
want: func() pmetric.Metric {
m := pmetric.NewMetric()
s := m.SetEmptySum()
d := s.DataPoints().AppendEmpty()
d.Attributes().PutStr("attr1", "val1")
d.Attributes().PutStr("attr2", "val2")
s.DataPoints().AppendEmpty()
return m
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
package metricstransformprocessor

import (
"fmt"

"go.opentelemetry.io/collector/pdata/pcommon"
"go.opentelemetry.io/collector/pdata/pmetric"
)
Expand Down Expand Up @@ -54,7 +56,12 @@ func (b builder) addDoubleDatapoint(start, ts pcommon.Timestamp, val float64, at

func (b builder) setAttrs(attrs pcommon.Map, attrValues []string) {
if len(attrValues) != len(b.attrs) {
panic(attrValues)
panic(
fmt.Sprintf(
"not enough attributes, expected %d attributes but got %s",
len(b.attrs),
attrValues),
)
}
for i, a := range b.attrs {
attrs.PutStr(a, attrValues[i])
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ func transformMetric(metric pmetric.Metric, transform internalTransform) bool {
updateLabelOp(metric, op, transform.MetricIncludeFilter)
case aggregateLabels:
if canChangeMetric {
attrs := []string{}
attrs := make([]string, 0, len(op.labelSetMap))
for k, v := range op.labelSetMap {
if v {
attrs = append(attrs, k)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -667,6 +667,35 @@ var (
build(),
},
},
{
name: "metric_label_aggregation_empty_label_set",
transforms: []internalTransform{
{
MetricIncludeFilter: internalFilterStrict{include: "metric1"},
Action: Update,
Operations: []internalOperation{
{
configOperation: Operation{
Action: aggregateLabels,
AggregationType: aggregateutil.Sum,
LabelSet: []string{},
},
labelSetMap: map[string]bool{},
},
},
},
},
in: []pmetric.Metric{
metricBuilder(pmetric.MetricTypeGauge, "metric1", "label1", "label2", "label3").
addIntDatapoint(0, 1, 1, "a", "b", "c").
build(),
},
out: []pmetric.Metric{
metricBuilder(pmetric.MetricTypeGauge, "metric1").
addIntDatapoint(0, 1, 1).
build(),
},
},
{
name: "metric_label_aggregation_ignored_for_partial_metric_match",
transforms: []internalTransform{
Expand Down