Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c7c430
Update key-metrics.mdx
deidraprado Jan 28, 2025
24c7439
Update website/content/docs/internals/telemetry/key-metrics.mdx
deidraprado Jan 30, 2025
c17d826
Update website/content/docs/internals/telemetry/key-metrics.mdx
deidraprado Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions website/content/docs/internals/telemetry/key-metrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading