-
Notifications
You must be signed in to change notification settings - Fork 535
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
Docs/support escalations 11817 #9907
base: main
Are you sure you want to change the base?
Conversation
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.
We're almost there, let me know what you think about my comments.
@@ -13,103 +13,103 @@ weight: 150 | |||
To send OTel data to Grafana Cloud, refer to [Send data using OpenTelemetry Protocol (OTLP)](https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/). | |||
{{% /admonition %}} | |||
|
|||
When using the [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/), you can write metrics into Mimir via two options: `prometheusremotewrite` and `otlphttp`. | |||
When using the [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/), you can write metrics into Mimir using two options: `otlphttp` (preferred) and `prometheusremotewrite`. |
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.
I think we should say here we recommend the usage of otlphttp.
The reason why we recommend this is because the exporter is maintained by the community and always up to date with the spec. It's the official way of sending OTLP traffic and we want to recommend the more native path.
Prometheus Remote Write is an exporter in the https://github.com/open-telemetry/opentelemetry-collector-contrib repository donated by the community that is in beta
stage https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/prometheusremotewriteexporter
We strongly recommend otlphttp. We can leave the example at the bottom of prometheusremotewrite as an experimental section.
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.
I'll rework the doc a bit to more strongly favor otlphttp over prometheus remote write.
prometheusremotewrite: | ||
endpoint: http://<mimir-endpoint>/api/v1/push | ||
otlphttp: | ||
endpoint: http://<mimir-endpoint>/otlp |
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.
This differs between grafana cloud and OSS mimir.
If its OSS mimir this is correct.
If its Grafana Cloud we want the users to write to the otlp-endpoint/otlp check this doc for context https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/
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.
Thanks for the additional details. Since these are the Mimir docs, is it fair to assume that folks are using Mimir and not Grafana Cloud here?
cc @aknuds1 in case you'd like to review this one 🙏 |
What this PR does
This PR updates https://grafana.com/docs/mimir/next/configure/configure-otel-collector/ to explicitly recommend using the OTLP exporter, when possible, for sending OTLP data to Mimir.
Which issue(s) this PR fixes or relates to
Fixes https://github.com/grafana/support-escalations/issues/11817
Checklist
CHANGELOG.md
updated - the order of entries should be[CHANGE]
,[FEATURE]
,[ENHANCEMENT]
,[BUGFIX]
.about-versioning.md
updated with experimental features.