diff --git a/website/content/docs/configuration/telemetry.mdx b/website/content/docs/configuration/telemetry.mdx index fe6bbf0691..2e7bc6e9af 100644 --- a/website/content/docs/configuration/telemetry.mdx +++ b/website/content/docs/configuration/telemetry.mdx @@ -28,7 +28,7 @@ parameters on this page are grouped by the telemetry provider. The following options are available on all telemetry configurations. - `usage_gauge_period` `(string: "10m")` - Specifies the interval at which high-cardinality - usage data is collected, such as token counts, entity counts, and secret counts. + usage data is collected, such as token counts, entity counts, and secret counts. A value of "none" disables the collection. - `maximum_gauge_cardinality` `(int: 500)` - The maximum cardinality of gauge labels. - `disable_hostname` `(bool: false)` - Specifies if gauge values should be @@ -36,10 +36,10 @@ The following options are available on all telemetry configurations. - `enable_hostname_label` `(bool: false)` - Specifies if all metric values should contain the `host` label with the local hostname. It is recommended to enable `disable_hostname` if this option is used. -- `lease_metrics_epsilon` `(string: "1hr")` - Specifies the the size of the bucket used to measure future +- `lease_metrics_epsilon` `(string: "1h")` - Specifies the size of the bucket used to measure future lease expiration. For example, for the default value of 1 hour, the `vault.expire.leases.by_expiration` metric will aggregate the total number of expiring leases for 1 hour buckets, starting from the current time. - Note that leases are put into buckets by rounding. For example, if `lease_metrics_epsilon` is set to 1hr and + Note that leases are put into buckets by rounding. For example, if `lease_metrics_epsilon` is set to 1h and lease A expires 25 minutes from now, and lease B expires 35 minutes from now, then lease A will be in the first bucket, which corresponds to 0-30 minutes, and lease B will be in the second bucket, which corresponds to 31-90 minutes. @@ -59,7 +59,7 @@ The following options are available on all telemetry configurations. ```json ["+vault.token", "-vault.expire", "+vault.expire.num_leases"] ``` - A leading "**+**" will enable any metrics with the given prefix, and a leading "**-**" will block them. + A leading "**+**" will enable any metrics with the given prefix, and a leading "**-**" will block them. If there is overlap between two rules, the more specific rule will take precedence. Blocking will take priority if the same prefix is listed multiple times. @@ -244,7 +244,7 @@ roles/monitoring.metricWriter - `stackdriver_location` `(string: "")` - The GCP or AWS region of the monitored resource. - `stackdriver_namespace` `(string: "")` - A namespace identifier for the telemetry data. - `stackdriver_debug_logs` `(bool: "false")` - Specifies if Vault writes additional stackdriver -related debug logs to standard error output (stderr). +related debug logs to standard error output (stderr). It is recommended to also enable the option `disable_hostname` to avoid having prefixed metrics with hostname and enable instead `enable_hostname_label`.