Skip to content

Commit

Permalink
add docs for new labels (#12757)
Browse files Browse the repository at this point in the history
  • Loading branch information
@FFMMM @hc-github-team-consul-core
FFMMM authored and hc-github-team-consul-core committed Apr 12, 2022
1 parent eacad41 commit 9096765
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions website/content/docs/agent/telemetry.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -537,12 +537,13 @@ Note that values of the `consul.rpc.server.call` may emit as `0 ms`. That means

The the server workload metrics above come with the following labels:

| Label Name | Description | Possible values |
| ------------------------------------- | --------------------------------------------------------- | --------------------------------------- |
| `method` | The name of the RPC method. | The value of any RPC request in Consul. |
| `errored` | Indicates whether the RPC call errored. | `True` or `False`. |
| `request_type` | Whether it is a `read` or `write` request. | `read`, `write` or `unreported`. |
| `rpc_type` | The RPC implementation. | `net/rpc` or `internal`. |
| Label Name | Description | Possible values |
| ------------------------------------- | -------------------------------------------------------------------- | --------------------------------------- |
| `method` | The name of the RPC method. | The value of any RPC request in Consul. |
| `errored` | Indicates whether the RPC call errored. | `true` or `false`. |
| `request_type` | Whether it is a `read` or `write` request. | `read`, `write` or `unreported`. |
| `rpc_type` | The RPC implementation. | `net/rpc` or `internal`. |
| `leader` | Whether the server was a `leader` or not at the time of the request. | `true`, `false` or `unreported`. |

#### Label Explanations

Expand All @@ -551,6 +552,18 @@ Historically, `internal` RPC operation metrics were accounted under the same met

The `unreported` value for the `request_type` in the table above refers to RPC requests within Consul where it is difficult to ascertain whether a request is `read` or `write` type.

The `unreported` value for the `leader` label in the table above refers to RPC requests where Consul cannot determine the leadership status for a server.

#### Read Request Labels

In addition to the labels above, for read requests, the following may be populated:

| Label Name | Description | Possible values |
| ------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `blocking` | Whether the read request passed in a `MinQueryIndex`. | `true` if a MinQueryIndex was passed, `false` otherwise. |
| `target_datacenter` | The target datacenter for the read request. | The string value of the target datacenter for the request. |
| `locality` | Gives an indication of whether the RPC request is local or has been forwarded. | `local` if current server data center is the same as `target_datacenter`, otherwise `forwarded`. |

Here is a Prometheus style example of an RPC metric and its labels:

<CodeBlockConfig heading="Sample output of telemetry dump">
Expand Down

0 comments on commit 9096765

Please sign in to comment.