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
You can visually explore metrics collected from IoT Edge devices using Azure Monitor workbooks. Curated monitoring workbooks for IoT Edge devices are provided in the form of public templates:
17
+
Visually explore metrics collected from IoT Edge devices using Azure Monitor workbooks. Curated monitoring workbooks for IoT Edge devices are available as public templates:
19
18
20
19
* For devices connected to IoT Hub, from the **IoT Hub** page in the Azure portal, navigate to the **Workbooks** page in the **Monitoring** section.
21
20
* For devices connected to IoT Central, from the **IoT Central** page in the Azure portal, navigate to the **Workbooks** page in the **Monitoring** section.
22
21
23
-
Curated workbooks use [built-in metrics](how-to-access-built-in-metrics.md) from the IoT Edge runtime. They first need metrics to be [ingested](how-to-collect-and-transport-metrics.md) into a Log Analytics workspace. These views don't need any metrics instrumentation from the workload modules.
22
+
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.
24
23
25
24
## Access curated workbooks
26
25
27
-
Azure Monitor workbooks for IoT are a set of templates that you can use to visualize your device metrics. They can be customized to fit your solution.
26
+
Azure Monitor workbooks for IoT are templates that let you visualize device metrics. You can customize them to fit your solution.
28
27
29
-
To access the curated workbooks, use the following steps:
28
+
Follow these steps to access the curated workbooks:
30
29
31
-
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your IoT Hub or IoT Central application.
30
+
1. Sign in to the [Azure portal](https://portal.azure.com), and go to your IoT Hub or IoT Central application.
32
31
33
32
1. Select **Workbooks** from the **Monitoring** section of the menu.
34
33
35
-
1. Choose the workbook that you want to explore from the list of public templates:
34
+
1. Choose a workbook to explore from the list of public templates:
36
35
37
36
***Fleet View**: Monitor your fleet of devices across multiple IoT Hubs or Central Apps, and drill into specific devices for a health snapshot.
38
37
39
38
***Device Details**: Visualize device details around messaging, modules, and host components on an IoT Edge device.
40
39
41
40
***Alerts**: View triggered [alerts](how-to-create-alerts.md) for devices across multiple IoT resources.
42
41
43
-
Use the following sections to get a preview of the kind of data and visualizations that each workbook offers.
42
+
See the following sections for a preview of the data and visualizations each workbook offers.
44
43
45
44
>[!NOTE]
46
45
> The screen captures that follow may not reflect the latest workbook design.
47
46
48
47
## Fleet view workbook
49
48
50
-
:::image type="content" source="./media/how-to-explore-curated-visualizations/how-to-explore-fleet-view.gif" alt-text="The devices section of the fleet view workbook." lightbox="./media/how-to-explore-curated-visualizations/how-to-explore-fleet-view.gif":::
49
+
:::image type="content" source="./media/how-to-explore-curated-visualizations/how-to-explore-fleet-view.gif" alt-text="Screenshot of the devices section of the fleet view workbook." lightbox="./media/how-to-explore-curated-visualizations/how-to-explore-fleet-view.gif":::
51
50
52
-
By default, this view shows the health of devices associated with the current IoT cloud resource. You can select multiple IoT resources using the dropdown control on the top left.
51
+
By default, this view shows the health of devices associated with the current IoT cloud resource. Select multiple IoT resources using the dropdown control at the top left.
53
52
54
-
Use the **Settings** tab to adjust the various thresholds to categorize the device as Healthy or Unhealthy.
53
+
Use the **Settings** tab to adjust thresholds to categorize devices as healthy or unhealthy.
55
54
56
-
Select the **Details** button to see the device list with a snapshot of aggregated, primary metrics. Select the link in the **Status** column to view the trend of an individual device's health metrics or the device name to view its detailed metrics.
55
+
Select the **Details** button to view the device list with a snapshot of aggregated primary metrics. Select the link in the **Status** column to view trends in an individual device's health metrics or select the device name to view its detailed metrics.
57
56
58
57
## Device details workbook
59
58
@@ -63,27 +62,27 @@ The device details workbook has three views:
63
62
* The **Modules** view shows how the individual modules on a device are performing.
64
63
* The **Host** view shows information about the host device including version information for host components and resource use.
65
64
66
-
Switch between the views using the tabs at the top of the workbook.
65
+
Switch between views by selecting the tabs at the top of the workbook.
67
66
68
67
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.
69
68
70
69
# [Messaging](#tab/messaging)
71
70
72
71
:::image type="content" source="./media/how-to-explore-curated-visualizations/how-to-explore-messaging-details.gif" alt-text="The messaging section of the device details workbook." lightbox="./media/how-to-explore-curated-visualizations/how-to-explore-messaging-details.gif":::
73
72
74
-
The **Messaging** view includes three subsections: routing details, a routing graph, and messaging health. Drag and let go on any time chart to adjust the global time range to the selected range.
73
+
The **Messaging** view includes three subsections: routing details, a routing graph, and messaging health. Drag any time chart and release it to adjust the global time range to the selected range.
75
74
76
-
The **Routing** section shows message flow between sending modules and receiving modules. It presents information such as message count, rate, and number of connected clients. Select a sender or receiver to drill in further. Clicking a sender shows the latency trend chart experienced by the sender and number of messages it sent. Clicking a receiver shows the queue length trend for the receiver and number of messages it received.
75
+
The **Routing** section shows message flow between sending modules and receiving modules. It presents information such as message count, rate, and number of connected clients. Select a sender or receiver to drill in further. Selecting a sender shows the latency trend chart experienced by the sender and the number of messages it sent. Selecting a receiver shows the queue length trend for the receiver and the number of messages it received.
77
76
78
77
The **Graph** section shows a visual representation of message flow between modules. Drag and zoom to adjust the graph.
79
78
80
-
The **Health** section presents various metrics related to overall health of the messaging subsystem. Progressively drill-in to details if any errors are noted.
79
+
The **Health** section shows various metrics related to the overall health of the messaging subsystem. Drill into details if any errors are noted.
81
80
82
81
# [Modules](#tab/modules)
83
82
84
83
:::image type="content" source="./media/how-to-explore-curated-visualizations/how-to-explore-module-details.gif" alt-text="The modules section of the device details workbook." lightbox="./media/how-to-explore-curated-visualizations/how-to-explore-module-details.gif":::
85
84
86
-
The **Modules** view presents metrics collected from the edgeAgent module, which reports on the status of all running modules on the device. It includes information such as:
85
+
The **Modules** view shows metrics collected from the edgeAgent module, which reports on the status of all running modules on the device. It includes information like:
87
86
88
87
* Module availability
89
88
* Per-module CPU and memory use
@@ -94,7 +93,7 @@ The **Modules** view presents metrics collected from the edgeAgent module, which
94
93
95
94
:::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":::
96
95
97
-
The **Host** view presents metrics from the edgeAgent module. It includes information such as:
96
+
The **Host** view shows metrics from the edgeAgent module. It includes information like:
98
97
99
98
* Host component version information
100
99
* Uptime
@@ -104,23 +103,23 @@ The **Host** view presents metrics from the edgeAgent module. It includes inform
104
103
105
104
:::image type="content" source="./media/how-to-explore-curated-visualizations/how-to-troubleshoot-live.gif" alt-text="Access live logs through the device details workbook." lightbox="./media/how-to-explore-curated-visualizations/how-to-troubleshoot-live.gif":::
106
105
107
-
This workbook integrates directly with the portal-based troubleshooting experience. Click on the **Troubleshoot live** button to go to the troubleshoot screen. Here, you can easily view module logs pulled from the device, on-demand. The time range is automatically set to the workbook's time range, so you're immediately in temporal context. You can also restart any module from this experience.
106
+
This workbook integrates directly with the portal-based troubleshooting experience. Select the **Troubleshoot live** button to go to the troubleshoot screen. Here, you can easily view module logs pulled from the device, on-demand. The time range is automatically set to the workbook's time range, so you're immediately in context. You can also restart any module from this experience.
108
107
109
108
---
110
109
111
110
## Alerts workbook
112
111
113
-
See the generated alerts from [pre-created alert rules](how-to-create-alerts.md) in the **Alerts** workbook. This view lets you see alerts from multiple IoT Hubs or IoT Central applications.
112
+
View the generated alerts from [pre-created alert rules](how-to-create-alerts.md) in the **Alerts** workbook. This view lets you see alerts from multiple IoT Hubs or IoT Central applications.
114
113
115
-
:::image type="content" source="./media/how-to-explore-curated-visualizations/how-to-explore-alerts.gif" alt-text="The alerts section of the fleet view workbook." lightbox="./media/how-to-explore-curated-visualizations/how-to-explore-alerts.gif":::
114
+
:::image type="content" source="./media/how-to-explore-curated-visualizations/how-to-explore-alerts.gif" alt-text="Screenshot of the alerts section in the fleet view workbook." lightbox="./media/how-to-explore-curated-visualizations/how-to-explore-alerts.gif":::
116
115
117
-
Select a severity row to see alerts details. The **Alert rule** link takes you to the alert context and the **Device** link opens the detailed metrics workbook. When opened from this view, the device details workbook is automatically adjusted to the time range around when the alert fired.
116
+
Select a severity row to view alert details. The **Alert rule** link opens the alert context, and the **Device** link opens the detailed metrics workbook. When opened from this view, the device details workbook automatically adjusts to the time range around the alert firing.
118
117
119
118
## Customize workbooks
120
119
121
120
[Azure Monitor workbooks](/azure/azure-monitor/visualize/workbooks-overview) are very 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.
122
121
123
-
To begin customizing a workbook, first enter editing mode. Select the **Edit** button in the menu bar of the workbook. Curated workbooks make extensive use of workbook groups. You may need to select **Edit** on several nested groups before being able to view a visualization query.
122
+
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.
124
123
125
124
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.
0 commit comments