Skip to content

Commit beab44f

Browse files
Merge pull request #312102 from jlian/fix/built-in-metrics-missing
Add 4 undocumented built-in metrics to IoT Edge metrics reference
2 parents 47c1583 + 264f046 commit beab44f

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

articles/iot-edge/how-to-access-built-in-metrics.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Access built-in metrics from IoT Edge runtime components to monitor
44
#customer intent: As a system administrator, I want to access built-in metrics in Azure IoT Edge so that I can monitor and understand the health of my IoT Edge devices.
55
author: sethmanheim
66
ms.author: sethm
7-
ms.date: 05/08/2025
7+
ms.date: 02/20/2026
88
ms.topic: concept-article
99
ms.service: azure-iot-edge
1010
services: iot-edge
@@ -82,6 +82,9 @@ The **edgeHub** module generates the following metrics:
8282
| `edgehub_offline_duration_seconds`| `id` | Type: summary<br> Time edge hub was offline |
8383
| `edgehub_operation_retry_total` | `id`<br> `operation` (operation name) | Type: counter<br> Total number of times edgeHub operations were retried |
8484
| `edgehub_client_connect_failed_total` | `id` <br> `reason` (not authenticated)<br> | Type: counter<br> Total number of times clients failed to connect to edgeHub |
85+
| `edgehub_client_connect_success_total` | `id` | Type: counter<br> Total number of times clients successfully connected to edgeHub |
86+
| `edgehub_client_disconnect_total` | `id` | Type: counter<br> Total number of times clients disconnected from edgeHub |
87+
| `edgehub_connected_clients` | | Type: gauge<br> Current number of clients connected to edgeHub |
8588

8689
The **edgeAgent** module generates the following metrics:
8790

@@ -91,6 +94,7 @@ The **edgeAgent** module generates the following metrics:
9194
| `edgeAgent_total_time_expected_running_seconds` | `module_name` | Type: gauge<br> The amount of time the module was specified in the deployment |
9295
| `edgeAgent_module_start_total` | `module_name`, `module_version` | Type: counter<br> Number of times edgeAgent asked docker to start the module |
9396
| `edgeAgent_module_stop_total` | `module_name`, `module_version` | Type: counter<br> Number of times edgeAgent asked docker to stop the module |
97+
| `edgeAgent_module_prepare_update_total` | `module_name`, `module_version` | Type: counter<br> Number of times edgeAgent prepared a module update |
9498
| `edgeAgent_command_latency_seconds` | `command` | Type: gauge<br> How long it took docker to execute the given command. Possible commands are: create, update, remove, start, stop, and restart |
9599
| `edgeAgent_iothub_syncs_total` | | Type: counter<br> Number of times edgeAgent attempted to sync its twin with iotHub, both successful and unsuccessful. This number includes both Agent requesting a twin and Hub notifying of a twin update |
96100
| `edgeAgent_unsuccessful_iothub_syncs_total` | | Type: counter<br> Number of times edgeAgent failed to sync its twin with iotHub. |

0 commit comments

Comments
 (0)