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
Update heatmap and prometheus docs #11383
Conversation
Codecov Report
@@ Coverage Diff @@
## master #11383 +/- ##
=======================================
Coverage 51.8% 51.8%
=======================================
Files 359 359
Lines 26019 26019
Branches 1556 1556
=======================================
Hits 13480 13480
- Misses 11794 11796 +2
+ Partials 745 743 -2 |
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.
Looks good! This PR is targeting master branch so we will have to wait to merge it until we release 5.1. Normally we make changes to the next docs version branch, in this case docs-5.1
. But lets just merge this later to avoid double work :)
@@ -50,7 +50,7 @@ Name | Description | |||
*Min step* | Set a lower limit for the Prometheus step option. Step controls how big the jumps are when the Prometheus query engine performs range queries. Sadly there is no official prometheus documentation to link to for this very important option. | |||
*Resolution* | Controls the step option. Small steps create high-resolution graphs but can be slow over larger time ranges, lowering the resolution can speed things up. `1/2` will try to set step option to generate 1 data point for every other pixel. A value of `1/10` will try to set step option so there is a data point every 10 pixels. | |||
*Metric lookup* | Search for metric names in this input field. | |||
*Format as* | **(New in v4.3)** Switch between Table & Time series. Table format will only work in the Table panel. | |||
*Format as* | **(New in v4.3)** Switch between Table, Time series or Heatmap. Table format will only work in the Table panel. Heatmap format is suitable for displaying metrics having histogram type on Heatmap panel. Under the hood, it converts cumulative histogram to regular and sorts series by the bucket bound. |
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 can remove the notice about 4.3
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.
Yes, I also think it's outdated.
Missing docs for #10009