Add upgrade note about the KV metric crash. (#9882)

Co-authored-by: swayne275 <swayne275@gmail.com>
This commit is contained in:
Mark Gritter 2020-09-02 22:19:09 -05:00 committed by GitHub
parent 63d484b831
commit f12719fbde
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -42,6 +42,25 @@ This will suppress the metrics `vault.identity.entity.count`,
`vault.token.count.by_policy`, `vault.token.count.by_ttl` and `vault.secret.kv.count`
that were introduced in version 1.5.0, but all other Vault telemetry will remain available.
## Zero-length keys in key-value stores will cause Vault to crash.
A key-value data store might have a zero-length key, created before the request handling was
modified to make this operation impossible. The metrics collection process crashes if it encounters
this while counting the number of KV secrets.
A workaround for this issue is to disable collection of usage gauges in
the [telemetry](/docs/configuration/telemetry) stanza of the configuration.
```
telemetry {
...
usage_gauge_period = "none"
}
```
This will disable all the metrics listed in the previous section. Or, set the environment value
`VAULT_DISABLE_KV_GAUGE`, which will disable only `vault.secret.kv.count`.
## Non-string values in seal config prevent startup
Any values in the [Seal configuration stanza](/docs/configuration/seal)