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-edge/configure-device.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ The **hostname**, **parent_hostname**, **trust_bundle_cert**, **allow_elevated_d
26
26
27
27
### Hostname
28
28
29
-
To enable gateway discovery, every IoT Edge gateway (parent) device needs to specify a hostname parameter that its child devices use to find it on the local network. The *edgeHub* module also uses the hostname parameter to match with its server certificate. For more information, see [Why does EdgeGateway need to be told about its own hostname?](iot-edge-certs.md#why-does-edgegateway-need-to-be-told-about-its-own-hostname)
29
+
To enable gateway discovery, every IoT Edge gateway (parent) device needs to specify a hostname parameter that its child devices use to find it on the local network. The *edgeHub* module also uses the hostname parameter to match with its server certificate. For more information, see [Why does EdgeGateway need to be told about its own hostname?](iot-edge-certs.md#why-does-edgegateway-need-to-know-its-own-hostname)
30
30
31
31
> [!NOTE]
32
32
> When the hostname value isn't set, IoT Edge attempts to find it automatically. However, clients in the network might not be able to discover the device if it isn't set.
Copy file name to clipboardExpand all lines: articles/iot-edge/how-to-access-built-in-metrics.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Access built-in metrics from IoT Edge runtime components to monitor
4
4
#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.
5
5
author: sethmanheim
6
6
ms.author: sethm
7
-
ms.date: 02/20/2026
7
+
ms.date: 03/02/2026
8
8
ms.topic: concept-article
9
9
ms.service: azure-iot-edge
10
10
services: iot-edge
@@ -18,9 +18,9 @@ The IoT Edge runtime components, IoT Edge hub, and IoT Edge agent, produce built
18
18
19
19
Use your own solution to access these metrics, or use the [metrics-collector module](https://mcr.microsoft.com/artifact/mar/azureiotedge-metrics-collector/tags), which collects the built-in metrics and sends them to Azure Monitor or Azure IoT Hub. For more information, see [Collect and transport metrics](how-to-collect-and-transport-metrics.md).
20
20
21
-
Metrics are exposed by default on **port 9600** of the **edgeHub** and **edgeAgent** modules (`http://edgeHub:9600/metrics` and `http://edgeAgent:9600/metrics`). They aren't mapped to the host by default.
21
+
By default, the **edgeHub** and **edgeAgent** modules expose metrics on **port 9600**(`http://edgeHub:9600/metrics` and `http://edgeAgent:9600/metrics`). The metrics aren't mapped to the host by default.
22
22
23
-
Access metrics from the host by exposing and mapping the metrics port in the module's `createOptions`. The following example maps the default metrics port to port 9601 on the host:
23
+
To access metrics from the host, expose and map the metrics port in the module's `createOptions`. The following example maps the default metrics port to port 9601 on the host:
24
24
25
25
```json
26
26
{
@@ -42,9 +42,9 @@ Access metrics from the host by exposing and mapping the metrics port in the mod
42
42
Choose different and unique host port numbers when mapping both the edgeHub and edgeAgent metrics endpoints.
43
43
44
44
> [!NOTE]
45
-
> The environment variable `httpSettings__enabled`must not be set to `false` for built-in metrics to be available for collection.
45
+
> You must set the environment variable `httpSettings__enabled` to `true` for collection of built-in metrics.
46
46
>
47
-
> Environment variables that can be used to disable metrics are listed in the [azure/iotedge repo doc](https://github.com/Azure/iotedge/blob/main/doc/EnvironmentVariables.md).
47
+
> For more information about environment variables that can disable metrics, see the [azure/iotedge repo doc](https://github.com/Azure/iotedge/blob/main/doc/EnvironmentVariables.md).
48
48
49
49
## Available metrics
50
50
@@ -54,7 +54,7 @@ Metrics include tags that identify the nature of the metric being collected. All
54
54
|-|-|
55
55
| iothub | The hub the device communicates with |
56
56
| edge_device | The ID of the current device |
57
-
| instance_number | A GUID representing the current runtime. On restart, all metrics are reset. This GUID makes it easier to reconcile restarts. |
57
+
| instance_number | A GUID representing the current runtime. On restart, all metrics reset. This GUID makes it easier to reconcile restarts. |
58
58
59
59
The Prometheus exposition format includes four core metric types: counter, gauge, histogram, and summary. For more information about the different metric types, see the [Prometheus metric types documentation](https://prometheus.io/docs/concepts/metric_types/).
60
60
@@ -64,10 +64,10 @@ The **edgeHub** module generates the following metrics:
64
64
65
65
| Name | Dimensions | Description |
66
66
|-|-|-|
67
-
|`edgehub_gettwin_total`|`source` (operation source)<br> `id` (module ID) | Type: counter<br> Total number of GetTwin calls |
68
-
|`edgehub_messages_received_total`|`route_output` (output that sent message)<br> `id`| Type: counter<br> Total number of messages received from clients |
69
-
|`edgehub_messages_sent_total`|`from` (message source)<br> `to` (message destination)<br>`from_route_output`<br> `to_route_input` (message destination input)<br> `priority` (message priority to destination) | Type: counter<br> Total number of messages sent to clients or upstream<br> `to_route_input` is empty when `to` is $upstream |
|`edgehub_gettwin_total`|`source` (operation source)<br> `id` (module ID) | Type: counter<br> Total number of GetTwin calls.|
68
+
|`edgehub_messages_received_total`|`route_output` (output that sent message)<br> `id`| Type: counter<br> Total number of messages received from clients.|
69
+
|`edgehub_messages_sent_total`|`from` (message source)<br> `to` (message destination)<br>`from_route_output`<br> `to_route_input` (message destination input)<br> `priority` (message priority to destination) | Type: counter<br> Total number of messages sent to clients or upstream<br> `to_route_input` is empty when `to` is $upstream.|
70
+
|`edgehub_reported_properties_total`|`target`(update target)<br> `id`| Type: counter<br> Total reported property updates calls.|
71
71
|`edgehub_message_size_bytes`|`id`<br> | Type: summary<br> Message size from clients<br> Values might be reported as `NaN` if no new measurements are reported for 10 minutes. For the `summary` type, corresponding `_count` and `_sum` counters are emitted. |
72
72
|`edgehub_gettwin_duration_seconds`|`source` <br> `id`| Type: summary<br> Time taken for get twin operations |
73
73
|`edgehub_message_send_duration_seconds`|`from`<br> `to`<br> `from_route_output`<br> `to_route_input`| Type: summary<br> Time taken to send a message |
@@ -106,13 +106,13 @@ The **edgeAgent** module generates the following metrics:
106
106
|`edgeAgent_total_disk_space_bytes`|`disk_name`, `disk_filesystem`, `disk_filetype`| Type: gauge<br> Size of the disk |
107
107
|`edgeAgent_used_memory_bytes`|`module_name`| Type: gauge<br> Amount of RAM used by all processes |
108
108
|`edgeAgent_total_memory_bytes`|`module_name`| Type: gauge<br> RAM available |
109
-
|`edgeAgent_used_cpu_percent`|`module_name`| Type: histogram<br> Percent of cpu used by all processes |
110
-
|`edgeAgent_created_pids_total`|`module_name`| Type: gauge<br> The number of processes or threads the container has created|
109
+
|`edgeAgent_used_cpu_percent`|`module_name`| Type: histogram<br> Percent of CPU used by all processes |
110
+
|`edgeAgent_created_pids_total`|`module_name`| Type: gauge<br> The number of processes or threads the container creates|
111
111
|`edgeAgent_total_network_in_bytes`|`module_name`| Type: gauge<br> The number of bytes received from the network |
112
112
|`edgeAgent_total_network_out_bytes`|`module_name`| Type: gauge<br> The number of bytes sent to network |
113
113
|`edgeAgent_total_disk_read_bytes`|`module_name`| Type: gauge<br> The number of bytes read from the disk |
114
114
|`edgeAgent_total_disk_write_bytes`|`module_name`| Type: gauge<br> The number of bytes written to disk |
115
-
|`edgeAgent_metadata`|`edge_agent_version`, `experimental_features`, `host_information`| Type: gauge<br> General metadata about the device. The value is always 0, and information is encoded in the tags. Note that `experimental_features` and `host_information` are JSON objects. `host_information` looks like ```{"OperatingSystemType": "linux", "Architecture": "x86_64", "Version": "1.2.7", "Provisioning": {"Type": "dps.tpm", "DynamicReprovisioning": false, "AlwaysReprovisionOnStartup": false}, "ServerVersion": "20.10.11+azure-3", "KernelVersion": "5.11.0-1027-azure", "OperatingSystem": "Ubuntu 20.04.4 LTS", "NumCpus": 2, "Virtualized": "yes"}```. Note `ServerVersion` is the Docker version and `Version` is the IoT Edge security daemon version. |
115
+
|`edgeAgent_metadata`|`edge_agent_version`, `experimental_features`, `host_information`| Type: gauge<br> General metadata about the device. The value is always 0, and the tags encode the information. Note that `experimental_features` and `host_information` are JSON objects. `host_information` looks like ```{"OperatingSystemType": "linux", "Architecture": "x86_64", "Version": "1.2.7", "Provisioning": {"Type": "dps.tpm", "DynamicReprovisioning": false, "AlwaysReprovisionOnStartup": false}, "ServerVersion": "20.10.11+azure-3", "KernelVersion": "5.11.0-1027-azure", "OperatingSystem": "Ubuntu 20.04.4 LTS", "NumCpus": 2, "Virtualized": "yes"}```. Note `ServerVersion` is the Docker version and `Version` is the IoT Edge security daemon version. |
Visually explore metrics collected from IoT Edge devices using Azure Monitor workbooks. Curated monitoring workbooks for IoT Edge devices are available as public templates:
16
+
You can visually explore metrics collected from IoT Edge devices by using Azure Monitor workbooks. Curated monitoring workbooks for IoT Edge devices are available as public templates:
17
17
18
-
* For devices connected to IoT Hub, from the **IoT Hub** page in the Azure portal, navigate to the **Workbooks** page in the **Monitoring** section.
19
-
* For devices connected to IoT Central, from the **IoT Central** page in the Azure portal, navigate to the **Workbooks** page in the **Monitoring** section.
18
+
* For devices connected to IoT Hub, from the **IoT Hub** page in the Azure portal, go to the **Workbooks** page in the **Monitoring** section.
19
+
* For devices connected to IoT Central, from the **IoT Central** page in the Azure portal, go to the **Workbooks** page in the **Monitoring** section.
20
20
21
-
Curated workbooks use [built-in metrics](how-to-access-built-in-metrics.md) from IoT Edge runtime. Metrics must first be [ingested](how-to-collect-and-transport-metrics.md) into a Log Analytics workspace. These views don't require metrics instrumentation from workload modules.
21
+
Curated workbooks use [built-in metrics](how-to-access-built-in-metrics.md) from the IoT Edge runtime. You must first [ingest](how-to-collect-and-transport-metrics.md) metrics into a Log Analytics workspace. These views don't require metrics instrumentation from workload modules.
22
22
23
23
## Access curated workbooks
24
24
25
-
Azure Monitor workbooks for IoT are templates that let you visualize device metrics. You can customize them to fit your solution.
25
+
Azure Monitor workbooks for IoT are templates that you use to visualize device metrics. You can customize them to fit your solution.
26
26
27
27
Follow these steps to access the curated workbooks:
28
28
29
29
1. Sign in to the [Azure portal](https://portal.azure.com), and go to your IoT Hub or IoT Central application.
30
-
31
30
1. Select **Workbooks** from the **Monitoring** section of the menu.
32
-
33
31
1. Choose a workbook to explore from the list of public templates:
34
32
35
-
***Fleet View**: Monitor your fleet of devices across multiple IoT Hubs or Central Apps, and drill into specific devices for a health snapshot.
33
+
***Fleet View**: Monitor your fleet of devices across multiple IoT Hubs or Central Apps, and drill into specific devices for a health snapshot.
36
34
37
-
***Device Details**: Visualize device details around messaging, modules, and host components on an IoT Edge device.
35
+
***Device Details**: Visualize device details around messaging, modules, and host components on an IoT Edge device.
38
36
39
-
***Alerts**: View triggered [alerts](how-to-create-alerts.md) for devices across multiple IoT resources.
37
+
***Alerts**: View triggered [alerts](how-to-create-alerts.md) for devices across multiple IoT resources.
40
38
41
-
See the following sections for a preview of the data and visualizations each workbook offers.
39
+
For a preview of the data and visualizations each workbook offers, see the following sections.
42
40
43
-
>[!NOTE]
44
-
> The screen captures that follow may not reflect the latest workbook design.
41
+
>[!NOTE]
42
+
> The screen captures that follow might not reflect the latest workbook design.
45
43
46
44
## Fleet view workbook
47
45
@@ -63,7 +61,7 @@ The device details workbook has three views:
63
61
64
62
Switch between views by selecting the tabs at the top of the workbook.
65
63
66
-
The device details workbook also integrates with the IoT Edge portal-based troubleshooting experience. You can pull **Live logs** from your device using this feature. Access this experience by selecting the **Troubleshoot \<device name> live** button above the workbook.
64
+
The device details workbook also integrates with the IoT Edge portal-based troubleshooting experience. You can pull **Live logs** from your device by using this feature. Access this experience by selecting the **Troubleshoot \<device name\> live** button above the workbook.
67
65
68
66
# [Messaging](#tab/messaging)
69
67
@@ -92,11 +90,11 @@ The **Modules** view shows metrics collected from the edgeAgent module, which re
92
90
93
91
:::image type="content" source="./media/how-to-explore-curated-visualizations/how-to-explore-host-details.gif" alt-text="The host section of the device details workbook." lightbox="./media/how-to-explore-curated-visualizations/how-to-explore-host-details.gif":::
94
92
95
-
The **Host** view shows metrics from the edgeAgent module. It includes information like:
93
+
The **Host** view shows metrics from the **edgeAgent** module. It includes information like:
96
94
97
95
* Host component version information
98
96
* Uptime
99
-
* CPU, memory, and disk space use at the host-level
97
+
* CPU, memory, and disk space use at the hostlevel
100
98
101
99
# [Live logs](#tab/livelogs)
102
100
@@ -116,13 +114,12 @@ Select a severity row to view alert details. The **Alert rule** link opens the a
116
114
117
115
## Customize workbooks
118
116
119
-
[Azure Monitor workbooks](/azure/azure-monitor/visualize/workbooks-overview) are customizable. You can edit the public templates to suit your requirements. All the visualizations are driven by resource-centric [Kusto Query Language](/azure/data-explorer/kusto/query/) queries on the [InsightsMetrics](/azure/azure-monitor/reference/tables/insightsmetrics) table.
117
+
You can customize [Azure Monitor workbooks](/azure/azure-monitor/visualize/workbooks-overview). Edit the public templates to suit your requirements. All the visualizations come from resource-centric [Kusto Query Language](/azure/data-explorer/kusto/query/) queries on the [InsightsMetrics](/azure/azure-monitor/reference/tables/insightsmetrics) table.
120
118
121
119
To customize a workbook, enter editing mode. Select the **Edit** button in the workbook's menu bar. Curated workbooks use workbook groups extensively. You might need to select **Edit** on several nested groups to view a visualization query.
122
120
123
121
Save your changes as a new workbook. You can [share](/azure/azure-monitor/visualize/workbooks-overview#access-control) the saved workbook with your team or [deploy them programmatically](/azure/azure-monitor/visualize/workbooks-automate) as part of your organization's resource deployments.
124
122
125
-
126
123
## Next steps
127
124
128
125
Customize your monitoring solution with [alert rules](how-to-create-alerts.md) and [metrics from custom modules](how-to-add-custom-metrics.md).
0 commit comments