You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/iot-operations/reference/observability-metrics-mqtt-broker.md
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,11 +30,7 @@ Sessions without a `metriccategory` are tagged as "category=uncategorized".
30
30
31
31
## Messaging metrics
32
32
33
-
All metrics include the `hostname` tag to distinguish the pod that generated the metrics. The tags listed in the individual metric descriptions are additional to this tag.
34
-
35
-
## Messaging metrics
36
-
37
-
All metrics include the `hostname` tag to distinguish the pod that generated the metrics. The tags listed in the individual metric descriptions are additional to this tag.
33
+
All metrics include the `hostname` tag to identify the pod that generated the metrics. The tags listed in the individual metric descriptions are added to this tag.
38
34
39
35
| Metric | Description | Tags |
40
36
|--------|-------------|------|
@@ -75,12 +71,12 @@ These metrics provide observability for the connections and subscriptions on the
75
71
76
72
| Metric | Description | Tags |
77
73
|--------|-------------|------|
78
-
|`aio_broker_total_sessions`| On the frontend and single node broker, this metric represents how many client sessions there are. This 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]|
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]|
79
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]|
80
76
|`aio_broker_connected_sessions`| Same as `aio_broker_total_sessions`, except only sessions that have an active connection. ||
81
-
|`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 should be equal to total sessions. ||
82
-
|`aio_broker_total_subscriptions`| On the frontend, this metric represents how many subscriptions the currently connected sessions have. This 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). ||
83
-
|`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 will not necessarily match the frontend's total_subscriptions, since this metric tracks disconnected persistent sessions as well. ||
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. ||
84
80
85
81
## State store metrics
86
82
@@ -92,7 +88,7 @@ This set of metrics tracks the overall state of the [state store](../create-edge
92
88
|`aio_broker_state_store_insertions`| This metric counts the number of new key insert requests received, including both successful insertions and errors. ||
93
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. ||
94
90
|`aio_broker_state_store_modifications`| This metric counts the number of modify key requests received, including both successful modifications and errors. ||
95
-
|`aio_broker_state_store_notifications_sent`| This metric counts the number of notification messages sent by the state store in response to key value changes when a client is registered via KEYNOTIFY. ||
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. ||
96
92
|`aio_broker_state_store_retrievals`| This metric counts the number of key value retrieval requests received, including both successful retrievals and errors. ||
97
93
98
94
## Disk-backed message buffer metrics
@@ -118,12 +114,12 @@ These metrics provide observability for the [disk-backed message buffer](../mana
118
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. |
119
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. |
120
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. |
121
-
|`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 should be equal to the number of patch tracker messages sent by the store transfer sender. |
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. |
122
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. |
123
119
124
120
## Developer metrics
125
121
126
-
These are metrics that are useful for debugging purposes for developers.
0 commit comments