Tendrl / monitoring-integration

Component that enables integration with external monitoring services.
GNU Lesser General Public License v2.1
4 stars 13 forks source link

Adding the description to the Grafana Panels #222

Closed cloudbehl closed 6 years ago

cloudbehl commented 7 years ago

I am planning to add a description to every grafana panel which will be shown as tool-tip to each panel in grafana. This will be helpful to end user about the expectations from each panel.

@julienlim Can you help me provide the description which can be then added to grafana.

julienlim commented 7 years ago

@cloudbehl

Have you looked at the dashboard specs? I believe there's quite a bit already listed in the spec:

I'll start off with some below that should hopefully give you some guidance on the tooltips: Cluster dashboard

Do have a look and if there are specific panels you need help with tooltip descriptions, do let me know.

I was so hoping we would get tooltips in the release and I'm glad to hear you're planning to add them!

@mcarrano @rghatvis@redhat.com - Please feel free to suggest better wording or any other improvements.

cloudbehl commented 7 years ago

@julienlim can we cut short the descriptions? As for a grafana tooltip, it's way too long.

julienlim commented 6 years ago

@cloudbehl - what's the length we're talking about?

cloudbehl commented 6 years ago

@julienlim I was talking about the description of hosts, Volume and bricks panel. It looks too large for a description to me but as in there are no restrictions from Grafana on a text.

Also, can you provide me with all the description for all the panels with appropriate text? The text in the metrics doc and the specs seem to differ in respect of terminologies. So it would be helpful if you can pass description for all the panels.

julienlim commented 6 years ago

@cloudbehl @mcarrano I've created a Google Doc to make it easier to specify the descriptions for the panels. See Tendrl Grafana Dashboard Panels Descriptions.

julienlim commented 6 years ago

@cloudbehl @mcarrano @rghatvis@redhat.com

I've updated Tendrl Grafana Dashboard Panels Descriptions for all the dashboards. I encountered some typos (that I didn't file bugs for but it's mentioned in the document) for some panel labels, one of the metrics shown (lowercase vs. uppercase), some confusing panels that are either duplicate or not clearly specified what they are with their label, e.g. "Utilization" panel.

cloudbehl commented 6 years ago

Few of the description is added to grafana and others are pending.

julienlim commented 6 years ago

Just noting the document mentioned above provides description for the current dashboards: