forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: added prometheus rw2 translation for gauges (open-telemetry#35734)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Follow up from open-telemetry#35703. Draft starting the work on adding support for remote write 2.0 in the translation package. Adding support for translating gauges. This is first iteration and to keep the PR small * we don't handle duplicate metrics * only support gauges * don't handle other labels than metric name * don't handle exemplars * don't handle metadata <!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. --> #### Link to tracking issue open-telemetry#33661 Fixes <!--Describe what testing was performed and which tests were added.--> #### Testing <!--Describe the documentation added.--> #### Documentation <!--Please delete paragraphs that you did not use before submitting.--> --------- Signed-off-by: Juraj Michalek <[email protected]> Co-authored-by: Arthur Silva Sens <[email protected]> Co-authored-by: David Ashpole <[email protected]>
- Loading branch information
1 parent
cf68469
commit d6505c4
Showing
7 changed files
with
405 additions
and
10 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,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: pkg/translator/prometheusremotewrite | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: add FromMetricsV2 | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| issues: [33661] | ||
|
|
||
| # (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: The public function is partially implemented and not ready for use | ||
|
|
||
| # 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: [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
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
122 changes: 122 additions & 0 deletions
122
pkg/translator/prometheusremotewrite/metrics_to_prw_v2.go
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,122 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package prometheusremotewrite // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/prometheusremotewrite" | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "strconv" | ||
|
|
||
| "github.com/prometheus/prometheus/model/labels" | ||
| writev2 "github.com/prometheus/prometheus/prompb/io/prometheus/write/v2" | ||
| "go.opentelemetry.io/collector/pdata/pcommon" | ||
| "go.opentelemetry.io/collector/pdata/pmetric" | ||
| "go.uber.org/multierr" | ||
|
|
||
| prometheustranslator "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/prometheus" | ||
| ) | ||
|
|
||
| // FromMetricsV2 converts pmetric.Metrics to Prometheus remote write format 2.0. | ||
| func FromMetricsV2(md pmetric.Metrics, settings Settings) (map[string]*writev2.TimeSeries, writev2.SymbolsTable, error) { | ||
| c := newPrometheusConverterV2() | ||
| errs := c.fromMetrics(md, settings) | ||
| tss := c.timeSeries() | ||
| out := make(map[string]*writev2.TimeSeries, len(tss)) | ||
| for i := range tss { | ||
| out[strconv.Itoa(i)] = &tss[i] | ||
| } | ||
|
|
||
| return out, c.symbolTable, errs | ||
| } | ||
|
|
||
| // prometheusConverterV2 converts from OTLP to Prometheus write 2.0 format. | ||
| type prometheusConverterV2 struct { | ||
| // TODO handle conflicts | ||
| unique map[uint64]*writev2.TimeSeries | ||
| symbolTable writev2.SymbolsTable | ||
| } | ||
|
|
||
| func newPrometheusConverterV2() *prometheusConverterV2 { | ||
| return &prometheusConverterV2{ | ||
| unique: map[uint64]*writev2.TimeSeries{}, | ||
| symbolTable: writev2.NewSymbolTable(), | ||
| } | ||
| } | ||
|
|
||
| // fromMetrics converts pmetric.Metrics to Prometheus remote write format. | ||
| func (c *prometheusConverterV2) fromMetrics(md pmetric.Metrics, settings Settings) (errs error) { | ||
| resourceMetricsSlice := md.ResourceMetrics() | ||
| for i := 0; i < resourceMetricsSlice.Len(); i++ { | ||
| resourceMetrics := resourceMetricsSlice.At(i) | ||
| scopeMetricsSlice := resourceMetrics.ScopeMetrics() | ||
| // keep track of the most recent timestamp in the ResourceMetrics for | ||
| // use with the "target" info metric | ||
| var mostRecentTimestamp pcommon.Timestamp | ||
| for j := 0; j < scopeMetricsSlice.Len(); j++ { | ||
| metricSlice := scopeMetricsSlice.At(j).Metrics() | ||
|
|
||
| // TODO: decide if instrumentation library information should be exported as labels | ||
| for k := 0; k < metricSlice.Len(); k++ { | ||
| metric := metricSlice.At(k) | ||
| mostRecentTimestamp = maxTimestamp(mostRecentTimestamp, mostRecentTimestampInMetric(metric)) | ||
|
|
||
| if !isValidAggregationTemporality(metric) { | ||
| errs = multierr.Append(errs, fmt.Errorf("invalid temporality and type combination for metric %q", metric.Name())) | ||
| continue | ||
| } | ||
|
|
||
| promName := prometheustranslator.BuildCompliantName(metric, settings.Namespace, settings.AddMetricSuffixes) | ||
|
|
||
| // handle individual metrics based on type | ||
| //exhaustive:enforce | ||
| switch metric.Type() { | ||
| case pmetric.MetricTypeGauge: | ||
| dataPoints := metric.Gauge().DataPoints() | ||
| if dataPoints.Len() == 0 { | ||
| errs = multierr.Append(errs, fmt.Errorf("empty data points. %s is dropped", metric.Name())) | ||
| break | ||
| } | ||
| c.addGaugeNumberDataPoints(dataPoints, promName) | ||
| case pmetric.MetricTypeSum: | ||
| // TODO implement | ||
| case pmetric.MetricTypeHistogram: | ||
| // TODO implement | ||
| case pmetric.MetricTypeExponentialHistogram: | ||
| // TODO implement | ||
| case pmetric.MetricTypeSummary: | ||
| // TODO implement | ||
| default: | ||
| errs = multierr.Append(errs, errors.New("unsupported metric type")) | ||
| } | ||
| } | ||
| } | ||
| // TODO implement | ||
| // addResourceTargetInfov2(resource, settings, mostRecentTimestamp, c) | ||
| } | ||
|
|
||
| return | ||
| } | ||
|
|
||
| // timeSeries returns a slice of the writev2.TimeSeries that were converted from OTel format. | ||
| func (c *prometheusConverterV2) timeSeries() []writev2.TimeSeries { | ||
| allTS := make([]writev2.TimeSeries, 0, len(c.unique)) | ||
| for _, ts := range c.unique { | ||
| allTS = append(allTS, *ts) | ||
| } | ||
| return allTS | ||
| } | ||
|
|
||
| func (c *prometheusConverterV2) addSample(sample *writev2.Sample, lbls labels.Labels) *writev2.TimeSeries { | ||
| if sample == nil || len(lbls) == 0 { | ||
| // This shouldn't happen | ||
| return nil | ||
| } | ||
| ts := &writev2.TimeSeries{} | ||
| ts.LabelsRefs = c.symbolTable.SymbolizeLabels(lbls, ts.LabelsRefs) | ||
| ts.Samples = append(ts.Samples, *sample) | ||
|
|
||
| c.unique[lbls.Hash()] = ts | ||
|
|
||
| return ts | ||
| } |
44 changes: 44 additions & 0 deletions
44
pkg/translator/prometheusremotewrite/metrics_to_prw_v2_test.go
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,44 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package prometheusremotewrite | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| writev2 "github.com/prometheus/prometheus/prompb/io/prometheus/write/v2" | ||
| "github.com/stretchr/testify/require" | ||
| "go.opentelemetry.io/collector/pdata/pcommon" | ||
| ) | ||
|
|
||
| func TestFromMetricsV2(t *testing.T) { | ||
| settings := Settings{ | ||
| Namespace: "", | ||
| ExternalLabels: nil, | ||
| DisableTargetInfo: false, | ||
| ExportCreatedMetric: false, | ||
| AddMetricSuffixes: false, | ||
| SendMetadata: false, | ||
| } | ||
|
|
||
| ts := uint64(time.Now().UnixNano()) | ||
| payload := createExportRequest(5, 0, 1, 3, 0, pcommon.Timestamp(ts)) | ||
| want := func() map[string]*writev2.TimeSeries { | ||
| return map[string]*writev2.TimeSeries{ | ||
| "0": { | ||
| LabelsRefs: []uint32{1, 2}, | ||
| Samples: []writev2.Sample{ | ||
| {Timestamp: convertTimeStamp(pcommon.Timestamp(ts)), Value: 1.23}, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
| tsMap, symbolsTable, err := FromMetricsV2(payload.Metrics(), settings) | ||
| wanted := want() | ||
| require.NoError(t, err) | ||
| require.NotNil(t, tsMap) | ||
| require.Equal(t, wanted, tsMap) | ||
| require.NotNil(t, symbolsTable) | ||
|
|
||
| } |
43 changes: 43 additions & 0 deletions
43
pkg/translator/prometheusremotewrite/number_data_points_v2.go
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,43 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package prometheusremotewrite // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/prometheusremotewrite" | ||
|
|
||
| import ( | ||
| "math" | ||
|
|
||
| "github.com/prometheus/common/model" | ||
| "github.com/prometheus/prometheus/model/labels" | ||
| "github.com/prometheus/prometheus/model/value" | ||
| writev2 "github.com/prometheus/prometheus/prompb/io/prometheus/write/v2" | ||
| "go.opentelemetry.io/collector/pdata/pmetric" | ||
| ) | ||
|
|
||
| func (c *prometheusConverterV2) addGaugeNumberDataPoints(dataPoints pmetric.NumberDataPointSlice, name string) { | ||
| for x := 0; x < dataPoints.Len(); x++ { | ||
| pt := dataPoints.At(x) | ||
| // TODO implement support for labels | ||
|
|
||
| labels := labels.Labels{ | ||
| labels.Label{ | ||
| Name: model.MetricNameLabel, | ||
| Value: name, | ||
| }, | ||
| } | ||
|
|
||
| sample := &writev2.Sample{ | ||
| // convert ns to ms | ||
| Timestamp: convertTimeStamp(pt.Timestamp()), | ||
| } | ||
| switch pt.ValueType() { | ||
| case pmetric.NumberDataPointValueTypeInt: | ||
| sample.Value = float64(pt.IntValue()) | ||
| case pmetric.NumberDataPointValueTypeDouble: | ||
| sample.Value = pt.DoubleValue() | ||
| } | ||
| if pt.Flags().NoRecordedValue() { | ||
| sample.Value = math.Float64frombits(value.StaleNaN) | ||
| } | ||
| c.addSample(sample, labels) | ||
| } | ||
| } |
Oops, something went wrong.