aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Davies <jpds@protonmail.com>2023-01-27 20:55:50 +0000
committerJonathan Davies <jpds@protonmail.com>2023-01-30 12:54:42 +0000
commitc753a9dfb6e46830a625697d7c244183c4b5f1a7 (patch)
tree5048211a65b8bff323180208615dc1676be67669
parentae9c7a29001ce08a73798f68f49c421a2e432959 (diff)
downloadgarage-c753a9dfb6e46830a625697d7c244183c4b5f1a7.tar.gz
garage-c753a9dfb6e46830a625697d7c244183c4b5f1a7.zip
cookbook/monitoring.md: Added new metrics (garage_build_info,
garage_replication_factor, block_compression_level).
-rw-r--r--doc/book/cookbook/monitoring.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/book/cookbook/monitoring.md b/doc/book/cookbook/monitoring.md
index 8206f645..f2240e8c 100644
--- a/doc/book/cookbook/monitoring.md
+++ b/doc/book/cookbook/monitoring.md
@@ -55,6 +55,23 @@ We detail below the list of exposed metrics and their meaning.
## List of exported metrics
+### Garage system metrics
+
+#### `garage_build_info` (counter)
+
+Exposes the Garage version number running on a node.
+
+```
+garage_build_info{version="1.0"} 1
+```
+
+#### `garage_replication_factor` (counter)
+
+Exposes the Garage replication factor configured on the node
+
+```
+garage_replication_factor 3
+```
### Metrics of the API endpoints
@@ -148,6 +165,14 @@ block_bytes_read 120586322022
block_bytes_written 3386618077
```
+#### `block_compression_level` (counter)
+
+Exposes the block compression level configured for the Garage node.
+
+```
+block_compression_level 3
+```
+
#### `block_read_duration`, `block_write_duration` (histograms)
Evaluates the duration of the reading/writing of individual data blocks in the data storage directory.