mirror of https://github.com/hashicorp/consul
Backport of Update telemetry.mdx RPC Metrics into release/1.17.x (#19949)
* backport of commitpull/19955/headea114971a3
* backport of commit8df9c6f3ba
* backport of commite2a3294b00
--------- Co-authored-by: natemollica-dev <57850649+natemollica-nm@users.noreply.github.com>
parent
88d903731b
commit
ed3ff29c4b
|
@ -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
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue