Skip to content
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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

tacole02
Copy link
Contributor

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

  • Tests updated.
  • Documentation added.
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX].
  • about-versioning.md updated with experimental features.

@tacole02 tacole02 requested a review from a team as a code owner November 14, 2024 18:13
@tacole02 tacole02 self-assigned this Nov 14, 2024
@tacole02 tacole02 added the type/docs Improvements or additions to documentation label Nov 14, 2024
Copy link
Member

@jesusvazquez jesusvazquez left a 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`.
Copy link
Member

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.

Copy link
Contributor Author

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.

@jesusvazquez
Copy link
Member

cc @aknuds1 in case you'd like to review this one 🙏

@tacole02
Copy link
Contributor Author

@jesusvazquez I've updated the doc to strongly recommend OTLP and to mark Prometheus remote write as experimental. LMK what you think!

Copy link
Member

@jesusvazquez jesusvazquez left a comment

Choose a reason for hiding this comment

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

LGTM @tacole02 !

@tacole02
Copy link
Contributor Author

Thank you so much for you input, @jesusvazquez !

Copy link
Contributor

@aknuds1 aknuds1 left a comment

Choose a reason for hiding this comment

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

Please see comments.

docs/sources/mimir/configure/configure-otel-collector.md Outdated Show resolved Hide resolved

Mimir supports native OTLP over HTTP. To configure the collector to use the OTLP interface, you use the [`otlphttp`](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlphttpexporter) exporter:
{{< admonition type="note" >}}
Support for the Prometheus remote write protocol is an experimental feature in Mimir.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do you think Prometheus remote write support is experimental in Mimir?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I marked Prometheus remote write support as experimental based on @jesusvazquez 's suggestion above:

We strongly recommend otlphttp. We can leave the example at the bottom of prometheusremotewrite as an experimental section.

Let me know if this is not the case. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants