Update configure-otel-collector.md: update recommendation for OTEL #9769
Conversation
… go through otlphttp
| {{% /admonition %}} | ||
|
|
||
| When using the [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/), you can write metrics into Mimir via two options: `prometheusremotewrite` and `otlphttp`. | ||
|
|
||
| We recommend using the `prometheusremotewrite` exporter when possible because the remote write ingest path is tested and proven at scale. | ||
| We recommend using each protocol's respective exporter and native Mimir endpoint: |
There was a problem hiding this comment.
| We recommend using each protocol's respective exporter and native Mimir endpoint: | |
| As a best practice, use each protocol's respective exporter, as well as the following Mimir endpoints: |
There was a problem hiding this comment.
I tried to clear this up a bit. LMK is the meaning is preserved, or if we should try something else.
There was a problem hiding this comment.
I would leave this as is. "We recommend" is the language we use elsewhere in the docs, and I think "Best Practice" implies that a lot more research and consensus than we want to imply here.
There was a problem hiding this comment.
also the endpoints aren't explicitly listed here, those names are for the exporters.
The endpoints are expanded on in each corresponding section below.
We could drop the bit about the endpoints completely, but saying "the following Mimir endpoints" would not make sense.
There was a problem hiding this comment.
Thanks for clarifying. Let's leave as it is 😄
|
|
||
| ## Remote Write | ||
| - Prometheus data through `prometheusremotewrite` |
There was a problem hiding this comment.
| - Prometheus data through `prometheusremotewrite` | |
| - For Prometheus data, `prometheusremotewrite` |
There was a problem hiding this comment.
I don't think bullet points need to be worded so close to a full proper sentence, starting it with a prepositional phrase. I do not see other examples of us taking this approach in the docs.
The word "through" could just be a colon if we want to shorten up
There was a problem hiding this comment.
Yea, let's make it a colon, it cleans it up a bit.
|
|
||
| ## Remote Write | ||
| - Prometheus data through `prometheusremotewrite` | ||
| - OTel data through `otlphttp` |
There was a problem hiding this comment.
| - OTel data through `otlphttp` | |
| - For OTel data, `otlphttp` |
... to go through otlphttp
What this PR does
Which issue(s) this PR fixes or relates to
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.