[receiver/prometheusremotewrite] Parse labels #35656
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/prometheusremotewrite | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Parse labels from Prometheus Remote Write requests into Resource and Scope Attributes | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| issues: [35656] | ||
|
|
||
| # (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: Warning - The HTTP Server still doesn't pass metrics to the next consumer. The component is unusable for now. | ||
|
|
||
| # 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, user] | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,21 +14,24 @@ import ( | |
|
|
||
| "github.com/gogo/protobuf/proto" | ||
| promconfig "github.com/prometheus/prometheus/config" | ||
| "github.com/prometheus/prometheus/model/labels" | ||
| writev2 "github.com/prometheus/prometheus/prompb/io/prometheus/write/v2" | ||
| promremote "github.com/prometheus/prometheus/storage/remote" | ||
| "go.opentelemetry.io/collector/component" | ||
| "go.opentelemetry.io/collector/component/componentstatus" | ||
| "go.opentelemetry.io/collector/consumer" | ||
| "go.opentelemetry.io/collector/pdata/pcommon" | ||
| "go.opentelemetry.io/collector/pdata/pmetric" | ||
| "go.opentelemetry.io/collector/receiver" | ||
| "go.uber.org/zap/zapcore" | ||
| ) | ||
|
|
||
| func newRemoteWriteReceiver(settings receiver.Settings, cfg *Config, nextConsumer consumer.Metrics) (receiver.Metrics, error) { | ||
| return &prometheusRemoteWriteReceiver{ | ||
| settings: settings, | ||
| nextConsumer: nextConsumer, | ||
| config: cfg, | ||
| jobInstanceCache: make(map[string]pmetric.ResourceMetrics), | ||
| server: &http.Server{ | ||
| ReadTimeout: 60 * time.Second, | ||
| }, | ||
|
|
@@ -39,8 +42,9 @@ type prometheusRemoteWriteReceiver struct { | |
| settings receiver.Settings | ||
| nextConsumer consumer.Metrics | ||
|
|
||
| jobInstanceCache map[string]pmetric.ResourceMetrics | ||
|
There was a problem hiding this comment. consider using an int64 as the key for this cache, and constructing an identifier using xxhash, similar to what prometheus translation does: https://github.com/prometheus/prometheus/blob/0f0deb77a2f15383914ad60a3309281adb7e8b27/storage/remote/otlptranslator/prometheusremotewrite/helper.go#L94 You can just append the job, a separator, and then the instance. There was a problem hiding this comment. Do we have any mechanism to expire items in this cache? We don't want this to leak memory. Actually, i'm not sure we should be storing the job + instance cache on the receiver itself. We probably want this cache around for a single PRW request, right? Otherwise, we will keep appending new metrics to the same resourceMetrics forever. |
||
| config *Config | ||
| server *http.Server | ||
| } | ||
|
|
||
| func (prw *prometheusRemoteWriteReceiver) Start(ctx context.Context, host component.Host) error { | ||
|
|
@@ -150,8 +154,105 @@ func (prw *prometheusRemoteWriteReceiver) parseProto(contentType string) (promco | |
| } | ||
|
|
||
| // translateV2 translates a v2 remote-write request into OTLP metrics. | ||
| // translate is not feature complete. | ||
| // nolint | ||
| func (prw *prometheusRemoteWriteReceiver) translateV2(_ context.Context, req *writev2.Request) (pmetric.Metrics, promremote.WriteResponseStats, error) { | ||
| var ( | ||
| badRequestErrors []error | ||
|
There was a problem hiding this comment. can we just use a single error, and use errors.Join to append new errors? e.g. var err error
// then, when we want to append an error:
err = errors.Join(err, fmt.Errorf("missing metric name in labels")) |
||
| otelMetrics = pmetric.NewMetrics() | ||
| b = labels.NewScratchBuilder(0) | ||
|
There was a problem hiding this comment. nit: can we use a more descriptive name? Perhaps labelsBuilder? |
||
| stats = promremote.WriteResponseStats{} | ||
| ) | ||
|
|
||
| for _, ts := range req.Timeseries { | ||
| ls := ts.ToLabels(&b, req.Symbols) | ||
|
|
||
| if !ls.Has(labels.MetricName) { | ||
| badRequestErrors = append(badRequestErrors, fmt.Errorf("missing metric name in labels")) | ||
| continue | ||
| } else if duplicateLabel, hasDuplicate := ls.HasDuplicateLabelNames(); hasDuplicate { | ||
| badRequestErrors = append(badRequestErrors, fmt.Errorf("duplicate label %q in labels", duplicateLabel)) | ||
| continue | ||
| } | ||
|
|
||
| var rm pmetric.ResourceMetrics | ||
| // This cache should be populated by the metric 'target_info', but we're not handling it yet. | ||
| cacheEntry, ok := prw.jobInstanceCache[ls.Get("instance")+ls.Get("job")] | ||
| if ok { | ||
| rm = pmetric.NewResourceMetrics() | ||
| cacheEntry.CopyTo(rm) | ||
| } else { | ||
| // A remote-write request can have multiple timeseries with the same instance and job labels. | ||
| // While they are different timeseries in Prometheus, we're handling it as the same OTLP metric | ||
| // until we support 'target_info'. | ||
| rm = otelMetrics.ResourceMetrics().AppendEmpty() | ||
| parseJobAndInstance(rm.Resource().Attributes(), ls.Get("instance"), ls.Get("job")) | ||
| prw.jobInstanceCache[ls.Get("instance")+ls.Get("job")] = rm | ||
| } | ||
|
|
||
| switch ts.Metadata.Type { | ||
| case writev2.Metadata_METRIC_TYPE_COUNTER: | ||
| addCounterDatapoints(rm, ls, ts) | ||
| case writev2.Metadata_METRIC_TYPE_GAUGE: | ||
| addGaugeDatapoints(rm, ls, ts) | ||
| case writev2.Metadata_METRIC_TYPE_SUMMARY: | ||
| addSummaryDatapoints(rm, ls, ts) | ||
| case writev2.Metadata_METRIC_TYPE_HISTOGRAM: | ||
| addHistogramDatapoints(rm, ls, ts) | ||
| default: | ||
| badRequestErrors = append(badRequestErrors, fmt.Errorf("unsupported metric type %q for metric %q", ts.Metadata.Type, ls.Get(labels.MetricName))) | ||
| } | ||
| } | ||
|
|
||
| return otelMetrics, stats, errors.Join(badRequestErrors...) | ||
| } | ||
|
|
||
| // parseJobAndInstance turns the job and instance labels service resource attributes. | ||
| // Following the specification at https://opentelemetry.io/docs/specs/otel/compatibility/prometheus_and_openmetrics/ | ||
| func parseJobAndInstance(dest pcommon.Map, instance, job string) { | ||
| if job != "" { | ||
| dest.PutStr("service.namespace", job) | ||
|
There was a problem hiding this comment. Job should be service.name + "/" + service.namespace. Instance is only service.instance.id. You need to move |
||
| } | ||
| if instance != "" { | ||
| parts := strings.Split(instance, "/") | ||
| if len(parts) == 2 { | ||
| dest.PutStr("service.name", parts[0]) | ||
| dest.PutStr("service.instance.id", parts[1]) | ||
| return | ||
| } | ||
| dest.PutStr("service.name", instance) | ||
| } | ||
| } | ||
|
|
||
| func addCounterDatapoints(_ pmetric.ResourceMetrics, _ labels.Labels, _ writev2.TimeSeries) { | ||
| // TODO: Implement this function | ||
| } | ||
|
|
||
| func addGaugeDatapoints(rm pmetric.ResourceMetrics, ls labels.Labels, ts writev2.TimeSeries) { | ||
| m := rm.ScopeMetrics().AppendEmpty().Metrics().AppendEmpty().SetEmptyGauge() | ||
| addDatapoints(m.DataPoints(), ls, ts) | ||
| } | ||
|
|
||
| func addSummaryDatapoints(_ pmetric.ResourceMetrics, _ labels.Labels, _ writev2.TimeSeries) { | ||
| // TODO: Implement this function | ||
| } | ||
|
|
||
| func addHistogramDatapoints(_ pmetric.ResourceMetrics, _ labels.Labels, _ writev2.TimeSeries) { | ||
| // TODO: Implement this function | ||
| } | ||
|
|
||
| // addDatapoints adds the labels to the datapoints attributes. | ||
| // TODO: We're still not handling several fields that make a datapoint complete, e.g. StartTimestamp, | ||
| // Timestamp, Value, etc. | ||
| func addDatapoints(datapoints pmetric.NumberDataPointSlice, ls labels.Labels, _ writev2.TimeSeries) { | ||
| attributes := datapoints.AppendEmpty().Attributes() | ||
|
|
||
| for _, l := range ls { | ||
| if l.Name == "instance" || l.Name == "job" || // Become resource attributes "service.name", "service.instance.id" and "service.namespace" | ||
| l.Name == labels.MetricName || // Becomes metric name | ||
| l.Name == "otel_scope_name" || l.Name == "otel_scope_version" { // Becomes scope name and version | ||
| continue | ||
| } | ||
| attributes.PutStr(l.Name, l.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
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.
I don't see any changes to the public API of the package.