github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update telemetry.mdx RPC Metrics 

Update Server Workload telemetry section to demonstrate explicitly enabling metric emission as they're [default disabled](f5bf256425/agent/config/builder.go (L2763C1-L2763C1)).
pull/19593/head
natemollica-dev 2023-11-09 10:22:53 -08:00 committed by GitHub
parent f5bf256425
commit ea114971a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
website/content/docs/agent/telemetry.mdx
View File

@ -595,7 +595,30 @@ 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
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.
All RPC metric method calls are by default blocked via the [`prefix_filter`](/consul/docs/agent/config/config-files#telemetry-prefix_filter) telemetry configuration setting. You can enable all RPC metric server
calls and/or explicity deny RPC calls using the same configuration setting.
<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 +667,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