Adding descriptions to prombench dashboard #428
Conversation
|
Can you split the indentation changes/other changes into a separate PR from the PR adding the description, like discussed offline? It'll be easier to see the changes that way :) |
Signed-off-by: Raj Babu Das <[email protected]>
imrajdas
force-pushed
the
description-to-grafana
branch
from
c4205f4
to
4097953
Compare
There was a problem hiding this comment.
nice :) Could you please link the google doc in the PR description which has the Panel title along with the description in tabular format? It seems that GitHub diff cuts the panel title and it becomes very hard to see where this description actually belongs to.
I've added some general dashboard related comments.
| @@ -2349,6 +2350,7 @@ data: | |||
| "dashLength": 10, | |||
| "dashes": false, | |||
| "datasource": "prometheus-meta", | |||
| "description": "This dashboard indicates how many time series each instance holds", | |||
There was a problem hiding this comment.
| "description": "This dashboard indicates how many time series each instance holds", | |
| "description": "This graph indicates how many time series each instance holds", |
This is a little opinionated but maybe we can completely omit the words "This dashboard"/"This graph" because one will be able to see the description by hovering over the i tag on that particular grafana panel only. In some cases maybe having this will make sense :)
Same for the other cases.
| @@ -2896,6 +2903,7 @@ data: | |||
| "dashLength": 10, | |||
| "dashes": false, | |||
| "datasource": "prometheus-meta", | |||
| "description": "This dashboard shows two metrics\n- prometheus_tsdb_head_min_time: Minimum timestamp of the head block\n- prometheus_tsdb_head_max_time: Maximum timestamp of the head block\n", | |||
There was a problem hiding this comment.
I don't think it's the best idea to simply have the metric names in the description. :) One could look that up in the graph editor anyway.
A more friendly description (based on your current description) would be something like "Plots of minimum and maximum timestamp of the head block in reference to current time", you could go on further to explain what the timestamp of the head block may signify.
| @@ -3381,6 +3393,7 @@ data: | |||
| "dashLength": 10, | |||
| "dashes": false, | |||
| "datasource": "prometheus-meta", | |||
| "description": "This dashboard shows the following metrics.\n- Total WAL corruptions\n- Total TSDB reload failures\n- Head series not found\n- Total Compactions failures\n- Total retentions cutoffs failures", | |||
There was a problem hiding this comment.
The problems can already be seen in the graph legends, so we might just want to keep it short something like "Various tsdb related checks", or in this case, since the title is pretty much self explanatory, we may not even need a description here.
Or the other idea could be to mention cause and effects of these tsdb issues in the description.
Interested in hearing what others have to say about this. :)
imrajdas
force-pushed
the
description-to-grafana
branch
from
bb9b2fc
to
edac479
Compare
|
Here is the document- https://docs.google.com/document/d/1FKLUkCcaTgC72Dh-Kz66228PykCwG4zy2Tw7zD_491k/edit |
Signed-off-by: Raj Babu Das <[email protected]>
imrajdas
force-pushed
the
description-to-grafana
branch
from
edac479
to
5278535
Compare
|
@geekodour do you think we could merge this? |
|
Grafana dashboard updated successfully. |
Google doc for the panel descriptions: https://docs.google.com/document/d/1FKLUkCcaTgC72Dh-Kz66228PykCwG4zy2Tw7zD_491k/edit
Fixes- Update Grafana Dashboards #328 Add explanations to all panels on the Prombench dashboard #305
Signed-off-by: Raj Babu Das [email protected]