From a67518fc6df7337f414c5da1583c8d3a7430d173 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Mon, 8 Nov 2021 19:52:44 +0200 Subject: [PATCH] docs: mention that graphs on the official dashboards contain useful hints --- README.md | 5 +++-- app/vmagent/README.md | 2 +- app/vmalert/README.md | 2 +- docs/Cluster-VictoriaMetrics.md | 2 +- docs/README.md | 5 +++-- docs/Single-server-VictoriaMetrics.md | 5 +++-- docs/vmagent.md | 2 +- docs/vmalert.md | 2 +- 8 files changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 268b9615e..30a1e2d44 100644 --- a/README.md +++ b/README.md @@ -1248,8 +1248,9 @@ or Prometheus by adding the corresponding scrape config to it. Alternatively they can be self-scraped by setting `-selfScrapeInterval` command-line flag to duration greater than 0. For example, `-selfScrapeInterval=10s` would enable self-scraping of `/metrics` page with 10 seconds interval. -There are officials Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/dashboards/10229) and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176). -There is also an [alternative dashboard for clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11831). +There are officials Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/dashboards/10229) and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176). There is also an [alternative dashboard for clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11831). + +Graphs on these dashboard contain useful hints - hover the `i` icon at the top left corner of each graph in order to read it. It is recommended setting up alerts in [vmalert](https://docs.victoriametrics.com/vmalert.html) or in Prometheus from [this config](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/deployment/docker/alerts.yml). diff --git a/app/vmagent/README.md b/app/vmagent/README.md index a6c69e00b..7bf75196c 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -428,7 +428,7 @@ These limits are approximate, so `vmagent` can underflow/overflow the limit by a `vmagent` exports various metrics in Prometheus exposition format at `http://vmagent-host:8429/metrics` page. We recommend setting up regular scraping of this page either through `vmagent` itself or by Prometheus so that the exported metrics may be analyzed later. -Use official [Grafana dashboard](https://grafana.com/grafana/dashboards/12683) for `vmagent` state overview. +Use official [Grafana dashboard](https://grafana.com/grafana/dashboards/12683) for `vmagent` state overview. Graphs on this dashboard contain useful hints - hover the `i` icon at the top left corner of each graph in order to read it. If you have suggestions for improvements or have found a bug - please open an issue on github or add a review to the dashboard. `vmagent` also exports the status for various targets at the following handlers: diff --git a/app/vmalert/README.md b/app/vmalert/README.md index 73ddeed50..5a1882551 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -350,7 +350,7 @@ See full description for these flags in `./vmalert --help`. We recommend setting up regular scraping of this page either through `vmagent` or by Prometheus so that the exported metrics may be analyzed later. -Use official [Grafana dashboard](https://grafana.com/grafana/dashboards/14950) for `vmalert` overview. +Use official [Grafana dashboard](https://grafana.com/grafana/dashboards/14950) for `vmalert` overview. Graphs on this dashboard contain useful hints - hover the `i` icon at the top left corner of each graph in order to read it. If you have suggestions for improvements or have found a bug - please open an issue on github or add a review to the dashboard. diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index 7103c96a0..c277bf182 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -179,7 +179,7 @@ By default the following TCP ports are used: It is recommended setting up [vmagent](https://docs.victoriametrics.com/vmagent.html) or Prometheus to scrape `/metrics` pages from all the cluster components, so they can be monitored and analyzed with [the official Grafana dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176) -or [an alternative dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11831). +or [an alternative dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11831). Graphs on these dashboards contain useful hints - hover the `i` icon at the top left corner of each graph in order to read it. It is recommended setting up alerts in [vmalert](https://docs.victoriametrics.com/vmalert.html) or in Prometheus from [this config](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/cluster/deployment/docker/alerts.yml). diff --git a/docs/README.md b/docs/README.md index 268b9615e..30a1e2d44 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1248,8 +1248,9 @@ or Prometheus by adding the corresponding scrape config to it. Alternatively they can be self-scraped by setting `-selfScrapeInterval` command-line flag to duration greater than 0. For example, `-selfScrapeInterval=10s` would enable self-scraping of `/metrics` page with 10 seconds interval. -There are officials Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/dashboards/10229) and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176). -There is also an [alternative dashboard for clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11831). +There are officials Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/dashboards/10229) and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176). There is also an [alternative dashboard for clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11831). + +Graphs on these dashboard contain useful hints - hover the `i` icon at the top left corner of each graph in order to read it. It is recommended setting up alerts in [vmalert](https://docs.victoriametrics.com/vmalert.html) or in Prometheus from [this config](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/deployment/docker/alerts.yml). diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index b6675b8fa..2270b42c5 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -1252,8 +1252,9 @@ or Prometheus by adding the corresponding scrape config to it. Alternatively they can be self-scraped by setting `-selfScrapeInterval` command-line flag to duration greater than 0. For example, `-selfScrapeInterval=10s` would enable self-scraping of `/metrics` page with 10 seconds interval. -There are officials Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/dashboards/10229) and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176). -There is also an [alternative dashboard for clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11831). +There are officials Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/dashboards/10229) and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176). There is also an [alternative dashboard for clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11831). + +Graphs on these dashboard contain useful hints - hover the `i` icon at the top left corner of each graph in order to read it. It is recommended setting up alerts in [vmalert](https://docs.victoriametrics.com/vmalert.html) or in Prometheus from [this config](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/deployment/docker/alerts.yml). diff --git a/docs/vmagent.md b/docs/vmagent.md index a21562cc5..6fbd23541 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -432,7 +432,7 @@ These limits are approximate, so `vmagent` can underflow/overflow the limit by a `vmagent` exports various metrics in Prometheus exposition format at `http://vmagent-host:8429/metrics` page. We recommend setting up regular scraping of this page either through `vmagent` itself or by Prometheus so that the exported metrics may be analyzed later. -Use official [Grafana dashboard](https://grafana.com/grafana/dashboards/12683) for `vmagent` state overview. +Use official [Grafana dashboard](https://grafana.com/grafana/dashboards/12683) for `vmagent` state overview. Graphs on this dashboard contain useful hints - hover the `i` icon at the top left corner of each graph in order to read it. If you have suggestions for improvements or have found a bug - please open an issue on github or add a review to the dashboard. `vmagent` also exports the status for various targets at the following handlers: diff --git a/docs/vmalert.md b/docs/vmalert.md index 617f93f65..889443f9f 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -354,7 +354,7 @@ See full description for these flags in `./vmalert --help`. We recommend setting up regular scraping of this page either through `vmagent` or by Prometheus so that the exported metrics may be analyzed later. -Use official [Grafana dashboard](https://grafana.com/grafana/dashboards/14950) for `vmalert` overview. +Use official [Grafana dashboard](https://grafana.com/grafana/dashboards/14950) for `vmalert` overview. Graphs on this dashboard contain useful hints - hover the `i` icon at the top left corner of each graph in order to read it. If you have suggestions for improvements or have found a bug - please open an issue on github or add a review to the dashboard.