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

Add docs for native histograms in the generator #3929

Merged
merged 3 commits into from
Aug 6, 2024

Conversation

zalegrala
Copy link
Contributor

What this PR does:

Native histogram support was recently added to the generator. Here we include some docs about how to use this feature.

Checklist

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

Copy link
Member

@yvrhdn yvrhdn left a comment

Choose a reason for hiding this comment

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

LGTM 🙂 I'll wait for Kim to review too

@knylander-grafana knylander-grafana added the type/docs Improvements or additions to documentation label Aug 5, 2024
@knylander-grafana knylander-grafana self-assigned this Aug 5, 2024
## Native histograms

The metrics-generator supports the ability to produce native histograms, for
high-resolution data. Users must [update the receiving endpoint](https://grafana.com/docs/mimir/latest/configure/configure-native-histograms-ingestion/) to ingest native
Copy link
Contributor

@knylander-grafana knylander-grafana Aug 5, 2024

Choose a reason for hiding this comment

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

@zalegrala Clarifying question here. Does metrics-generator require a Prometheus or MImir endpoint? Asking because I wasn't sure if Tempo was doing this or not.

If it makes things easier, we can share content from Mimir docs to Tempo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Correct, Tempo metrics do require Mimir or Prometheus.

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've added a link to where we talk about native histograms.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you

Copy link
Contributor

@knylander-grafana knylander-grafana left a comment

Choose a reason for hiding this comment

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

Thank you for adding doc! No real changes or suggestions. We might want to considering adding some information to our metrics-generator general info about what native histograms are. We can probably share some of that info from the Mimi docs.

@zalegrala zalegrala merged commit 334ad1c into grafana:main Aug 6, 2024
17 checks passed
@zalegrala zalegrala deleted the nativeHistogramDocs branch August 6, 2024 14:05
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