-
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
Translate unit from words to UCUM in the prometheus receiver #25887
Merged
dmitryax
merged 2 commits into
open-telemetry:main
from
dashpole:receiver_unit_translation
Aug 22, 2023
Merged
Changes from all commits
Commits
Show all changes
2 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 |
|---|---|---|
| @@ -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: enhancement | ||
|
|
||
| # The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) | ||
| component: receiver/prometheus | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: translate units from prometheus to UCUM | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| issues: [23208] | ||
|
|
||
| # (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: [user, api] |
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,90 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package prometheus // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/prometheus" | ||
|
|
||
| import "strings" | ||
|
|
||
| var wordToUCUM = map[string]string{ | ||
|
|
||
| // Time | ||
| "days": "d", | ||
| "hours": "h", | ||
| "minutes": "min", | ||
| "seconds": "s", | ||
| "milliseconds": "ms", | ||
| "microseconds": "us", | ||
| "nanoseconds": "ns", | ||
|
|
||
| // Bytes | ||
| "bytes": "By", | ||
| "kibibytes": "KiBy", | ||
| "mebibytes": "MiBy", | ||
| "gibibytes": "GiBy", | ||
| "tibibytes": "TiBy", | ||
| "kilobytes": "KBy", | ||
| "megabytes": "MBy", | ||
| "gigabytes": "GBy", | ||
| "terabytes": "TBy", | ||
|
|
||
| // SI | ||
| "meters": "m", | ||
| "volts": "V", | ||
| "amperes": "A", | ||
| "joules": "J", | ||
| "watts": "W", | ||
| "grams": "g", | ||
|
|
||
| // Misc | ||
| "celsius": "Cel", | ||
| "hertz": "Hz", | ||
| "ratio": "1", | ||
| "percent": "%", | ||
| } | ||
|
|
||
| // The map that translates the "per" unit | ||
| // Example: per_second (singular) => /s | ||
| var perWordToUCUM = map[string]string{ | ||
| "second": "s", | ||
| "minute": "m", | ||
| "hour": "h", | ||
| "day": "d", | ||
| "week": "w", | ||
| "month": "mo", | ||
| "year": "y", | ||
| } | ||
|
|
||
| // UnitWordToUCUM converts english unit words to UCUM units: | ||
| // https://ucum.org/ucum#section-Alphabetic-Index-By-Symbol | ||
| // It also handles rates, such as meters_per_second, by translating the first | ||
| // word to UCUM, and the "per" word to UCUM. It joins them with a "/" between. | ||
| func UnitWordToUCUM(unit string) string { | ||
| unitTokens := strings.SplitN(unit, "_per_", 2) | ||
| if len(unitTokens) == 0 { | ||
| return "" | ||
| } | ||
| ucumUnit := wordToUCUMOrDefault(unitTokens[0]) | ||
| if len(unitTokens) > 1 && unitTokens[1] != "" { | ||
| ucumUnit += "/" + perWordToUCUMOrDefault(unitTokens[1]) | ||
| } | ||
| return ucumUnit | ||
| } | ||
|
|
||
| // wordToUCUMOrDefault retrieves the Prometheus "basic" unit corresponding to | ||
| // the specified "basic" unit. Returns the specified unit if not found in | ||
| // wordToUCUM. | ||
| func wordToUCUMOrDefault(unit string) string { | ||
| if promUnit, ok := wordToUCUM[unit]; ok { | ||
| return promUnit | ||
| } | ||
| return unit | ||
| } | ||
|
|
||
| // perWordToUCUMOrDefault retrieve the Prometheus "per" unit corresponding to | ||
| // the specified "per" unit. Returns the specified unit if not found in perWordToUCUM. | ||
| func perWordToUCUMOrDefault(perUnit string) string { | ||
| if promPerUnit, ok := perWordToUCUM[perUnit]; ok { | ||
| return promPerUnit | ||
| } | ||
| return perUnit | ||
| } | ||
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,61 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package prometheus // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/prometheus" | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestUnitWordToUCUM(t *testing.T) { | ||
| for _, tc := range []struct { | ||
| input string | ||
| expected string | ||
| }{ | ||
| { | ||
| input: "", | ||
| expected: "", | ||
| }, | ||
| { | ||
| input: "days", | ||
| expected: "d", | ||
| }, | ||
| { | ||
| input: "seconds", | ||
| expected: "s", | ||
| }, | ||
| { | ||
| input: "kibibytes", | ||
| expected: "KiBy", | ||
| }, | ||
| { | ||
| input: "volts", | ||
| expected: "V", | ||
| }, | ||
| { | ||
| input: "bananas_per_day", | ||
| expected: "bananas/d", | ||
| }, | ||
| { | ||
| input: "meters_per_hour", | ||
| expected: "m/h", | ||
| }, | ||
| { | ||
| input: "ratio", | ||
| expected: "1", | ||
| }, | ||
| { | ||
| input: "percent", | ||
| expected: "%", | ||
| }, | ||
| } { | ||
| t.Run(fmt.Sprintf("input: \"%v\"", tc.input), func(t *testing.T) { | ||
| got := UnitWordToUCUM(tc.input) | ||
| assert.Equal(t, tc.expected, got) | ||
| }) | ||
| } | ||
|
|
||
| } |
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.
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.
Should we add
dollaras documented in https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/pkg/translator/prometheus#metric-name?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.
I should remove that from the documentation. Dollar ($) isn't UCUM.