From afc6fe83080a4ccefc32ed9613605df4e076a5ec Mon Sep 17 00:00:00 2001 From: natemollica-dev <57850649+natemollica-nm@users.noreply.github.com> Date: Thu, 14 Dec 2023 10:52:45 -0800 Subject: [PATCH] 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 <47586768+trujillo-adam@users.noreply.github.com> * Update telemetry.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --------- Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/content/docs/agent/telemetry.mdx | 25 ++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/website/content/docs/agent/telemetry.mdx b/website/content/docs/agent/telemetry.mdx index 82594504bacb..322ec40997d1 100644 --- 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`: + + + +```hcl +telemetry { + prefix_filter = ["+consul.rpc.server.call"] +} +``` + +```json +{ + "telemetry": { + "prefix_filter": [ + "+consul.rpc.server.call" + ] + } +} +``` + + | Metric | Description | Unit | Type | | ------------------------------------- | --------------------------------------------------------- | ------ | --------- | @@ -644,7 +666,6 @@ Here is a Prometheus style example of an RPC metric and its labels: -Any metric in this section can be turned off with the [`prefix_filter`](/consul/docs/agent/config/config-files#telemetry-prefix_filter). ## Cluster Health