diff options
| author | Alex Auvolat <lx@deuxfleurs.fr> | 2025-02-14 14:54:06 +0100 |
|---|---|---|
| committer | Alex Auvolat <lx@deuxfleurs.fr> | 2025-02-14 14:59:00 +0100 |
| commit | 2f558898354a668b73579d7e09a0ecc922e9dcaf (patch) | |
| tree | 5b0e6be9755f1329c9f2e4c410ce3d92433532bf /doc | |
| parent | 8b9cc5ca3fea35ee54e309bde5a0a651c3b31322 (diff) | |
| download | garage-2f558898354a668b73579d7e09a0ecc922e9dcaf.tar.gz garage-2f558898354a668b73579d7e09a0ecc922e9dcaf.zip | |
add configuration option to enable/disable monitoring bucket in web metrics
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/book/reference-manual/configuration.md | 9 |
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 |