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

updates doc on otel resource attributes promoted to labels #10685

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

tacole02
Copy link
Contributor

@tacole02 tacole02 commented Feb 19, 2025

What this PR does

This PR adds documentation for OTel resource attributes being automatically promoted to labels in Mimir.

Which issue(s) this PR fixes or relates to

Fixes https://github.com/grafana/mimir-squad/issues/2727

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 self-assigned this Feb 19, 2025
Copy link
Contributor

github-actions bot commented Feb 19, 2025

@tacole02 tacole02 added the type/docs Improvements or additions to documentation label Feb 19, 2025
@tacole02
Copy link
Contributor Author

Here's a draft of the docs for OTel resource attribute promotion.

@zhehao-grafana could you please review and determine what additional information users need to know?

@aknuds1 and @jesusvazquez could you please review for technical accuracy and provide missing information on how users can update the list of attributes automatically assigned as labels?

Thank you!

@aknuds1 aknuds1 requested a review from zhehao-grafana March 7, 2025 07:39
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

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.

If you are using Grafana Cloud, contact support to disable this setting or to update this list.

{{< admonition type="note" >}}
Some of these labels are mutually exclusive. If you don't need a particular label, you can aggregate it using Adaptive Metrics. For more information about Adaptive Metrics, refer to [Reduce metrics costs via Adaptive Metrics](https://grafana.com/docs/grafana-cloud/cost-management-and-billing/adaptive-telemetry/adaptive-metrics/).
Copy link
Contributor

Choose a reason for hiding this comment

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

Does the note refer to the list of resource attributes above (as opposed to labels)? Do you have examples of mutually exclusive ones? Not sure how to interpret the note.

If you are referring to resource attributes, why not avoid promoting them instead of aggregating the resulting labels away?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, they are resource attributes. I actually think this note might add more confusion than clarity, and I'm going to remove it.

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.

LGTM!

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.

4 participants