docs: Added metric documentation

dodevops · Oct 31, 2024 · d0ea38e · d0ea38e
1 parent 42fe6e9
commit d0ea38e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -21,3 +21,10 @@ Aside from building the go binary and running it, a container is available as we
 
    docker run --rm -it -P -e CLOUDIAN_URL=... -e CLOUDIAN_USERNAME=... -e CLOUDIAN_PASSWORD=... ghcr.io/dodevops/cloudian-exporter:main
 
+## Exported metrics
+
+* cloudian_bucket_size: Size of a bucket in Cloudian in bytes
+  * Labels available
+    * group_id: Group in Cloudian
+    * user_id: User holding the bucket
+    * bucket: Bucket name