Vault
Automated snapshots telemetry
[!IMPORTANT]
Documentation Update: Product documentation, which were located in this repository under/website, are now located inhashicorp/web-unified-docs, colocated with all other product documentation. Contributions to this content should be done in theweb-unified-docsrepo, and not this one. Changes made to/websitecontent in this repo will not be reflected on the developer.hashicorp.com website.
Enterprise
This feature requires Vault Enterprise(opens in new tab).
Automated snapshot telemetry provides information on automatically scheduled snapshot activity for the Raft storage snapshot feature.
Default metrics
vault.autosnapshots.last.success.time
| Metric type | Value | Description |
|---|---|---|
| gauge | timestamp | Epoch time (seconds since 1970-01-01) of the last successful snapshot save |
vault.autosnapshots.percent.maxspace.used
| Metric type | Value | Description |
|---|---|---|
| gauge | percentage | The percentage of space currently used on local storage (disk) by saved snapshots |
Vault only populates the vault.autosnapshots.percent.maxspace.used metric when
the storage type for autosnapshot is local. The percentage of used space is
relative to the maximum allocated space for snapshots, not the total available
space on local storage.
vault.autosnapshots.rotate.duration
| Metric type | Value | Description |
|---|---|---|
| summary | ms | The time taken to rotate out the snapshot indicated by snapshot_config_name |
Vault deletes snapshots to adhere to the configured retention period. The rotation metric specifically measures the time taken to delete the snapshot once the retention period expires.
vault.autosnapshots.save.duration
| Metric type | Value | Description |
|---|---|---|
| summary | ms | The time taken to save the snapshot indicated by snapshot_config_name |
vault.autosnapshots.save.errors
| Metric type | Value | Description |
|---|---|---|
| counter | number | The number of errors encountered while trying to save the snapshot indicated by snapshot_config_name |
vault.autosnapshots.snapshot.size
| Metric type | Value | Description |
|---|---|---|
| summary | bytes | The current size of the snapshot indicated by snapshot_config_name |
vault.autosnapshots.total.snapshot.size
| Metric type | Value | Description |
|---|---|---|
| gauge | bytes | The space currently used on local storage (disk) by saved snapshots |
Vault only populates the vault.autosnapshots.total.snapshot.size metric when
the storage type for autosnapshot is local.