Update telemetry.mdx RPC Metrics (#19593)

* Update telemetry.mdx RPC Metrics Update Server Workload telemetry section to demonstrate explicitly enabling metric emission as they're [default disabled](https://github.com/hashicorp/consul/blob/f5bf256425e33c0da805eda6a2fc5ea05100d491/agent/config/builder.go#L2763C1-L2763C1). * Update telemetry.mdx Co-authored-by: trujillo-adam <[email protected]> * Update telemetry.mdx Co-authored-by: trujillo-adam <[email protected]> --------- Co-authored-by: trujillo-adam <[email protected]>
hashicorp · Dec 14, 2023 · afc6fe8 · afc6fe8
1 parent 0250e23
commit afc6fe8
Showing 1 changed file with 23 additions and 2 deletions.
diff --git a/website/content/docs/agent/telemetry.mdx b/website/content/docs/agent/telemetry.mdx
@@ -595,7 +595,29 @@ These metrics are used to monitor the health of the Consul servers.
 ** Requirements: **
 * Consul 1.12.0+
 
-Label based RPC metrics were added in Consul 1.12.0 as a Beta feature to better understand the workload on a Consul server and, where that workload is coming from. The following metric(s) provide that insight
+The following label-based RPC metrics provide insight about the workload on a Consul server and the source of the workload.
+
+The [`prefix_filter`](/consul/docs/agent/config/config-files#telemetry-prefix_filter) telemetry configuration setting blocks or enables all RPC metric method calls. Specify the RPC metrics you want to allow in the `prefix_filter`:
+
+<CodeTabs heading="Example prefix_filter allowing all RPC metrics">
+
+```hcl
+telemetry {
+  prefix_filter = ["+consul.rpc.server.call"]
+}
+```
+
+```json
+{
+  "telemetry": {
+    "prefix_filter": [
+      "+consul.rpc.server.call"
+    ]
+  }
+}
+```
+
+</CodeTabs>
 
 | Metric                                | Description                                               | Unit   | Type      |
 | ------------------------------------- | --------------------------------------------------------- | ------ | --------- |
@@ -644,7 +666,6 @@ Here is a Prometheus style example of an RPC metric and its labels:
 
 </CodeBlockConfig>
 
-Any metric in this section can be turned off with the [`prefix_filter`](/consul/docs/agent/config/config-files#telemetry-prefix_filter).
 
 ## Cluster Health