From c0f52d42a43058b7d520fae35a8d2fb1f7d4903c Mon Sep 17 00:00:00 2001
From: hc-github-team-secure-vault-core
<82990506+hc-github-team-secure-vault-core@users.noreply.github.com>
Date: Fri, 1 Sep 2023 13:58:15 -0400
Subject: [PATCH] backport of commit 133e9ac793bc948c2576df53bbe9adde29fcdd6d
(#22736)
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
---
.../internals/telemetry/enable-telemetry.mdx | 13 ++++++-------
.../content/docs/internals/telemetry/index.mdx | 16 ++++++++++++----
2 files changed, 18 insertions(+), 11 deletions(-)
diff --git a/website/content/docs/internals/telemetry/enable-telemetry.mdx b/website/content/docs/internals/telemetry/enable-telemetry.mdx
index f9a5411424..71ae8d58f5 100644
--- a/website/content/docs/internals/telemetry/enable-telemetry.mdx
+++ b/website/content/docs/internals/telemetry/enable-telemetry.mdx
@@ -62,13 +62,9 @@ telemetry {
}
```
-
-
- Many metrics solutions charge by the metric. You can set `filter_default` to
- false and use the `prefix_filter` parameter to include and exclude specific
- values based on metric name to avoid paying for irrelevant information.
-
-
+Many metrics solutions charge by the metric. You can set `filter_default` to
+false and use the `prefix_filter` parameter to include and exclude specific
+values based on metric name to avoid paying for irrelevant information.
For example, to limit your telemetry to the core token metrics plus the number
of leases set to expire:
@@ -100,6 +96,9 @@ Popular reporting solutions compatible with Vault:
## Next steps
+- Review the
+ [Key metrics for common health checks](/well-architected-framework/reliability/reliability-vault-monitoring-key-metrics)
+ guide to identify metrics you may want to start monitoring immediately.
- Review the full list of available
[telemetry parameters](/vault/docs/configuration/telemetry#telemetry-parameters).
- Review the [Monitor telemetry and audit device log data](/vault/tutorials/monitoring/monitor-telemetry-audit-splunk)
diff --git a/website/content/docs/internals/telemetry/index.mdx b/website/content/docs/internals/telemetry/index.mdx
index 517328d11f..c4b36b84aa 100644
--- a/website/content/docs/internals/telemetry/index.mdx
+++ b/website/content/docs/internals/telemetry/index.mdx
@@ -13,12 +13,20 @@ of different libraries and subsystems. These metrics are aggregated on a
metrics, like `vault.kv.secret.count`, report every 10 minutes or at an interval
configured with in the `telemetry` stanza.
+Telemetry from Vault must be streamed and stored in metrics aggregation
+software to monitor Vault and collect durable metrics.
+
@include 'telemetry/supported-aggregation-agents.mdx'
-
- Telemetry from Vault must be streamed and stored in metrics aggregation
- software to monitor Vault and collect durable metrics.
-
+
+
+ The [Well-Architected Framework](/well-architected-framework) documentation
+ includes a best practices guide on
+ [key Vault metrics for common health checks](/well-architected-framework/reliability/reliability-vault-monitoring-key-metrics).
+ We recommend reviewing the key metric recommendations to identify metrics you
+ may want to start monitoring immediately.
+
+
## Working with raw telemetry data