Readme Cleanup (#28)

Cleanup and link updates: - Added dashboard ID to badge - Linked dashboard ID badge to overview page for Grafana dashboard - Added more information in each section to give idea about what you can visualize w each dash --------- Co-authored-by: roypaulin <[email protected]>
vertica · Nov 9, 2023 · 72c873e · 72c873e
1 parent 9c95205
commit 72c873e
Showing 1 changed file with 35 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -4,40 +4,69 @@ This repository contains dashboards that you can import into [Grafana](https://g
 
 Unless explicitly noted, all dashboards are compatible with new Vertica server versions. The minimum supported Vertica version is listed with the release version in the following dashboard sections.
 
-Some dashboards might use metrics that are available in specific Vertica versions. Review the [Prometheus metrics](https://docs.vertica.com/latest/en/admin/managing-db/https-service/prometheus-metrics/) to verify which metrics are available in each Vertica version.
+Some dashboards might use metrics that are available in specific Vertica versions. Review [Prometheus metrics](https://docs.vertica.com/latest/en/admin/managing-db/https-service/prometheus-metrics/) to verify which metrics are available in each Vertica version.
 
 ## Vertica Overview (Prometheus)
 
 `cluster-overview.json`
 
-[![revision](https://img.shields.io/badge/revision-1-orange.svg)](https://example.com) [![release](https://img.shields.io/badge/release-1.0.0-green.svg)](https://github.com/vertica/grafana-dashboards/releases) [![Dashboard ID](https://img.shields.io/badge/Dashboard_ID-TBD-yellow.svg)](https://grafana.com/grafana/dashboards/?search=TBD) [![Vertica compatibility](https://img.shields.io/badge/Vertica-v23.3.0-blue.svg)](https://docs.vertica.com/latest/en/)
+[![revision](https://img.shields.io/badge/revision-1-orange.svg)](https://grafana.com/grafana/dashboards/19917-vertica-overview-prometheus/?tab=revisions) [![release](https://img.shields.io/badge/release-1.0.0-green.svg)](https://github.com/vertica/grafana-dashboards/releases) [![Dashboard ID](https://img.shields.io/badge/Dashboard_ID-19917-yellow.svg)](https://grafana.com/grafana/dashboards/19917-vertica-overview-prometheus/) [![Vertica compatibility](https://img.shields.io/badge/Vertica-v23.3.0-blue.svg)](https://docs.vertica.com/latest/en/)
 
 General cluster overview. This dashboard is designed to be the initial landing page in Grafana.
 
+This dashboard includes the following:
+
+- Total number of nodes and their state, data size, and disk usage
+- Query request and processing statistics
+- Number of errors
+- User and license information
+- Overall cluster health
+
 ## Vertica Queries (Prometheus)
 
 `queries.json`
 
-[![revision](https://img.shields.io/badge/revision-1-orange.svg)](https://example.com) [![release](https://img.shields.io/badge/release-1.0.0-green.svg)](https://github.com/vertica/grafana-dashboards/releases) [![Dashboard ID](https://img.shields.io/badge/Dashboard_ID-TBD-yellow.svg)](https://img.shields.io/badge/Dashboard_ID-TBD-yellow.svg) [![Vertica compatibility](https://img.shields.io/badge/Vertica-v23.3.0-blue.svg)](https://docs.vertica.com/latest/en/)
+[![revision](https://img.shields.io/badge/revision-1-orange.svg)](https://grafana.com/grafana/dashboards/19915-vertica-queries-prometheus/?tab=revisions) [![release](https://img.shields.io/badge/release-1.0.0-green.svg)](https://github.com/vertica/grafana-dashboards/releases) [![Dashboard ID](https://img.shields.io/badge/Dashboard_ID-19915-yellow.svg)](https://grafana.com/grafana/dashboards/19915-vertica-queries-prometheus/) [![Vertica compatibility](https://img.shields.io/badge/Vertica-v23.3.0-blue.svg)](https://docs.vertica.com/latest/en/)
 
 Detailed information about [queries](https://docs.vertica.com/latest/en/data-analysis/queries/) that are currently running in a cluster.
 
+This dashboard includes the following:
+
+- Total query request success and failure rate
+- Running and queued queries, by node and by resource pool
+- Completed and failed queries, by node and by resource pool
+- User query type and execution time per type
+
 ## Vertica Resource Management (Prometheus)
 
 `resource-management.json`
 
-[![revision](https://img.shields.io/badge/revision-1-orange.svg)](https://example.com) [![release](https://img.shields.io/badge/release-1.0.0-green.svg)](https://github.com/vertica/grafana-dashboards/releases) [![Dashboard ID](https://img.shields.io/badge/Dashboard_ID-TBD-yellow.svg)](https://img.shields.io/badge/Dashboard_ID-TBD-yellow.svg) [![Vertica compatibility](https://img.shields.io/badge/Vertica-v23.3.0-blue.svg)](https://docs.vertica.com/latest/en/)
+[![revision](https://img.shields.io/badge/revision-1-orange.svg)](https://grafana.com/grafana/dashboards/19916-vertica-resource-management-prometheus/?tab=revisions) [![release](https://img.shields.io/badge/release-1.0.0-green.svg)](https://github.com/vertica/grafana-dashboards/releases) [![Dashboard ID](https://img.shields.io/badge/Dashboard_ID-19916-yellow.svg)](https://grafana.com/grafana/dashboards/19916-vertica-resource-management-prometheus/) [![Vertica compatibility](https://img.shields.io/badge/Vertica-v23.3.0-blue.svg)](https://docs.vertica.com/latest/en/)
 
-Details about [user-defined](https://docs.vertica.com/latest/en/sql-reference/statements/create-statements/create-resource-pool/) and [built-in](<(https://docs.vertica.com/latest/en/sql-reference/statements/create-statements/create-resource-pool/built-pools/)>) resource pool usage.
+Details about [user-defined](https://docs.vertica.com/latest/en/sql-reference/statements/create-statements/create-resource-pool/) and [built-in](https://docs.vertica.com/latest/en/sql-reference/statements/create-statements/create-resource-pool/built-pools/) resource pool usage.
+
+This dashboard includes the following:
+
+- Pool configuration values
+- Per node pool usage activity and statistics
+- Per node disk storage state
+- Per node storage location performance
 
 ## Vertica Depot (Prometheus)
 
 `depot.json`
 
-[![revision](https://img.shields.io/badge/revision-1-orange.svg)](https://example.com) [![release](https://img.shields.io/badge/release-1.0.0-green.svg)](https://github.com/vertica/grafana-dashboards/releases) [![Dashboard ID](https://img.shields.io/badge/Dashboard_ID-TBD-yellow.svg)](https://img.shields.io/badge/Dashboard_ID-TBD-yellow.svg) [![Vertica compatibility](https://img.shields.io/badge/Vertica-v23.3.0-blue.svg)](https://docs.vertica.com/latest/en/)
+[![revision](https://img.shields.io/badge/revision-1-orange.svg)](https://grafana.com/grafana/dashboards/19914-vertica-depot-prometheus/?tab=revisions) [![release](https://img.shields.io/badge/release-1.0.0-green.svg)](https://github.com/vertica/grafana-dashboards/releases) [![Dashboard ID](https://img.shields.io/badge/Dashboard_ID-19914-yellow.svg)](https://grafana.com/grafana/dashboards/19914-vertica-depot-prometheus/) [![Vertica compatibility](https://img.shields.io/badge/Vertica-v23.3.0-blue.svg)](https://docs.vertica.com/latest/en/)
 
 Details about [depot](https://docs.vertica.com/latest/en/eon/depot-management/) usage.
 
+This dashboard includes the following:
+
+- Current usage
+- Lookup hits
+- Fetches and evictions
+- Uploads from depot to communal storage
+
 # Contribute
 
 Vertica welcomes contributions to this repository. For details, see [CONTRIBUTING.md](CONTRIBUTING.md)