Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions modules/otel-receivers-prometheus-remote-write-receiver.adoc
Original file line number Diff line number Diff line change
@@ -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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.

[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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.


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: "<your_chosen_prometheus_remote_write_receiver_endpoint>"
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]
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down