-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
[AlibabaCloudLogService] sanitize labels for metrics #3454
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
---|---|---|
|
@@ -51,9 +51,13 @@ func (kv *KeyValues) Swap(i, j int) { | |
kv.keyValues[i], kv.keyValues[j] = kv.keyValues[j], kv.keyValues[i] | ||
} | ||
func (kv *KeyValues) Less(i, j int) bool { return kv.keyValues[i].Key < kv.keyValues[j].Key } | ||
func (kv *KeyValues) Sort() { sort.Sort(kv) } | ||
|
||
func (kv *KeyValues) Sort() { | ||
sort.Sort(kv) | ||
} | ||
|
||
func (kv *KeyValues) Replace(key, value string) { | ||
key = sanitize(key) | ||
findIndex := sort.Search(len(kv.keyValues), func(index int) bool { | ||
return kv.keyValues[index].Key >= key | ||
}) | ||
|
@@ -64,6 +68,7 @@ func (kv *KeyValues) Replace(key, value string) { | |
|
||
func (kv *KeyValues) AppendMap(mapVal map[string]string) { | ||
for key, value := range mapVal { | ||
key = sanitize(key) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It looks like you can replace these 5 lines with calling the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, AppendMap can call Append directly |
||
kv.keyValues = append(kv.keyValues, KeyValue{ | ||
Key: key, | ||
Value: value, | ||
|
@@ -72,6 +77,7 @@ func (kv *KeyValues) AppendMap(mapVal map[string]string) { | |
} | ||
|
||
func (kv *KeyValues) Append(key, value string) { | ||
key = sanitize(key) | ||
kv.keyValues = append(kv.keyValues, KeyValue{ | ||
key, | ||
value, | ||
|
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,52 @@ | ||
// Copyright 2020, OpenTelemetry Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package alibabacloudlogserviceexporter | ||
|
||
import ( | ||
"strings" | ||
"unicode" | ||
) | ||
|
||
// The code for sanitize is mostly copied from: | ||
// https://github.com/open-telemetry/opentelemetry-collector/blob/2e84285efc665798d76773b9901727e8836e9d8f/exporter/prometheusexporter/sanitize.go | ||
|
||
// sanitize replaces non-alphanumeric characters with underscores in s. | ||
func sanitize(s string) string { | ||
if len(s) == 0 { | ||
return s | ||
} | ||
|
||
// Note: No length limit for label keys because Prometheus doesn't | ||
// define a length limit, thus we should NOT be truncating label keys. | ||
// See https://github.com/orijtech/prometheus-go-metrics-exporter/issues/4. | ||
|
||
s = strings.Map(sanitizeRune, s) | ||
if unicode.IsDigit(rune(s[0])) { | ||
s = "key_" + s | ||
} | ||
if s[0] == '_' { | ||
s = "key" + s | ||
} | ||
return s | ||
} | ||
|
||
// converts anything that is not a letter or digit to an underscore | ||
func sanitizeRune(r rune) rune { | ||
if unicode.IsLetter(r) || unicode.IsDigit(r) { | ||
return r | ||
} | ||
// Everything else turns into an underscore | ||
return '_' | ||
} |
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,32 @@ | ||
// Copyright 2020, OpenTelemetry Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package alibabacloudlogserviceexporter | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
// The code for sanitize is mostly copied from: | ||
// https://github.com/open-telemetry/opentelemetry-collector/blob/2e84285efc665798d76773b9901727e8836e9d8f/exporter/prometheusexporter/sanitize_test.go | ||
|
||
func TestSanitize(t *testing.T) { | ||
require.Equal(t, "", sanitize(""), "") | ||
require.Equal(t, "key_test", sanitize("_test")) | ||
require.Equal(t, "key_0test", sanitize("0test")) | ||
require.Equal(t, "test", sanitize("test")) | ||
require.Equal(t, "test__", sanitize("test_/")) | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add unit tests for this file to demonstrate the sanitization?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done