-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: added translation rw2 translation for gauges
Signed-off-by: Juraj Michalek <[email protected]>
- Loading branch information
1 parent
12a8df8
commit 8165501
Showing
9 changed files
with
301 additions
and
17 deletions.
There are no files selected for viewing
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,108 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package prometheusremotewrite // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/prometheusremotewrite" | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "slices" | ||
|
|
||
| "github.com/prometheus/common/model" | ||
| "github.com/prometheus/prometheus/model/labels" | ||
| "go.opentelemetry.io/collector/pdata/pcommon" | ||
| conventions "go.opentelemetry.io/collector/semconv/v1.25.0" | ||
|
|
||
| prometheustranslator "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/prometheus" | ||
| ) | ||
|
|
||
| // createAttributes creates a slice of Prometheus Labels with OTLP attributes and pairs of string values. | ||
| // Unpaired string values are ignored. String pairs overwrite OTLP labels if collisions happen and | ||
| // if logOnOverwrite is true, the overwrite is logged. Resulting label names are sanitized. | ||
| func createAttributesV2(resource pcommon.Resource, attributes pcommon.Map, externalLabels map[string]string, | ||
| ignoreAttrs []string, logOnOverwrite bool, extras ...string) labels.Labels { | ||
| resourceAttrs := resource.Attributes() | ||
| serviceName, haveServiceName := resourceAttrs.Get(conventions.AttributeServiceName) | ||
| instance, haveInstanceID := resourceAttrs.Get(conventions.AttributeServiceInstanceID) | ||
|
|
||
| // Calculate the maximum possible number of labels we could return so we can preallocate l | ||
| maxLabelCount := attributes.Len() + len(externalLabels) + len(extras)/2 | ||
|
|
||
| if haveServiceName { | ||
| maxLabelCount++ | ||
| } | ||
|
|
||
| if haveInstanceID { | ||
| maxLabelCount++ | ||
| } | ||
|
|
||
| // map ensures no duplicate label name | ||
| l := make(map[string]string, maxLabelCount) | ||
|
|
||
| // Ensure attributes are sorted by key for consistent merging of keys which | ||
| // collide when sanitized. | ||
| tempSeriesLabels := labels.Labels{} | ||
| // XXX: Should we always drop service namespace/service name/service instance ID from the labels | ||
| // (as they get mapped to other Prometheus labels)? | ||
| attributes.Range(func(key string, value pcommon.Value) bool { | ||
| if !slices.Contains(ignoreAttrs, key) { | ||
| tempSeriesLabels = append(tempSeriesLabels, labels.Label{Name: key, Value: value.AsString()}) | ||
| } | ||
| return true | ||
| }) | ||
| // TODO New returns a sorted Labels from the given labels. The caller has to guarantee that all label names are unique. | ||
| seriesLabels := labels.New(tempSeriesLabels...) // This sorts by name | ||
|
|
||
| for _, label := range seriesLabels { | ||
| var finalKey = prometheustranslator.NormalizeLabel(label.Name) | ||
| if existingValue, alreadyExists := l[finalKey]; alreadyExists { | ||
| l[finalKey] = existingValue + ";" + label.Value | ||
| } else { | ||
| l[finalKey] = label.Value | ||
| } | ||
| } | ||
|
|
||
| // Map service.name + service.namespace to job | ||
| if haveServiceName { | ||
| val := serviceName.AsString() | ||
| if serviceNamespace, ok := resourceAttrs.Get(conventions.AttributeServiceNamespace); ok { | ||
| val = fmt.Sprintf("%s/%s", serviceNamespace.AsString(), val) | ||
| } | ||
| l[model.JobLabel] = val | ||
| } | ||
| // Map service.instance.id to instance | ||
| if haveInstanceID { | ||
| l[model.InstanceLabel] = instance.AsString() | ||
| } | ||
| for key, value := range externalLabels { | ||
| // External labels have already been sanitized | ||
| if _, alreadyExists := l[key]; alreadyExists { | ||
| // Skip external labels if they are overridden by metric attributes | ||
| continue | ||
| } | ||
| l[key] = value | ||
| } | ||
|
|
||
| for i := 0; i < len(extras); i += 2 { | ||
| if i+1 >= len(extras) { | ||
| break | ||
| } | ||
| _, found := l[extras[i]] | ||
| if found && logOnOverwrite { | ||
| log.Println("label " + extras[i] + " is overwritten. Check if Prometheus reserved labels are used.") | ||
| } | ||
| // internal labels should be maintained | ||
| name := extras[i] | ||
| if !(len(name) > 4 && name[:2] == "__" && name[len(name)-2:] == "__") { | ||
| name = prometheustranslator.NormalizeLabel(name) | ||
| } | ||
| l[name] = extras[i+1] | ||
| } | ||
|
|
||
| seriesLabels = seriesLabels[:0] | ||
| for k, v := range l { | ||
| seriesLabels = append(seriesLabels, labels.Label{Name: k, Value: v}) | ||
| } | ||
|
|
||
| return seriesLabels | ||
| } |
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,139 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package prometheusremotewrite | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/prometheus/prometheus/model/labels" | ||
| "github.com/stretchr/testify/assert" | ||
| "go.opentelemetry.io/collector/pdata/pcommon" | ||
| ) | ||
|
|
||
| // Test_createLabelSet checks resultant label names are sanitized and label in extra overrides label in labels if | ||
| // collision happens. It does not check whether labels are not sorted | ||
| func Test_createLabelSetV2(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| resource pcommon.Resource | ||
| orig pcommon.Map | ||
| externalLabels map[string]string | ||
| extras []string | ||
| want labels.Labels | ||
| }{ | ||
| { | ||
| "labels_clean", | ||
| pcommon.NewResource(), | ||
| lbs1, | ||
| map[string]string{}, | ||
| []string{label31, value31, label32, value32}, | ||
| getPromLabelsV2(label11, value11, label12, value12, label31, value31, label32, value32), | ||
| }, | ||
| { | ||
| "labels_with_resource", | ||
| func() pcommon.Resource { | ||
| res := pcommon.NewResource() | ||
| res.Attributes().PutStr("service.name", "prometheus") | ||
| res.Attributes().PutStr("service.instance.id", "127.0.0.1:8080") | ||
| return res | ||
| }(), | ||
| lbs1, | ||
| map[string]string{}, | ||
| []string{label31, value31, label32, value32}, | ||
| getPromLabelsV2(label11, value11, label12, value12, label31, value31, label32, value32, "job", "prometheus", "instance", "127.0.0.1:8080"), | ||
| }, | ||
| { | ||
| "labels_with_nonstring_resource", | ||
| func() pcommon.Resource { | ||
| res := pcommon.NewResource() | ||
| res.Attributes().PutInt("service.name", 12345) | ||
| res.Attributes().PutBool("service.instance.id", true) | ||
| return res | ||
| }(), | ||
| lbs1, | ||
| map[string]string{}, | ||
| []string{label31, value31, label32, value32}, | ||
| getPromLabelsV2(label11, value11, label12, value12, label31, value31, label32, value32, "job", "12345", "instance", "true"), | ||
| }, | ||
| { | ||
| "labels_duplicate_in_extras", | ||
| pcommon.NewResource(), | ||
| lbs1, | ||
| map[string]string{}, | ||
| []string{label11, value31}, | ||
| getPromLabelsV2(label11, value31, label12, value12), | ||
| }, | ||
| { | ||
| "labels_dirty", | ||
| pcommon.NewResource(), | ||
| lbs1Dirty, | ||
| map[string]string{}, | ||
| []string{label31 + dirty1, value31, label32, value32}, | ||
| getPromLabelsV2(label11+"_", value11, "key_"+label12, value12, label31+"_", value31, label32, value32), | ||
| }, | ||
| { | ||
| "no_original_case", | ||
| pcommon.NewResource(), | ||
| pcommon.NewMap(), | ||
| nil, | ||
| []string{label31, value31, label32, value32}, | ||
| getPromLabelsV2(label31, value31, label32, value32), | ||
| }, | ||
| { | ||
| "empty_extra_case", | ||
| pcommon.NewResource(), | ||
| lbs1, | ||
| map[string]string{}, | ||
| []string{"", ""}, | ||
| getPromLabelsV2(label11, value11, label12, value12, "", ""), | ||
| }, | ||
| { | ||
| "single_left_over_case", | ||
| pcommon.NewResource(), | ||
| lbs1, | ||
| map[string]string{}, | ||
| []string{label31, value31, label32}, | ||
| getPromLabelsV2(label11, value11, label12, value12, label31, value31), | ||
| }, | ||
| { | ||
| "valid_external_labels", | ||
| pcommon.NewResource(), | ||
| lbs1, | ||
| exlbs1, | ||
| []string{label31, value31, label32, value32}, | ||
| getPromLabelsV2(label11, value11, label12, value12, label41, value41, label31, value31, label32, value32), | ||
| }, | ||
| { | ||
| "overwritten_external_labels", | ||
| pcommon.NewResource(), | ||
| lbs1, | ||
| exlbs2, | ||
| []string{label31, value31, label32, value32}, | ||
| getPromLabelsV2(label11, value11, label12, value12, label31, value31, label32, value32), | ||
| }, | ||
| { | ||
| "colliding attributes", | ||
| pcommon.NewResource(), | ||
| lbsColliding, | ||
| nil, | ||
| []string{label31, value31, label32, value32}, | ||
| getPromLabelsV2(collidingSanitized, value11+";"+value12, label31, value31, label32, value32), | ||
| }, | ||
| { | ||
| "sanitize_labels_starts_with_underscore", | ||
| pcommon.NewResource(), | ||
| lbs3, | ||
| exlbs1, | ||
| []string{label31, value31, label32, value32}, | ||
| getPromLabelsV2(label11, value11, label12, value12, "key"+label51, value51, label41, value41, label31, value31, label32, value32), | ||
| }, | ||
| } | ||
| // run tests | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| res := createAttributesV2(tt.resource, tt.orig, tt.externalLabels, nil, true, tt.extras...) | ||
| assert.ElementsMatch(t, tt.want, res) | ||
| }) | ||
| } | ||
| } |
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
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
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
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
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
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
Oops, something went wrong.