From fed992e8c69b6820e6bffd9f57061ee7dc5bfde4 Mon Sep 17 00:00:00 2001
From: "deidra.prado" <108368054+deidraprado@users.noreply.github.com>
Date: Tue, 15 Jul 2025 16:22:29 -0700
Subject: [PATCH] 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>
---
 .../docs/internals/telemetry/key-metrics.mdx  | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/website/content/docs/internals/telemetry/key-metrics.mdx b/website/content/docs/internals/telemetry/key-metrics.mdx
index 0fd06b7b8c..fcac378397 100644
--- a/website/content/docs/internals/telemetry/key-metrics.mdx
+++ b/website/content/docs/internals/telemetry/key-metrics.mdx
@@ -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: