From b38edc4e5639cfe4ba9cce563dd8f572e86e71f0 Mon Sep 17 00:00:00 2001 From: James Liu Date: Wed, 6 Dec 2023 17:20:56 +1100 Subject: [PATCH 1/3] doc: Add section on Gitaly backup metrics --- doc/administration/gitaly/monitoring.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/administration/gitaly/monitoring.md b/doc/administration/gitaly/monitoring.md index 0527c846b2dffa..c4b3c0d34ce6a6 100644 --- a/doc/administration/gitaly/monitoring.md +++ b/doc/administration/gitaly/monitoring.md @@ -176,6 +176,18 @@ gitaly_streamcache_filestore_removed_total{dir="/var/opt/gitlab/git-data/reposit gitaly_streamcache_index_entries{dir="/var/opt/gitlab/git-data/repositories/+gitaly/PackObjectsCache"} 1 ``` +## Monitor Gitaly repository backups + +Several metrics are available to monitor [server-side repository backups](configure_gitaly.md#configure-server-side-backups): + +- `gitaly_backup_latency_seconds` - a histogram measuring the amount of time in seconds that each phase of a server-side + backup takes. The different phases are `refs`, `bundle` and `custom_hooks` and represent the kind of data being + processed at each stage. +- `gitaly_backup_bundle_bytes` - a histogram measuring the upload data rate of Git bundles being pushed to object + storage by the Gitaly backup service. + +These metrics may be useful to monitor if your GitLab instance contains particularly large repositories. + ## Queries The following are some queries for monitoring Gitaly: -- GitLab From bda0db54875de397d618ecd05c83136374520196 Mon Sep 17 00:00:00 2001 From: Evan Read Date: Wed, 6 Dec 2023 22:49:51 +0000 Subject: [PATCH 2/3] Apply 1 suggestion(s) to 1 file(s) --- doc/administration/gitaly/monitoring.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/administration/gitaly/monitoring.md b/doc/administration/gitaly/monitoring.md index c4b3c0d34ce6a6..bae02b9b2d99e2 100644 --- a/doc/administration/gitaly/monitoring.md +++ b/doc/administration/gitaly/monitoring.md @@ -178,15 +178,17 @@ gitaly_streamcache_index_entries{dir="/var/opt/gitlab/git-data/repositories/+git ## Monitor Gitaly repository backups -Several metrics are available to monitor [server-side repository backups](configure_gitaly.md#configure-server-side-backups): +> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/5358) in GitLab 16.7. -- `gitaly_backup_latency_seconds` - a histogram measuring the amount of time in seconds that each phase of a server-side - backup takes. The different phases are `refs`, `bundle` and `custom_hooks` and represent the kind of data being +Monitor [server-side repository backups](configure_gitaly.md#configure-server-side-backups) with the following metrics: + +- `gitaly_backup_latency_seconds`, a histogram measuring the amount of time in seconds that each phase of a server-side + backup takes. The different phases are `refs`, `bundle`, and `custom_hooks` and represent the type of data being processed at each stage. -- `gitaly_backup_bundle_bytes` - a histogram measuring the upload data rate of Git bundles being pushed to object +- `gitaly_backup_bundle_bytes`, a histogram measuring the upload data rate of Git bundles being pushed to object storage by the Gitaly backup service. -These metrics may be useful to monitor if your GitLab instance contains particularly large repositories. +Use these metrics especially if your GitLab instance contains large repositories. ## Queries -- GitLab From a53caae40fec046ac2d8041adc62a8611a2409b4 Mon Sep 17 00:00:00 2001 From: Evan Read Date: Wed, 6 Dec 2023 22:51:15 +0000 Subject: [PATCH 3/3] Apply 1 suggestion(s) to 1 file(s) --- doc/administration/gitaly/monitoring.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/administration/gitaly/monitoring.md b/doc/administration/gitaly/monitoring.md index bae02b9b2d99e2..6ba43575980122 100644 --- a/doc/administration/gitaly/monitoring.md +++ b/doc/administration/gitaly/monitoring.md @@ -176,7 +176,7 @@ gitaly_streamcache_filestore_removed_total{dir="/var/opt/gitlab/git-data/reposit gitaly_streamcache_index_entries{dir="/var/opt/gitlab/git-data/repositories/+gitaly/PackObjectsCache"} 1 ``` -## Monitor Gitaly repository backups +## Monitor Gitaly server-side backups > [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/5358) in GitLab 16.7. -- GitLab