influxdata / influxdata/telegraf

Add metrics metadata to prometheus remote write payload

Open
#9,149 2 comments 0 reactions 0 assignees View on GitHub
area/prometheus feature request
Dominant language
Go
Stars
17.8k
Forks
5.8k
Avg merge
1d 20h
Merged PRs (30d)
161

Description

## Feature Request
Send metric metadata to prometheus remote write

### Proposal:
Periodically send metric metadata to prometheus remote write endpoint.

### Current behavior:
The current serializer for prometheus remote write handles only the Timeseries data and does not send the metric metadata.
https://github.com/influxdata/telegraf/blob/master/plugins/serializers/prometheusremotewrite/prometheusremotewrite.go#L239

### Desired behavior:
A new option that specifies the interval of sending Metadata for Timeseries needs to be added to prometheus remote write config. If this option is configured, telegraf should add the metadata to prompb payload while sending the metrics to prometheus remote write endpoint.

### Use case:
In some of the monitoring tools (e.g Instana), metrics ingestion through prometheus remote write cannot be performed unless the metric metadata is transmitted along with the timeseries.

Contributor guide

Open the contributing guide

Research direction

Start in plugins/serializers/prometheusremotewrite/prometheusremotewrite.go at the current serializer implementation around line 239. Trace how Timeseries data becomes the prompb payload, then determine how the proposed configurable metadata interval should control metadata transmission. Done means configured remote-write payloads include metric metadata at the requested interval without changing the existing timeseries behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.