Backport of Fix a couple typos in Agent Telemetry Metrics docs into release/1.16.x (#18084)

* backport of commit 58ef5fdd8f11e4e773977b48bdb6bb196a7c874d

* backport of commit 857427ae8ca887f3c8ce33bde971c1b26ac7c37e

---------

Co-authored-by: josh <josh.timmons@hashicorp.com>
This commit is contained in:
hc-github-team-consul-core 2023-07-11 15:33:39 -05:00 committed by GitHub
parent 60c14f0224
commit 0cf2f4b797
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 5 deletions

3
.changelog/18080.txt Normal file
View File

@ -0,0 +1,3 @@
```release-note:improvement
Fix some typos in metrics docs
```

View File

@ -489,8 +489,8 @@ These metrics are used to monitor the health of the Consul servers.
| `consul.raft.leader.oldestLogAge` | The number of milliseconds since the _oldest_ log in the leader's log store was written. This can be important for replication health where write rate is high and the snapshot is large as followers may be unable to recover from a restart if restoring takes longer than the minimum value for the current leader. Compare this with `consul.raft.fsm.lastRestoreDuration` and `consul.raft.rpc.installSnapshot` to monitor. In normal usage this gauge value will grow linearly over time until a snapshot completes on the leader and the log is truncated. Note: this metric won't be emitted until the leader writes a snapshot. After an upgrade to Consul 1.10.0 it won't be emitted until the oldest log was written after the upgrade. | ms | gauge |
| `consul.raft.replication.heartbeat` | Measures the time taken to invoke appendEntries on a peer, so that it doesn't timeout on a periodic basis. | ms | timer |
| `consul.raft.replication.appendEntries` | Measures the time it takes to replicate log entries to followers. This is a general indicator of the load pressure on the Consul servers, as well as the performance of the communication between the servers. | ms | timer |
| `consul.raft.replication.appendEntries.rpc` | Measures the time taken by the append entries RFC, to replicate the log entries of a leader agent onto its follower agent(s) | ms | timer |
| `consul.raft.replication.appendEntries.logs` | Measures the number of logs replicated to an agent, to bring it up to speed with the leader's logs. | logs appended/ interval | counter |
| `consul.raft.replication.appendEntries.rpc` | Measures the time taken by the append entries RPC to replicate the log entries of a leader agent onto its follower agent(s). | ms | timer |
| `consul.raft.replication.appendEntries.logs` | Counts the number of logs replicated to an agent to bring it up to speed with the leader's logs. | logs appended/ interval | counter |
| `consul.raft.restore` | Counts the number of times the restore operation has been performed by the agent. Here, restore refers to the action of raft consuming an external snapshot to restore its state. | operation invoked / interval | counter |
| `consul.raft.restoreUserSnapshot` | Measures the time taken by the agent to restore the FSM state from a user's snapshot | ms | timer |
| `consul.raft.rpc.appendEntries` | Measures the time taken to process an append entries RPC call from an agent. | ms | timer |
@ -562,12 +562,12 @@ These metrics are used to monitor the health of the Consul servers.
| `consul.leader.replication.namespaces.status` | <EnterpriseAlert inline /> This will only be emitted by the leader in a secondary datacenter. The value will be a 1 if the last round of namespace replication was successful or 0 if there was an error. | healthy | gauge |
| `consul.leader.replication.namespaces.index` | <EnterpriseAlert inline /> This will only be emitted by the leader in a secondary datacenter. Increments to the index of namespaces in the primary datacenter that have been successfully replicated. | index | gauge |
| `consul.prepared-query.apply` | Measures the time it takes to apply a prepared query update. | ms | timer |
| `consul.prepared-query.explain` | Measures the time it takes to process a prepared query explain request. | ms | timer |
| `consul.prepared-query.execute` | Measures the time it takes to process a prepared query execute request. | ms | timer |
| `consul.prepared-query.execute_remote` | Measures the time it takes to process a prepared query execute request that was forwarded to another datacenter. | ms | timer |
| `consul.prepared-query.execute` | Measures the time it takes to process a prepared query execute request. | ms | timer |
| `consul.prepared-query.explain` | Measures the time it takes to process a prepared query explain request. | ms | timer |
| `consul.rpc.raft_handoff` | Increments when a server accepts a Raft-related RPC connection. | connections | counter |
| `consul.rpc.request_error` | Increments when a server returns an error from an RPC request. | errors | counter |
| `consul.rpc.request` | Increments when a server receives a Consul-related RPC request. | requests | counter |
| `consul.rpc.request_error` | Increments when a server returns an error from an RPC request. | errors | counter |
| `consul.rpc.query` | Increments when a server receives a read RPC request, indicating the rate of new read queries. See consul.rpc.queries_blocking for the current number of in-flight blocking RPC calls. This metric changed in 1.7.0 to only increment on the the start of a query. The rate of queries will appear lower, but is more accurate. | queries | counter |
| `consul.rpc.queries_blocking` | The current number of in-flight blocking queries the server is handling. | queries | gauge |
| `consul.rpc.cross-dc` | Increments when a server sends a (potentially blocking) cross datacenter RPC query. | queries | counter |