feat: UnitNamer API #35
Conversation
Which provides an API to translate units from OTel conventions to Prometheus conventions Signed-off-by: Arthur Silva Sens <[email protected]>
Signed-off-by: Arthur Silva Sens <[email protected]>
|
Some extra information: In the foreseeable future, I can also see a need for such an API once client_golang supports the exposure of Unit metadata (See old PR prometheus/client_golang#1392 that added such a feature but was rejected due to lack of use-cases). While it was rejected in the past, OTel-GO SDK and OTel Collector's Prometheus exporter will only be able to expose unit metadata once client_golang adds support for it. Second extra information: To make sure we have consistent APIs with MetricNamer and UnitNamer, I've updated our test to make sure that whatever is built from |
There was a problem hiding this comment.
Pull Request Overview
This PR introduces the UnitNamer API to assist in building compliant unit names separate from metric names when constructing metadata for Prometheus Remote Write exporters. Key changes include:
- Adding a new helper struct (UnitNamer) with its Build method in unit_namer.go.
- Refactoring unit mapping and cleanup functions out of metric_namer.go into unit_namer.go.
- Expanding test coverage in metric_namer_test.go to verify the correlation between metric names and unit names when suffixes are enabled.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| unit_namer.go | New file implementing UnitNamer and associated unit-processing functions. |
| metric_namer_test.go | Updated tests to validate both MetricNamer and UnitNamer functionality. |
| metric_namer.go | Removed redundant unit-processing functions, consolidating logic in UnitNamer. |
Comments suppressed due to low confidence (1)
unit_namer.go:106
- Ensure that the variable multipleUnderscoresRE is properly defined or imported within the package so that the cleanUpUnit function works as intended without runtime errors.
return strings.TrimPrefix(multipleUnderscoresRE.ReplaceAllString(
|
heads up @ywwg, this PR is blocking adoption in otel-collector. No need to rush here, but I'd like to proceed at some point 😇 |
| @@ -138,7 +138,8 @@ func TestMetricNamer_Build(t *testing.T) { | |||
| Unit: "", | |||
| Type: MetricTypeGauge, | |||
| }, | |||
| expected: "test@namespace_metric", // TODO: should be "test_namespace_metric" | |||
| expectedMetricName: "test@namespace_metric", // TODO: should be "test_namespace_metric" | |||
There was a problem hiding this comment.
No, I don't think we have!
This PR adds the helper struct
UnitNamer, which follows fundamentals similar toMetricNamerandLabelNamer.When building metadata information, for example:
The unit information is sent separately from the metric name, and that's when this API will be useful.