Backport of Update telemetry.mdx RPC Metrics into release/1.17.x (#19949)

* backport of commit ea114971a3

* backport of commit 8df9c6f3ba

* backport of commit e2a3294b00

---------

Co-authored-by: natemollica-dev <57850649+natemollica-nm@users.noreply.github.com>
pull/19955/head
hc-github-team-consul-core 2023-12-14 13:15:01 -06:00 committed by GitHub
parent 88d903731b
commit ed3ff29c4b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 2 deletions

View File

@ -595,7 +595,29 @@ These metrics are used to monitor the health of the Consul servers.
** Requirements: ** ** Requirements: **
* Consul 1.12.0+ * 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 | | Metric | Description | Unit | Type |
| ------------------------------------- | --------------------------------------------------------- | ------ | --------- | | ------------------------------------- | --------------------------------------------------------- | ------ | --------- |
@ -644,7 +666,6 @@ Here is a Prometheus style example of an RPC metric and its labels:
</CodeBlockConfig> </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 ## Cluster Health