Skip to content

Commit 96d8836

Browse files
authored
Upgrade overrides exporter docs (#7106)
Signed-off-by: SungJin1212 <[email protected]>
1 parent db43744 commit 96d8836

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/guides/overrides-exporter.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,17 @@ cortex_overrides{limit_name="max_samples_per_query",user="user1"} 100000
6262

6363
With these metrics, you can set up alerts to know when tenants are close to hitting their limits
6464
before they exceed them.
65+
66+
## Exposed Metrics
67+
Prior to version v1.20.0, the exporter only exposed the fixed, hardcoded list of limits shown in the example section above.
68+
69+
As of version v1.20.0, the exporter automatically discovers and exposes all fields from the [limit_config](../configuration/config-file-reference.md#limits_config) configuration
70+
that are numerically representable.
71+
72+
The exposes metrics based on the following rules:
73+
- Numerical types (`int`, `int64`, `uint`, `uint64`, `float64`) are converted directly to a `float64`.
74+
- bool types are converted to 1.0 (for `true`) or 0.0 (for `false`).
75+
- model.Duration types (which are internally `int64`) are converted to the total number of seconds as a `float64` (e.g, 1h becomes 3600.0).
76+
77+
Fields with types such as `string`, `slice`, `map`, or other nested structs (like `metric_relabel_configs`) are ignored and not exported as metrics.
78+

0 commit comments

Comments
 (0)