Skip to content

Commit 75cc957

Browse files
jlianjlian
committed
Consistency with other metrics pages
1 parent 85d856f commit 75cc957

File tree

1 file changed

+46
-46
lines changed

1 file changed

+46
-46
lines changed

‎articles/iot-operations/reference/observability-metrics-mqtt-broker.md

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,21 @@ All metrics include the `hostname` tag to identify the pod that generated the me
3434

3535
| Metric | Description | Tags |
3636
|--------|-------------|------|
37-
| `aio_broker_publishes_received` | On the frontend, this metric represents how many incoming publish packets are received from clients. For the backend, this metric represents how many internal messages are sent from the frontend nodes. | `category` |
38-
| `aio_broker_publishes_sent` | On the frontend, this metric represents how many outgoing publish packets are sent to clients. If multiple clients are subscribed to the same topic, this metric counts each message sent, even if they have the same payload. This count doesn't count ack packets. For the backend, this metric represents how many internal messages are sent to the frontend nodes. | `category` |
39-
| `aio_broker_payload_bytes_received` | The sum of the payloads of all publishes received. This sum doesn't include the size of the properties or publish packets themselves. | `category` |
40-
| `aio_broker_payload_bytes_sent` | The sum of the payloads of all publishes sent. This sum doesn't include the size of the properties or publish packets themselves. | `category` |
41-
| `aio_broker_authentication_successes` | This metric counts the number of successful authentication requests. | `category` |
42-
| `aio_broker_authentication_failures` | This metric counts the number of failed authentication requests. For an errorless authentication server, `aio_broker_authentication_successes` + `aio_broker_authentication_failures` = `aio_broker_publishes_received = publishes_sent` | `category` |
43-
| `aio_broker_authentication_deny` | This metric counts the number of denied authentication requests. | `category` |
44-
| `aio_broker_authorization_allow` | This metric counts successfully authorization requests. This metric should always be less than or equal to `aio_broker_authentication_successes`. | `category` |
45-
| `aio_broker_authorization_deny` | This metric counts denied authorization requests. This metric should always be less than or equal to `aio_broker_authentication_successes`. | `category` |
46-
| `aio_broker_qos0_messages_dropped` | This metric counts the number of dropped QoS0 messages for any reason. The category `direction` is either `incoming` or `outgoing`. | `category`, `direction` |
47-
| `aio_broker_backpressure_packets_rejected` | This metric counts number of rejected packets due to backpressure. A packet is rejected if the system is at 97% capacity. | |
48-
| `aio_broker_store_retained_messages` | This metric counts how many retained messages are stored on the broker. | |
49-
| `aio_broker_store_retained_bytes` | This metric counts how many bytes are stored via retained messages on the broker. | |
50-
| `aio_broker_store_will_messages` | This metric counts how many will messages are stored on the broker. | |
51-
| `aio_broker_store_will_bytes` | This metric counts how many bytes are stored via will messages on the broker. | |
37+
| aio_broker_publishes_received | On the frontend, this metric represents how many incoming publish packets are received from clients. For the backend, this metric represents how many internal messages are sent from the frontend nodes. | `category` |
38+
| aio_broker_publishes_sent | On the frontend, this metric represents how many outgoing publish packets are sent to clients. If multiple clients are subscribed to the same topic, this metric counts each message sent, even if they have the same payload. This count doesn't count ack packets. For the backend, this metric represents how many internal messages are sent to the frontend nodes. | `category` |
39+
| aio_broker_payload_bytes_received | The sum of the payloads of all publishes received. This sum doesn't include the size of the properties or publish packets themselves. | `category` |
40+
| aio_broker_payload_bytes_sent | The sum of the payloads of all publishes sent. This sum doesn't include the size of the properties or publish packets themselves. | `category` |
41+
| aio_broker_authentication_successes | This metric counts the number of successful authentication requests. | `category` |
42+
| aio_broker_authentication_failures | This metric counts the number of failed authentication requests. For an errorless authentication server, `aio_broker_authentication_successes` + `aio_broker_authentication_failures` = `aio_broker_publishes_received = publishes_sent` | `category` |
43+
| aio_broker_authentication_deny | This metric counts the number of denied authentication requests. | `category` |
44+
| aio_broker_authorization_allow | This metric counts successfully authorization requests. This metric should always be less than or equal to `aio_broker_authentication_successes`. | `category` |
45+
| aio_broker_authorization_deny | This metric counts denied authorization requests. This metric should always be less than or equal to `aio_broker_authentication_successes`. | `category` |
46+
| aio_broker_qos0_messages_dropped | This metric counts the number of dropped QoS0 messages for any reason. The category `direction` is either `incoming` or `outgoing`. | `category`, `direction` |
47+
| aio_broker_backpressure_packets_rejected | This metric counts number of rejected packets due to backpressure. A packet is rejected if the system is at 97% capacity. | |
48+
| aio_broker_store_retained_messages | This metric counts how many retained messages are stored on the broker. | |
49+
| aio_broker_store_retained_bytes | This metric counts how many bytes are stored via retained messages on the broker. | |
50+
| aio_broker_store_will_messages | This metric counts how many will messages are stored on the broker. | |
51+
| aio_broker_store_will_bytes | This metric counts how many bytes are stored via will messages on the broker. | |
5252

5353
## Broker operator health metrics
5454

@@ -58,9 +58,9 @@ For example, if a backend node restarts but doesn't reconnect to its chain, ther
5858

5959
| Desired Metric | Reported Metric |
6060
|----------------|-----------------|
61-
| `aio_broker_backend_replicas` | `aio_broker_backend_replicas_current` |
62-
| `aio_broker_backend_vertical_chain` | `aio_broker_backend_vertical_chain_current` |
63-
| `aio_broker_frontend_replicas` | `aio_broker_frontend_replicas_current` |
61+
| aio_broker_backend_replicas | aio_broker_backend_replicas_current |
62+
| aio_broker_backend_vertical_chain | aio_broker_backend_vertical_chain_current |
63+
| aio_broker_frontend_replicas | aio_broker_frontend_replicas_current |
6464

6565
> [!NOTE]
6666
> `backend_vertical_chain_current` reports the number of healthy nodes in the least healthy chain. For example, if the expected chain length is 4, and three chains have 4 healthy nodes while one chain has only 2 healthy nodes, `backend_vertical_chain_current` would report 2.
@@ -71,35 +71,35 @@ These metrics provide observability for the connections and subscriptions on the
7171

7272
| Metric | Description | Tags |
7373
|--------|-------------|------|
74-
| `aio_broker_total_sessions` | On the frontend and single node broker, this metric represents how many client sessions there are. This count doesn't include disconnected persistent sessions, because a client might reconnect to a different frontend node. For the backend, this metric represents its connections to the other nodes in its chain. On the operator, this metric represents how many front and backend nodes are connected. For the authentication server, this metric represents how many frontend workers are connected (1 per frontend per thread). | `mqtt_version`: [v3/v5] <br> Backend Node Only Tags: <br> `is_tail`: [true/false] <br> `chain_id`: [n] |
75-
| `aio_broker_store_total_sessions` | This metric represents how many sessions are in backend chain. Backend nodes in the same chain should report the same number of sessions, and the sum of each chain should equal the sum of the frontend's total_sessions. | `is_persistent`: [true/false] <br> `is_tail`: [true/false] <br> `chain_id`: [n] |
76-
| `aio_broker_connected_sessions` | Same as `aio_broker_total_sessions`, except only sessions that have an active connection. | |
77-
| `aio_broker_store_connected_sessions` | Same as `aio_broker_store_total_sessions`, except only sessions that have an active connection. If `is_persistent` is false, this count should be equal to total sessions. | |
78-
| `aio_broker_total_subscriptions` | On the frontend, this metric represents how many subscriptions the currently connected sessions have. This count doesn't include disconnected persistent sessions, because a client might reconnect to a different frontend node. On the operator, this metric represents the frontend and backend nodes. For the authentication server, this metric represents how many frontend workers are connected (1 per frontend per thread). | |
79-
| `aio_broker_store_total_subscriptions` | This metric represents how many subscriptions are in backend chain. Backend nodes in the same chain should report the same number of subscriptions. This count doesn't necessarily match the frontend's `total_subscriptions`, since this metric tracks disconnected persistent sessions as well. | |
74+
| aio_broker_total_sessions | On the frontend and single node broker, this metric represents how many client sessions there are. This count doesn't include disconnected persistent sessions, because a client might reconnect to a different frontend node. For the backend, this metric represents its connections to the other nodes in its chain. On the operator, this metric represents how many front and backend nodes are connected. For the authentication server, this metric represents how many frontend workers are connected (1 per frontend per thread). | `mqtt_version`: [v3/v5] <br> Backend Node Only Tags: <br> `is_tail`: [true/false] <br> `chain_id`: [n] |
75+
| aio_broker_store_total_sessions | This metric represents how many sessions are in backend chain. Backend nodes in the same chain should report the same number of sessions, and the sum of each chain should equal the sum of the frontend's total_sessions. | `is_persistent`: [true/false] <br> `is_tail`: [true/false] <br> `chain_id`: [n] |
76+
| aio_broker_connected_sessions | Same as `aio_broker_total_sessions`, except only sessions that have an active connection. | |
77+
| aio_broker_store_connected_sessions | Same as `aio_broker_store_total_sessions`, except only sessions that have an active connection. If `is_persistent` is false, this count should be equal to total sessions. | |
78+
| aio_broker_total_subscriptions | On the frontend, this metric represents how many subscriptions the currently connected sessions have. This count doesn't include disconnected persistent sessions, because a client might reconnect to a different frontend node. On the operator, this metric represents the frontend and backend nodes. For the authentication server, this metric represents how many frontend workers are connected (1 per frontend per thread). | |
79+
| aio_broker_store_total_subscriptions | This metric represents how many subscriptions are in backend chain. Backend nodes in the same chain should report the same number of subscriptions. This count doesn't necessarily match the frontend's `total_subscriptions`, since this metric tracks disconnected persistent sessions as well. | |
8080

8181
## State store metrics
8282

8383
This set of metrics tracks the overall state of the [state store](../create-edge-apps/overview-state-store.md).
8484

8585
| Metric | Description | Tags |
8686
|--------|-------------|------|
87-
| `aio_broker_state_store_deletions` | This metric counts the number of delete key requests received, including both successful deletes and errors. | |
88-
| `aio_broker_state_store_insertions` | This metric counts the number of new key insert requests received, including both successful insertions and errors. | |
89-
| `aio_broker_state_store_keynotify_requests` | This metric counts the number of requests to monitor key changes (KEYNOTIFY) received, including both successful modifications and errors. | |
90-
| `aio_broker_state_store_modifications` | This metric counts the number of modify key requests received, including both successful modifications and errors. | |
91-
| `aio_broker_state_store_notifications_sent` | This metric counts the number of notification messages the state store sends when a key value changes and a client is registered via KEYNOTIFY. | |
92-
| `aio_broker_state_store_retrievals` | This metric counts the number of key value retrieval requests received, including both successful retrievals and errors. | |
87+
| aio_broker_state_store_deletions | This metric counts the number of delete key requests received, including both successful deletes and errors. | |
88+
| aio_broker_state_store_insertions | This metric counts the number of new key insert requests received, including both successful insertions and errors. | |
89+
| aio_broker_state_store_keynotify_requests | This metric counts the number of requests to monitor key changes (KEYNOTIFY) received, including both successful modifications and errors. | |
90+
| aio_broker_state_store_modifications | This metric counts the number of modify key requests received, including both successful modifications and errors. | |
91+
| aio_broker_state_store_notifications_sent | This metric counts the number of notification messages the state store sends when a key value changes and a client is registered via KEYNOTIFY. | |
92+
| aio_broker_state_store_retrievals | This metric counts the number of key value retrieval requests received, including both successful retrievals and errors. | |
9393

9494
## Disk-backed message buffer metrics
9595

9696
These metrics provide observability for the [disk-backed message buffer](../manage-mqtt-broker/howto-disk-backed-message-buffer.md).
9797

9898
| Metric | Description | Tags |
9999
|--------|-------------|------|
100-
| `aio_broker_buffer_pool_used_percent` | Reports the percentage of used buffer for a single frontend or backend buffer pool. | `name` |
101-
| `aio_broker_disk_transfers_completed` | Reports the number of disk transfers completed on a given backend pod. Tracks the total number of publishes transferred from a buffer pool to disk. | |
102-
| `aio_broker_disk_transfers_failed` | Reports the number of disk transfers that failed on a given backend pod. | |
100+
| aio_broker_buffer_pool_used_percent | Reports the percentage of used buffer for a single frontend or backend buffer pool. | `name` |
101+
| aio_broker_disk_transfers_completed | Reports the number of disk transfers completed on a given backend pod. Tracks the total number of publishes transferred from a buffer pool to disk. | |
102+
| aio_broker_disk_transfers_failed | Reports the number of disk transfers that failed on a given backend pod. | |
103103

104104
> [!NOTE]
105105
> Only certain backend buffer pools, specifically the dynamic ones named "reader", use the disk-backed message buffer feature. These pools store subscriber message queues and transfer elements to disk when usage exceeds 75%.
@@ -108,26 +108,26 @@ These metrics provide observability for the [disk-backed message buffer](../mana
108108

109109
| Metric | Description |
110110
|--------|-------------|
111-
| `aio_broker_store_transfer_batch_receiver_message_count` | This metric reports the number of messages received by the store transfer receiver. This count should be equal to the number of messages sent by the store transfer sender. |
112-
| `aio_broker_store_transfer_batch_sender_transfer_bytes` | This metric reports the number of bytes sent by the store transfer sender. |
113-
| `aio_broker_store_transfer_batch_sender_message_count` | This metric reports the number of messages sent by the store transfer sender. |
114-
| `aio_broker_store_transfer_ack_event_receiver_message_count` | This metric reports the number of ack event messages received by the store transfer receiver. This count should be equal to the number of ack event messages sent by the store transfer sender. |
115-
| `aio_broker_store_transfer_ack_event_sender_message_count` | This metric reports the number of ack event messages sent by the store transfer sender. |
116-
| `aio_broker_store_transfer_ack_event_sender_transfer_bytes` | This metric reports the number of bytes sent by the store transfer sender for ack events. |
117-
| `aio_broker_store_transfer_patch_tracker_receiver_message_count` | This metric reports the number of patch tracker messages received by the store transfer receiver. This count should be equal to the number of patch tracker messages sent by the store transfer sender. |
118-
| `aio_broker_store_transfer_patch_tracker_sender_message_count` | This metric reports the number of patch tracker messages sent by the store transfer sender. |
111+
| aio_broker_store_transfer_batch_receiver_message_count | This metric reports the number of messages received by the store transfer receiver. This count should be equal to the number of messages sent by the store transfer sender. |
112+
| aio_broker_store_transfer_batch_sender_transfer_bytes | This metric reports the number of bytes sent by the store transfer sender. |
113+
| aio_broker_store_transfer_batch_sender_message_count | This metric reports the number of messages sent by the store transfer sender. |
114+
| aio_broker_store_transfer_ack_event_receiver_message_count | This metric reports the number of ack event messages received by the store transfer receiver. This count should be equal to the number of ack event messages sent by the store transfer sender. |
115+
| aio_broker_store_transfer_ack_event_sender_message_count | This metric reports the number of ack event messages sent by the store transfer sender. |
116+
| aio_broker_store_transfer_ack_event_sender_transfer_bytes | This metric reports the number of bytes sent by the store transfer sender for ack events. |
117+
| aio_broker_store_transfer_patch_tracker_receiver_message_count | This metric reports the number of patch tracker messages received by the store transfer receiver. This count should be equal to the number of patch tracker messages sent by the store transfer sender. |
118+
| aio_broker_store_transfer_patch_tracker_sender_message_count | This metric reports the number of patch tracker messages sent by the store transfer sender. |
119119

120120
## Developer metrics
121121

122122
These metrics are useful for developer debugging.
123123

124124
| Metric | Description |
125125
|--------|-------------|
126-
| `aio_broker_patch_tracker_held_patches` | This metric reports how many patches are currently held within a node in a chain. |
127-
| `aio_broker_ack_handler_pending_transactions` | This metric reports how many transactions are currently pending in the ack handler. |
128-
| `aio_broker_client_connected` | This metric reports how many clients are connected. |
129-
| `aio_broker_client_disconnected` | This metric reports how many clients are disconnected. |
130-
| `aio_broker_client_removed` | This metric reports how many clients are removed. |
126+
| aio_broker_patch_tracker_held_patches | This metric reports how many patches are currently held within a node in a chain. |
127+
| aio_broker_ack_handler_pending_transactions | This metric reports how many transactions are currently pending in the ack handler. |
128+
| aio_broker_client_connected | This metric reports how many clients are connected. |
129+
| aio_broker_client_disconnected | This metric reports how many clients are disconnected. |
130+
| aio_broker_client_removed | This metric reports how many clients are removed. |
131131

132132
## Related content
133133

0 commit comments

Comments
 (0)