From 6cd00407adbdec303f8ace647fb23d6392e97ec4 Mon Sep 17 00:00:00 2001 From: Mark Gritter Date: Fri, 21 Aug 2020 13:27:30 -0500 Subject: [PATCH] Add vault.metrics.collection.* metrics to documentation. (#9796) --- website/pages/docs/internals/telemetry.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/website/pages/docs/internals/telemetry.mdx b/website/pages/docs/internals/telemetry.mdx index c88b3f849..16d82cbc1 100644 --- a/website/pages/docs/internals/telemetry.mdx +++ b/website/pages/docs/internals/telemetry.mdx @@ -95,6 +95,9 @@ These metrics represent operational aspects of the running Vault instance. | `vault.core.step_down` | Duration of time taken by cluster leadership step downs. This should be monitored and alerted on for overall cluster leadership status. | ms | summary | | `vault.core.unseal` | Duration of time taken by unseal operations | ms | summary | | `vault.core.unsealed` | Has value 1 when Vault is unsealed, and 0 when Vault is sealed. | bool | gauge | +| `vault.metrics.collection` (cluster,gauge) | Time taken to collect usage gauges, labelled by gauge type. | summary | +| `vault.metrics.collection.interval` (cluster,gauge) | Current value of of usage gauge collection interval. | summary | +| `vault.metrics.collection.error` (cluster,gauge) | Errors while collection usage guages, labeled by gauge type. | counter | | `vault.rollback.attempt.` | Time taken to perform a rollback operation on the given mount point. The mount point name has its forward slashes `/` replaced by `-`. For example, a rollback operation on the `auth/token` backend would be reportes as `vault.rollback.attempt.auth-token-`. | ms | summary | | `vault.route.create.` | Time taken to dispatch a create operation to a backend, and for that backend to process it. The mount point name has its forward slashes `/` replaced by `-`. For example, a create operation to `ns1/secret/` would have corresponding metric `vault.route.create.ns1-secret-`. The number of samples of this metric, and the corresponding ones for other operations below, indicates how many operations were performed per mount point. | ms | summary | | `vault.route.delete.` | Time taken to dispatch a delete operation to a backend, and for that backend to process it. | ms | summary |