-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OBSDOCS-2778: Add docs for Prometheus Remote Write Receiver #102819
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
max-cx
wants to merge
1
commit into
openshift:main
Choose a base branch
from
max-cx:OBSDOCS-2778
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+57
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
55 changes: 55 additions & 0 deletions
55
modules/otel-receivers-prometheus-remote-write-receiver.adoc
This file contains hidden or 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,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. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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] | ||
This file contains hidden or 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
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.
🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.