From 01bc0c94ab2b4cf0502e2bee4af1e7c71886e933 Mon Sep 17 00:00:00 2001 From: Zakhar Bessarab Date: Thu, 5 Jan 2023 19:03:06 +0400 Subject: [PATCH] doc: add vmbackupmanager monitoring section (#3605) * doc: add vmbackupmanager monitoring section Signed-off-by: Zakhar Bessarab --- app/vmbackupmanager/README.md | 10 ++++++++++ docs/vmbackupmanager.md | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/app/vmbackupmanager/README.md b/app/vmbackupmanager/README.md index 20775c53f..d81592107 100644 --- a/app/vmbackupmanager/README.md +++ b/app/vmbackupmanager/README.md @@ -322,6 +322,16 @@ Clusters here are referred to as `source` and `destination`. $ /vmbackupmanager-prod restore create s3://source_cluster/vmstorage-source-0/daily/2022-10-06 ``` +## Monitoring + +`vmbackupmanager` exports various metrics in Prometheus exposition format at `http://vmbackupmanager:8300/metrics` page. It is recommended setting up regular scraping of this page +either via [vmagent](https://docs.victoriametrics.com/vmagent.html) or via Prometheus, so the exported metrics could be analyzed later. + +Use the official [Grafana dashboard](https://grafana.com/grafana/dashboards/17798-victoriametrics-backupmanager/) for `vmbackupmanager` 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. + ## Configuration ### Flags diff --git a/docs/vmbackupmanager.md b/docs/vmbackupmanager.md index 1ac6083d3..e4e7ea78c 100644 --- a/docs/vmbackupmanager.md +++ b/docs/vmbackupmanager.md @@ -326,6 +326,16 @@ Clusters here are referred to as `source` and `destination`. $ /vmbackupmanager-prod restore create s3://source_cluster/vmstorage-source-0/daily/2022-10-06 ``` +## Monitoring + +`vmbackupmanager` exports various metrics in Prometheus exposition format at `http://vmbackupmanager:8300/metrics` page. It is recommended setting up regular scraping of this page +either via [vmagent](https://docs.victoriametrics.com/vmagent.html) or via Prometheus, so the exported metrics could be analyzed later. + +Use the official [Grafana dashboard](https://grafana.com/grafana/dashboards/17798-victoriametrics-backupmanager/) for `vmbackupmanager` 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. + ## Configuration ### Flags