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

Document native histogram query, visualization and best practices #6231

Merged
merged 9 commits into from
Nov 24, 2023

Conversation

krajorama
Copy link
Contributor

@krajorama krajorama commented Oct 5, 2023

What this PR does

Document PromQL differences to classic histograms, Grafana visualization. Everything you need to know how to get started.

Credit for content: @osg-grafana and @krajorama

Which issue(s) this PR fixes or relates to

Relates to https://github.com/grafana/mimir-squad/issues/1336, as a partial fix.

Checklist

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

@krajorama krajorama requested review from a team as code owners October 5, 2023 14:26
@krajorama krajorama marked this pull request as draft October 5, 2023 14:27
Copy link
Contributor

@dimitarvdimitrov dimitarvdimitrov left a comment

Choose a reason for hiding this comment

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

this looks very helpful, thanks for writing. But it does feel awkward that these docs are in Mimir, because there's nothing Mimir-specific about them. Aren't prometheus/prometheus interested in hosting them?

@krajorama
Copy link
Contributor Author

this looks very helpful, thanks for writing. But it does feel awkward that these docs are in Mimir, because there's nothing Mimir-specific about them. Aren't prometheus/prometheus interested in hosting them?

We've (@beorn7) discussed this multiple times and prometheus will eventually have them, but we need this now and plus this way we can get tech writer review on this. We'll replace with link to Prometheus docs when that's ready.

Base automatically changed from krajo/document-native-histograms to main October 11, 2023 06:41
Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
@krajorama krajorama force-pushed the krajo/document-native-histograms-query branch from 8841a50 to 33fa9b3 Compare October 26, 2023 07:53
Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
@krajorama krajorama marked this pull request as ready for review November 2, 2023 11:22
@krajorama krajorama added the type/docs Improvements or additions to documentation label Nov 2, 2023
@osg-grafana
Copy link
Contributor

I can look at this PR in the middle of November.

krajorama and others added 2 commits November 2, 2023 14:25
Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
Copy link
Contributor

@osg-grafana osg-grafana left a comment

Choose a reason for hiding this comment

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

Unblocking with feedback

Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
@krajorama krajorama enabled auto-merge (squash) November 24, 2023 13:06
Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
@krajorama krajorama merged commit 5a13d54 into main Nov 24, 2023
28 checks passed
@krajorama krajorama deleted the krajo/document-native-histograms-query branch November 24, 2023 13:45
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