From 0a5ffb3bc1cf117091baacaddc55f1134e2c9dfc Mon Sep 17 00:00:00 2001 From: hagen1778 Date: Thu, 18 Jan 2024 11:19:53 +0100 Subject: [PATCH] docs: remove slug from Grafana dashboard URLs Each Grafana dashboard has unique ID which can be used to fetch the dashboard from grafana.com: https://grafana.com/grafana/dashboards/11176 The same dashboard can be accessed via URL with slug: https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/ But using slug implies that any change to dashboard name will break the link. So it is better to just use ID, so the dashboard URL will never break. This is follow-up for https://github.com/VictoriaMetrics/VictoriaMetrics/commit/ff33e60a3d46b50bc585a66c433fd62ec00ec7ca Signed-off-by: hagen1778 --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- README.md | 12 ++++++------ deployment/docker/alerts-cluster.yml | 2 +- deployment/docker/alerts-vmagent.yml | 2 +- deployment/docker/alerts-vmalert.yml | 2 +- docs/Cluster-VictoriaMetrics.md | 2 +- docs/PerTenantStatistic.md | 2 +- docs/README.md | 12 ++++++------ docs/Single-server-VictoriaMetrics.md | 12 ++++++------ docs/guides/k8s-monitoring-via-vm-cluster.md | 4 ++-- docs/guides/k8s-monitoring-via-vm-single.md | 2 +- docs/operator/monitoring.md | 2 +- docs/vmagent.md | 2 +- docs/vmalert.md | 2 +- 14 files changed, 31 insertions(+), 31 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index fdbec0def..8c27a07e1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -60,8 +60,8 @@ body: For VictoriaMetrics health-state issues please provide full-length screenshots of Grafana dashboards if possible: - * [Grafana dashboard for single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) - * [Grafana dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/) + * [Grafana dashboard for single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229/) + * [Grafana dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176/) See how to setup monitoring here: * [monitoring for single-node VictoriaMetrics](https://docs.victoriametrics.com/#monitoring) diff --git a/README.md b/README.md index 0a7bd4328..f435d8448 100644 --- a/README.md +++ b/README.md @@ -1855,8 +1855,8 @@ This increases overhead during data querying, since VictoriaMetrics needs to rea bigger number of parts per each request. That's why it is recommended to have at least 20% of free disk space under directory pointed by `-storageDataPath` command-line flag. -Information about merging process is available in [the dashboard for single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) -and [the dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/). +Information about merging process is available in [the dashboard for single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229/) +and [the dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176/). See more details in [monitoring docs](#monitoring). See [this article](https://valyala.medium.com/how-victoriametrics-makes-instant-snapshots-for-multi-terabyte-time-series-data-e1f3fb0e0282) for more details. @@ -2058,8 +2058,8 @@ with 10 seconds interval. _Please note, never use loadbalancer address for scraping metrics. All monitored components should be scraped directly by their address._ -Official Grafana dashboards available for [single-node](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) -and [clustered](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/) VictoriaMetrics. +Official Grafana dashboards available for [single-node](https://grafana.com/grafana/dashboards/10229/) +and [clustered](https://grafana.com/grafana/dashboards/11176/) VictoriaMetrics. See an [alternative dashboard for clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11831) created by community. @@ -2329,8 +2329,8 @@ The following metrics for each type of cache are exported at [`/metrics` page](# * `vm_cache_misses_total` - the number of cache misses * `vm_cache_entries` - the number of entries in the cache -Both Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) -and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/) +Both Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229/) +and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176/) contain `Caches` section with cache metrics visualized. The panels show the current memory usage by each type of cache, and also a cache hit rate. If hit rate is close to 100% then cache efficiency is already very high and does not need any tuning. diff --git a/deployment/docker/alerts-cluster.yml b/deployment/docker/alerts-cluster.yml index 4817d81b3..09d8cf957 100644 --- a/deployment/docker/alerts-cluster.yml +++ b/deployment/docker/alerts-cluster.yml @@ -3,7 +3,7 @@ # and threshold calibration according to every specific setup. groups: # Alerts group for VM cluster assumes that Grafana dashboard - # https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/ is installed. + # https://grafana.com/grafana/dashboards/11176/ is installed. # Please, update the `dashboard` annotation according to your setup. - name: vmcluster interval: 30s diff --git a/deployment/docker/alerts-vmagent.yml b/deployment/docker/alerts-vmagent.yml index e850bc0cb..fc11b87d0 100644 --- a/deployment/docker/alerts-vmagent.yml +++ b/deployment/docker/alerts-vmagent.yml @@ -3,7 +3,7 @@ # and threshold calibration according to every specific setup. groups: # Alerts group for vmagent assumes that Grafana dashboard - # https://grafana.com/grafana/dashboards/12683-victoriametrics-vmagent/ is installed. + # https://grafana.com/grafana/dashboards/12683/ is installed. # Pls update the `dashboard` annotation according to your setup. - name: vmagent interval: 30s diff --git a/deployment/docker/alerts-vmalert.yml b/deployment/docker/alerts-vmalert.yml index 53f86a287..5ccae45e4 100644 --- a/deployment/docker/alerts-vmalert.yml +++ b/deployment/docker/alerts-vmalert.yml @@ -3,7 +3,7 @@ # and threshold calibration according to every specific setup. groups: # Alerts group for vmalert assumes that Grafana dashboard - # https://grafana.com/grafana/dashboards/14950-victoriametrics-vmalert/ is installed. + # https://grafana.com/grafana/dashboards/14950/ is installed. # Pls update the `dashboard` annotation according to your setup. - name: vmalert interval: 30s diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index bc991638a..08ccd4739 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -309,7 +309,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-victoriametrics-cluster/) +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). 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 list](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/deployment/docker#alerts). diff --git a/docs/PerTenantStatistic.md b/docs/PerTenantStatistic.md index c1549fd61..a0efcd5b4 100644 --- a/docs/PerTenantStatistic.md +++ b/docs/PerTenantStatistic.md @@ -54,7 +54,7 @@ scrape_configs: ## Visualization Visualisation of statistics can be done in Grafana using the following -[dashboard](https://grafana.com/grafana/dashboards/16399-victoriametrics-cluster-per-tenant-statistic/). +[dashboard](https://grafana.com/grafana/dashboards/16399/). ## Integration with vmgateway diff --git a/docs/README.md b/docs/README.md index f316f3972..a04bf3327 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1858,8 +1858,8 @@ This increases overhead during data querying, since VictoriaMetrics needs to rea bigger number of parts per each request. That's why it is recommended to have at least 20% of free disk space under directory pointed by `-storageDataPath` command-line flag. -Information about merging process is available in [the dashboard for single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) -and [the dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/). +Information about merging process is available in [the dashboard for single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229/) +and [the dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176/). See more details in [monitoring docs](#monitoring). See [this article](https://valyala.medium.com/how-victoriametrics-makes-instant-snapshots-for-multi-terabyte-time-series-data-e1f3fb0e0282) for more details. @@ -2061,8 +2061,8 @@ with 10 seconds interval. _Please note, never use loadbalancer address for scraping metrics. All monitored components should be scraped directly by their address._ -Official Grafana dashboards available for [single-node](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) -and [clustered](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/) VictoriaMetrics. +Official Grafana dashboards available for [single-node](https://grafana.com/grafana/dashboards/10229/) +and [clustered](https://grafana.com/grafana/dashboards/11176/) VictoriaMetrics. See an [alternative dashboard for clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11831) created by community. @@ -2332,8 +2332,8 @@ The following metrics for each type of cache are exported at [`/metrics` page](# * `vm_cache_misses_total` - the number of cache misses * `vm_cache_entries` - the number of entries in the cache -Both Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) -and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/) +Both Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229/) +and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176/) contain `Caches` section with cache metrics visualized. The panels show the current memory usage by each type of cache, and also a cache hit rate. If hit rate is close to 100% then cache efficiency is already very high and does not need any tuning. diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index cae949f49..e8508cd19 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -1866,8 +1866,8 @@ This increases overhead during data querying, since VictoriaMetrics needs to rea bigger number of parts per each request. That's why it is recommended to have at least 20% of free disk space under directory pointed by `-storageDataPath` command-line flag. -Information about merging process is available in [the dashboard for single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) -and [the dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/). +Information about merging process is available in [the dashboard for single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229/) +and [the dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176/). See more details in [monitoring docs](#monitoring). See [this article](https://valyala.medium.com/how-victoriametrics-makes-instant-snapshots-for-multi-terabyte-time-series-data-e1f3fb0e0282) for more details. @@ -2069,8 +2069,8 @@ with 10 seconds interval. _Please note, never use loadbalancer address for scraping metrics. All monitored components should be scraped directly by their address._ -Official Grafana dashboards available for [single-node](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) -and [clustered](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/) VictoriaMetrics. +Official Grafana dashboards available for [single-node](https://grafana.com/grafana/dashboards/10229/) +and [clustered](https://grafana.com/grafana/dashboards/11176/) VictoriaMetrics. See an [alternative dashboard for clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11831) created by community. @@ -2340,8 +2340,8 @@ The following metrics for each type of cache are exported at [`/metrics` page](# * `vm_cache_misses_total` - the number of cache misses * `vm_cache_entries` - the number of entries in the cache -Both Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) -and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/) +Both Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229/) +and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176/) contain `Caches` section with cache metrics visualized. The panels show the current memory usage by each type of cache, and also a cache hit rate. If hit rate is close to 100% then cache efficiency is already very high and does not need any tuning. diff --git a/docs/guides/k8s-monitoring-via-vm-cluster.md b/docs/guides/k8s-monitoring-via-vm-cluster.md index cedace4d3..6b061d44d 100644 --- a/docs/guides/k8s-monitoring-via-vm-cluster.md +++ b/docs/guides/k8s-monitoring-via-vm-cluster.md @@ -511,8 +511,8 @@ EOF By running this command we: * Install Grafana from the Helm repository. * Provision a VictoriaMetrics data source with the url from the output above which we remembered. -* Add this [https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/) dashboard for [VictoriaMetrics Cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html). -* Add this [https://grafana.com/grafana/dashboards/12683-victoriametrics-vmagent/](https://grafana.com/grafana/dashboards/12683-victoriametrics-vmagent/) dashboard for [VictoriaMetrics Agent](https://docs.victoriametrics.com/vmagent.html). +* Add this [https://grafana.com/grafana/dashboards/11176/](https://grafana.com/grafana/dashboards/11176/) dashboard for [VictoriaMetrics Cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html). +* Add this [https://grafana.com/grafana/dashboards/12683/](https://grafana.com/grafana/dashboards/12683/) dashboard for [VictoriaMetrics Agent](https://docs.victoriametrics.com/vmagent.html). * Add this [https://grafana.com/grafana/dashboards/14205-kubernetes-cluster-monitoring-via-prometheus/](https://grafana.com/grafana/dashboards/14205-kubernetes-cluster-monitoring-via-prometheus/) dashboard to see Kubernetes cluster metrics. diff --git a/docs/guides/k8s-monitoring-via-vm-single.md b/docs/guides/k8s-monitoring-via-vm-single.md index c21cd4b8e..fa9546d54 100644 --- a/docs/guides/k8s-monitoring-via-vm-single.md +++ b/docs/guides/k8s-monitoring-via-vm-single.md @@ -306,7 +306,7 @@ EOF By running this command we: * Install Grafana from Helm repository. * Provision VictoriaMetrics datasource with the url from the output above which we copied before. -* Add this [https://grafana.com/grafana/dashboards/10229-victoriametrics/](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/) dashboard for VictoriaMetrics. +* Add this [https://grafana.com/grafana/dashboards/10229-victoriametrics/](https://grafana.com/grafana/dashboards/10229/) dashboard for VictoriaMetrics. * Add this [https://grafana.com/grafana/dashboards/14205-kubernetes-cluster-monitoring-via-prometheus/](https://grafana.com/grafana/dashboards/14205-kubernetes-cluster-monitoring-via-prometheus/) dashboard to see Kubernetes cluster metrics. diff --git a/docs/operator/monitoring.md b/docs/operator/monitoring.md index 28228a03c..c2ce721b7 100644 --- a/docs/operator/monitoring.md +++ b/docs/operator/monitoring.md @@ -18,7 +18,7 @@ These metrics can be scraped via [vmagent](./resources/vmagent.md) or Prometheus ## Dashboard -Official Grafana dashboard available for [vmoperator](https://grafana.com/grafana/dashboards/17869-victoriametrics-operator/). +Official Grafana dashboard available for [vmoperator](https://grafana.com/grafana/dashboards/17869/). diff --git a/docs/vmagent.md b/docs/vmagent.md index 11d59358f..1e35e9aa7 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -1024,7 +1024,7 @@ See also [cardinality explorer docs](https://docs.victoriametrics.com/#cardinali 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-victoriametrics-vmagent/) 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. diff --git a/docs/vmalert.md b/docs/vmalert.md index 65128ae13..b823da597 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -797,7 +797,7 @@ The default list of alerting rules for these metric can be found [here](https:// 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 the official [Grafana dashboard](https://grafana.com/grafana/dashboards/14950-victoriametrics-vmalert/) for `vmalert` overview. +Use the official [Grafana dashboard](https://grafana.com/grafana/dashboards/14950/) for `vmalert` overview. Graphs on this dashboard contain useful hints - hover the `i` icon in 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.