aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlex <lx@deuxfleurs.fr>2025-02-14 14:26:08 +0000
committerAlex <lx@deuxfleurs.fr>2025-02-14 14:26:08 +0000
commit3fe8db9e52bf7fd069d8fa11d6a0c90a7d2944b6 (patch)
tree431f433f518c28ad9e9fc9e1696150353ee7ae13 /doc
parent627a37fe9fdde4798ff6131c6597dace8d5bd830 (diff)
parent2f558898354a668b73579d7e09a0ecc922e9dcaf (diff)
downloadgarage-3fe8db9e52bf7fd069d8fa11d6a0c90a7d2944b6.tar.gz
garage-3fe8db9e52bf7fd069d8fa11d6a0c90a7d2944b6.zip
Merge pull request 'web_server.rs: Added bucket domain to observability' (#608) from jpds/garage:domain-web-requests into main
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/608
Diffstat (limited to 'doc')
-rw-r--r--doc/book/reference-manual/configuration.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/book/reference-manual/configuration.md b/doc/book/reference-manual/configuration.md
index f0a3b438..f545de29 100644
--- a/doc/book/reference-manual/configuration.md
+++ b/doc/book/reference-manual/configuration.md
@@ -75,6 +75,7 @@ root_domain = ".s3.garage"
[s3_web]
bind_addr = "[::]:3902"
root_domain = ".web.garage"
+add_host_to_metrics = true
[admin]
api_bind_addr = "0.0.0.0:3903"
@@ -138,6 +139,7 @@ The `[s3_api]` section:
[`s3_region`](#s3_region).
The `[s3_web]` section:
+[`add_host_to_metrics`](#web_add_host_to_metrics),
[`bind_addr`](#web_bind_addr),
[`root_domain`](#web_root_domain).
@@ -744,6 +746,13 @@ For instance, if `root_domain` is `web.garage.eu`, a bucket called `deuxfleurs.f
will be accessible either with hostname `deuxfleurs.fr.web.garage.eu`
or with hostname `deuxfleurs.fr`.
+#### `add_host_to_metrics` {#web_add_host_to_metrics}
+
+Whether to include the requested domain name (HTTP `Host` header) in the
+Prometheus metrics of the web endpoint. This is disabled by default as the
+number of possible values is not bounded and can be a source of cardinality
+explosion in the exported metrics.
+
### The `[admin]` section