From 84f158779589347275cddcd61f559a07a8be4fb8 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Thu, 20 Nov 2025 18:09:38 +0100 Subject: [PATCH] OBSDOCS-2778: Add docs for Prometheus Remote Write Receiver --- ...vers-prometheus-remote-write-receiver.adoc | 55 +++++++++++++++++++ .../otel-collector-receivers.adoc | 2 + 2 files changed, 57 insertions(+) create mode 100644 modules/otel-receivers-prometheus-remote-write-receiver.adoc diff --git a/modules/otel-receivers-prometheus-remote-write-receiver.adoc b/modules/otel-receivers-prometheus-remote-write-receiver.adoc new file mode 100644 index 000000000000..1098d15f1c37 --- /dev/null +++ b/modules/otel-receivers-prometheus-remote-write-receiver.adoc @@ -0,0 +1,55 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-collector/otel-collector-receivers.adoc + +:_mod-docs-content-type: REFERENCE +[id="otel-receivers-prometheus-remote-write-receiver_{context}"] += Prometheus Remote Write Receiver + +[role="_abstract"] +The Prometheus Remote Write Receiver receives metrics from Prometheus via the Remote Write protocol and converts them to the OpenTelemetry format. This receiver supports only the Prometheus Remote Write v2 protocol. + +:FeatureName: The Prometheus Remote Write Receiver +include::snippets/technology-preview.adoc[] + +.OpenTelemetry Collector custom resource with the enabled Prometheus Remote Write Receiver +[source,yaml] +---- +# ... + config: + receivers: + prometheusremotewrite: + endpoint: 0.0.0.0:9009 # <1> + service: + pipelines: + metrics: + receivers: [prometheusremotewrite] +# ... +---- +<1> The endpoint where the receiver listens for Prometheus Remote Write requests. + +The following are the prerequisites for using the Prometheus Remote Write Receiver with Prometheus: + +* Prometheus is started with the metadata WAL records feature flag enabled: ++ +[source,yaml] +---- +./prometheus --config.file config.yml --enable-feature=metadata-wal-records +---- + +* Prometheus Remote Write v2 Protocol is enabled in the Prometheus configuration file: ++ +[source,yaml] +---- +remote_write: + - url: "" + protobuf_message: io.prometheus.write.v2.Request +---- + +* Native histograms are enabled in Prometheus. For more information about enabling native histograms in Prometheus, see the Prometheus documentation. + +[role="_additional-resources"] +.Additional resources +* link:https://prometheus.io/docs/prometheus/latest/feature_flags/#metadata-wal-records[Metadata WAL Records] +* link:https://prometheus.io/docs/specs/prw/remote_write_spec_2_0/[Prometheus Remote-Write 2.0 specification [EXPERIMENTAL]] +* link:https://prometheus.io/docs/specs/native_histograms/[Native Histograms] diff --git a/observability/otel/otel-collector/otel-collector-receivers.adoc b/observability/otel/otel-collector/otel-collector-receivers.adoc index 9ecb1c4a1f04..85fe11010d04 100644 --- a/observability/otel/otel-collector/otel-collector-receivers.adoc +++ b/observability/otel/otel-collector/otel-collector-receivers.adoc @@ -39,6 +39,8 @@ include::modules/otel-receivers-journald-receiver.adoc[leveloffset=+1] include::modules/otel-receivers-kubernetesevents-receiver.adoc[leveloffset=+1] +include::modules/otel-receivers-prometheus-remote-write-receiver.adoc[leveloffset=+1] + [id="additional-resources_{context}"] [role="_additional-resources"] == Additional resources