mirrors/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2025-11-28 22:21:30 +01:00
Code Issues Projects Releases Wiki Activity

Document bolt metrics (#12107)

Browse Source
This commit is contained in:
Josh Black 2021-07-16 11:44:30 -07:00 committed by GitHub
parent e354722f9e
commit 1e68be76e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 66 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
website/content/docs/internals/telemetry.mdx
View File

@ -378,7 +378,7 @@ These metrics relate to the supported [storage backends][storage-backends].
These metrics relate to raft based [integrated storage][integrated-storage].
| Metric | Description | Unit | Type |
| :------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------- | :------ |
| :--------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------- | :------ |
| `vault.raft.apply` | Number of Raft transactions occurring over the interval, which is a general indicator of the write load on the Raft servers. | raft transactions / interval | counter |
| `vault.raft.barrier` | Number of times the node has started the barrier i.e the number of times it has issued a blocking call, to ensure that the node has all the pending operations that were queued, to be applied to the node's FSM. | blocks / interval | counter |
| `vault.raft.candidate.electSelf` | Time to request for a vote from a peer. | ms | summary |
@ -425,6 +425,24 @@ These metrics relate to raft based [integrated storage][integrated-storage].
| `vault.raft-storage.list` | Time to list all entries under the prefix from the FSM. | ms | timer |
| `vault.raft-storage.transaction` | Time to insert operations into a single log. | ms | timer |
| `vault.raft-storage.entry_size` | The total size of a Raft entry during log application in bytes. | bytes | sample |
| `vault.raft_storage.bolt.freelist.`<br/>`free_pages` | Number of free pages in the freelist. | pages | gauge |
| `vault.raft_storage.bolt.freelist.`<br/>`pending_pages` | Number of pending pages in the freelist. | pages | gauge |
| `vault.raft_storage.bolt.freelist.`<br/>`allocated_bytes` | Total bytes allocated in free pages. | bytes | gauge |
| `vault.raft_storage.bolt.freelist.`<br/>`used_bytes` | Total bytes used by the freelist. | bytes | gauge |
| `vault.raft_storage.bolt.transaction.`<br/>`started_read_transactions` | Number of started read transactions. | transactions | gauge |
| `vault.raft_storage.bolt.transaction.`<br/>`currently_open_read_transactions` | Number of currently open read transactions. | transactions | gauge |
| `vault.raft_storage.bolt.page.count` | Number of page allocations. | allocations | gauge |
| `vault.raft_storage.bolt.page.`<br/>`bytes_allocated` | Total bytes allocated. | bytes | gauge |
| `vault.raft_storage.bolt.cursor.count` | Number of cursors created. | cursors | gauge |
| `vault.raft_storage.bolt.node.count` | Number of node allocations. | nodes | gauge |
| `vault.raft_storage.bolt.node.dereferences` | Number of node dereferences. | dereferences | gauge |
| `vault.raft_storage.bolt.rebalance.count` | Number of node rebalances. | rebalances | gauge |
| `vault.raft_storage.bolt.rebalance.time` | Time taken rebalancing. | ms | sample |
| `vault.raft_storage.bolt.split.count` | Number of nodes split. | nodes | gauge |
| `vault.raft_storage.bolt.spill.count` | Number of nodes spilled. | nodes | gauge |
| `vault.raft_storage.bolt.spill.time` | Time taken spilling. | ms | sample |
| `vault.raft_storage.bolt.write.count` | Number of writes performed. | writes | gauge |
| `vault.raft_storage.bolt.write.time` | Time taken writing to disk. | ms | sample |
## Integrated Raft Storage Leadership Changes