aboutsummaryrefslogtreecommitdiff
path: root/doc/book/cookbook/monitoring.md
diff options
context:
space:
mode:
authorAlex <alex@adnab.me>2023-01-30 16:35:30 +0000
committerAlex <alex@adnab.me>2023-01-30 16:35:30 +0000
commit4cff37397f626ef063dad29e5b5e97ab1206015d (patch)
tree584005f176e3e535dd4e63ae766cffc9fb12b0f0 /doc/book/cookbook/monitoring.md
parenta1005c26b638782df613a7a776e4dcb22ad34d08 (diff)
parent5f412abd4e0868ea11711f696c3eabe452db7560 (diff)
downloadgarage-4cff37397f626ef063dad29e5b5e97ab1206015d.tar.gz
garage-4cff37397f626ef063dad29e5b5e97ab1206015d.zip
Merge pull request 'Small doc corrections' (#489) from jpds/garage:doc-corrections into main
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/489
Diffstat (limited to 'doc/book/cookbook/monitoring.md')
-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.