-
Notifications
You must be signed in to change notification settings - Fork 0
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
Readme Cleanup #28
Merged
roypaulin
merged 13 commits into
vertica:main
from
rs-vertica:bugfix/VER-88542-README-cleanup_rjs
Nov 9, 2023
Merged
Readme Cleanup #28
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
cd045fc
Update README.md
rs-vertica 438211a
Update README.md
rs-vertica 647c0a9
Update README.md
rs-vertica 7de74e9
Update README.md
rs-vertica feb0c62
Update README.md
rs-vertica c3eacb6
Update README.md
rs-vertica b1914ad
Merge branch 'main' into bugfix/VER-88542-README-cleanup_rjs
rs-vertica a89ed4e
Update README.md
rs-vertica 859cae2
Update README.md
rs-vertica 4be621e
Update README
roypaulin a271f76
Update README
roypaulin 8fb671e
Update README.md
rs-vertica 95214ba
Merge branch 'vertica:bugfix/VER-88542-README-cleanup_rjs' into bugfi…
rs-vertica File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,40 +4,67 @@ 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 | ||
- 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 | ||
- Completed and failed queries, by node and by resource pool | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can also add this:
|
||
- 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would suggest:
|
||
- Per node pool memory usage, query activity, and queued requests statistics | ||
- Queued request thresholds and memory usage | ||
- Average running queries and their average execution time | ||
|
||
## 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) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
We can also add
Number of errors