From 6c741218fe5ef98de0b865481d415e1237bd8544 Mon Sep 17 00:00:00 2001 From: Paul Schisa <75806143+pschisa@users.noreply.github.com> Date: Tue, 18 Jun 2024 13:34:31 -0400 Subject: [PATCH] Update metrics.mdx with better clarity for heartbeat_connections_received_total (#42632) * Update metrics.mdx with better clarity for heartbeat_connections_received_total adding clarity to heartbeat_connections_received_total due to confusion around what a heartbeat connection represented. Confirmed that the metric counts the number of times an agent has connected to the endpoint on auth used to periodically send heartbeats. So it represents the number of agents actively heartbeating rather than the number of heartbeats received over the lifespan of that particular auth instance. * Update docs/pages/includes/metrics.mdx Co-authored-by: Paul Gottschling * Update metrics.mdx change heartbeating to heart beating --------- Co-authored-by: Paul Gottschling --- docs/pages/includes/metrics.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/includes/metrics.mdx b/docs/pages/includes/metrics.mdx index 9fce18b948458..d1a64ba4bf241 100644 --- a/docs/pages/includes/metrics.mdx +++ b/docs/pages/includes/metrics.mdx @@ -46,7 +46,7 @@ | `grpc_server_handled_total` | counter | Teleport Auth | Total number of RPCs completed on the server, regardless of success or failure. | | `grpc_server_msg_received_total` | counter | Teleport Auth | Total number of RPC stream messages received on the server. | | `grpc_server_msg_sent_total` | counter | Teleport Auth | Total number of gRPC stream messages sent by the server. | -| `heartbeat_connections_received_total` | counter | Teleport Auth | Number of times the Auth Service received a heartbeat connection. | +| `heartbeat_connections_received_total` | counter | Teleport Auth | Number of times the Auth Service received a heartbeat connection, representing total heart beating Agents. | | `s3_requests_total` | counter | Amazon S3 | Total number of requests to the S3 API. | | `s3_requests` | counter | Amazon S3 | Total number of requests to the S3 API grouped by result. | | `s3_requests_seconds` | histogram | Amazon S3 | Request latency for the S3 API. |