mimir icon indicating copy to clipboard operation
mimir copied to clipboard

Docs: document how remote write API works

Open pracucci opened this issue 3 years ago • 3 comments

We're seeing some people asking how they can build custom clients to write metrics to Mimir. There's foundamentally a lack of information on how the remote write API works in our documentation. We should explain:

  • Purpose of the remote write API
  • The request body format
  • Link a reference implementation (e.g. in golang we could show https://github.com/grafana/mimir/blob/29142fc7ae465e31478483d818048070143ee688/pkg/continuoustest/client.go#L176)
  • Write proxies (e.g. https://github.com/grafana/influx2cortex/) as an alternative to easily remote write to Mimir using simpler protocols

pracucci avatar Jun 09 '22 06:06 pracucci

Who are the SMEs (subject matter experts) for this topic?

osg-grafana avatar Jun 15 '22 10:06 osg-grafana

Has any SME been able to work on this? I have been trying to send data via curl, but not sure if it is even possible with just curl alone.

huy7070 avatar Jul 20 '22 15:07 huy7070

No, not practically. The remote-write payload is a protobuf object which needs to be serialized.

LeviHarrison avatar Aug 05 '22 20:08 LeviHarrison