-
Notifications
You must be signed in to change notification settings - Fork 50
Document managed PRW support on ECH #655
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
zmoog
wants to merge
2
commits into
elastic:main
Choose a base branch
from
zmoog:docs/prw-ech-rollout
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.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -5,8 +5,11 @@ applies_to: | |||||||||
| serverless: | ||||||||||
| observability: ga | ||||||||||
| security: ga | ||||||||||
| deployment: | ||||||||||
| ech: ga | ||||||||||
| products: | ||||||||||
| - id: cloud-serverless | ||||||||||
| - id: cloud-hosted | ||||||||||
| - id: observability | ||||||||||
| --- | ||||||||||
|
|
||||||||||
|
|
@@ -16,21 +19,21 @@ The Managed Prometheus Remote Write endpoint ingests metrics sent in the [Promet | |||||||||
|
|
||||||||||
| ## When to use the Managed Prometheus Remote Write endpoint | ||||||||||
|
|
||||||||||
| For {{serverless-full}} projects, the Managed Prometheus Remote Write endpoint is the recommended way to ingest Prometheus metrics. Compared to sending metrics directly to the [{{es}} Prometheus Remote Write endpoint](docs-content://manage-data/data-store/data-streams/tsds-ingest-prometheus-remote-write.md), it provides: | ||||||||||
| For {{serverless-full}} projects and {{ech}} deployments, the Managed Prometheus Remote Write endpoint is the recommended way to ingest Prometheus metrics. Compared to sending metrics directly to the [{{es}} Prometheus Remote Write endpoint](docs-content://manage-data/data-store/data-streams/tsds-ingest-prometheus-remote-write.md), it provides: | ||||||||||
|
|
||||||||||
| - A single ingest endpoint and API key shared with the other [managed inputs](index.md). | ||||||||||
| - Durable buffering, back-pressure, and retry on `429 Too Many Requests`. | ||||||||||
| - The same Prometheus-to-TSDS mapping as the {{es}} PRW endpoint, so the resulting data is identical. | ||||||||||
|
|
||||||||||
| :::{warning} | ||||||||||
| On {{serverless-full}}, use the Managed Prometheus Remote Write endpoint rather than sending metrics directly to the [{{es}} Prometheus Remote Write endpoint](docs-content://manage-data/data-store/data-streams/tsds-ingest-prometheus-remote-write.md). | ||||||||||
| On {{serverless-full}} and {{ech}}, use the Managed Prometheus Remote Write endpoint rather than sending metrics directly to the [{{es}} Prometheus Remote Write endpoint](docs-content://manage-data/data-store/data-streams/tsds-ingest-prometheus-remote-write.md). | ||||||||||
|
|
||||||||||
| Direct ingest bypasses managed inputs and has no buffering or processing before data reaches {{es}}. It also authenticates differently: the direct {{es}} endpoint uses {{es}} credentials or an API key with index privileges, while the Managed Prometheus Remote Write endpoint uses an API key with the `event:write` privilege for the `apm` application. Use the direct {{es}} endpoint only for self-managed deployments, where managed inputs aren't available. {{ech}} support for the Managed Prometheus Remote Write endpoint is planned. | ||||||||||
| Direct ingest bypasses managed inputs and has no buffering or processing before data reaches {{es}}. It also authenticates differently: the direct {{es}} endpoint uses {{es}} credentials or an API key with index privileges, while the Managed Prometheus Remote Write endpoint uses an API key with the `event:write` privilege for the `apm` application. Use the direct {{es}} endpoint only for self-managed deployments, where managed inputs aren't available. | ||||||||||
| ::: | ||||||||||
|
|
||||||||||
| ## Prerequisites | ||||||||||
|
|
||||||||||
| - An {{serverless-full}} Observability or Security project. | ||||||||||
| - An {{serverless-full}} Observability or Security project, or an {{ech}} deployment. | ||||||||||
|
Member
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. If there is a minimum stack version required for the ECH deployment, I'd propose something like this. Ignore if there is no specific version required:
Suggested change
For example if the min version is 9.6 ^^ |
||||||||||
| - An API key with the `event:write` privilege for the `apm` application. Refer to [Authentication](authentication-delivery-and-failure-handling.md#authentication) for the required key format and generation steps. | ||||||||||
|
|
||||||||||
| ## Send Prometheus metrics through managed inputs | ||||||||||
|
|
@@ -54,7 +57,9 @@ remote_write: | |||||||||
| To find `<prometheus-endpoint>`: | ||||||||||
|
|
||||||||||
| 1. Log in to the {{ecloud}} Console. | ||||||||||
| 2. Find your project and select **Manage**. | ||||||||||
| 2. Do one of the following: | ||||||||||
| - **{{serverless-full}}**: Find your project and select **Manage**. | ||||||||||
| - **{{ech}}**: Find your deployment in **Hosted deployments** and select **Manage**. | ||||||||||
| 3. In the **Application endpoints, cluster and component IDs** section, select **Prometheus**. | ||||||||||
| 4. Copy the **Prometheus** endpoint value, which looks similar to `https://<project>.ingest.<region>.<csp>.elastic.cloud/api/v1/write` | ||||||||||
|
|
||||||||||
|
|
@@ -110,5 +115,4 @@ For back-pressure and `429` responses, refer to [Managed inputs rate limiting](r | |||||||||
| ## Limitations | ||||||||||
|
|
||||||||||
| - URL-path routing (for example, `/_prometheus/metrics/{dataset}/api/v1/write`) to custom data streams is not supported through managed inputs. Use [label-based routing](docs-content://manage-data/data-store/data-streams/tsds-ingest-prometheus-remote-write.md#route-by-labels) instead. | ||||||||||
| - Available on {{serverless-full}} only. | ||||||||||
| - Samples with non-finite values (NaN, Infinity) are silently dropped by {{es}}, and staleness markers are not supported. | ||||||||||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.