Update key-metrics.mdx to add runtime metrics (#29434)

* Update key-metrics.mdx

added runtime metrics to Resource metrics section

* Update website/content/docs/internals/telemetry/key-metrics.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/internals/telemetry/key-metrics.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
This commit is contained in:
deidra.prado 2025-07-15 16:22:29 -07:00 committed by GitHub
parent 0a281417bf
commit fed992e8c6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -205,6 +205,38 @@ Refer to the [Blocked audit devices](/vault/tutorials/monitoring/blocked-audit-d
## Resource metrics
### Runtime metrics
#### Metrics:
`vault.runtime.num_goroutines`
`vault.runtime.heap_objects`
#### Background:
A fundamental part of the Vault runtime are
[`goroutines`](https://go.dev/tour/concurrency/1). `goroutines` are lightweight
threads managed by the Go runtime that many functions within Vault create as
part of the runtime.
We recommend monitoring key metrics of the runtime to establish an accurate
baseline and alerting thresholds for the health of your Vault installation.
#### Alerting:
Two key alerting metrics to track are `vault.runtime.num_goroutines` and
`vault.runtime.heap_objects`:
- Sudden increases to `vault.runtime.num_goroutines` can indicate there is
something affecting system load warrant investigation.
- Changes to `vault.runtime.heap_objects` can indicate memory pressure.
Having accurate baselines and alert thresholds for `vault.runtime.heap_objects`
and `vault.runtime.heap_objects` can help you identify potential performance
issues before they become a problem.
### Vault memory issues indicated by garbage collection
#### Metrics: