Explore curated visualizations in Azure IoT Edge

Applies to: IoT Edge 1.5 IoT Edge 1.4

Important

IoT Edge 1.5 LTS and IoT Edge 1.4 LTS are supported releases. IoT Edge 1.4 LTS is end of life on November 12, 2024. If you are on an earlier release, see Update IoT Edge.

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:

• For devices connected to IoT Hub, from the IoT Hub page in the Azure portal, navigate to the Workbooks page in the Monitoring section.
• For devices connected to IoT Central, from the IoT Central page in the Azure portal, navigate to the Workbooks page in the Monitoring section.

Curated workbooks use built-in metrics from the IoT Edge runtime. They first need metrics to be ingested into a Log Analytics workspace. These views don't need any metrics instrumentation from the workload modules.

Access curated workbooks

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.

To access the curated workbooks, use the following steps:

1. Sign in to the Azure portal and navigate to your IoT Hub or IoT Central application.

2. Select Workbooks from the Monitoring section of the menu.

3. Choose the workbook that you want to explore from the list of public templates:

• Fleet View: Monitor your fleet of devices across multiple IoT Hubs or Central Apps, and drill into specific devices for a health snapshot.

• Device Details: Visualize device details around messaging, modules, and host components on an IoT Edge device.

• Alerts: View triggered alerts for devices across multiple IoT resources.

Use the following sections to get a preview of the kind of data and visualizations that each workbook offers.

Note

The screen captures that follow may not reflect the latest workbook design.

Fleet view workbook

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.

Use the Settings tab to adjust the various thresholds to categorize the device as Healthy or Unhealthy.

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.

Device details workbook

The device details workbook has three views:

• The Messaging view visualizes the message routes for the device and reports on the overall health of the messaging system.
• The Modules view shows how the individual modules on a device are performing.
• The Host view shows information about the host device including version information for host components and resource use.

Switch between the views using the tabs at the top of the workbook.

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.

Messaging

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.

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.

The Graph section shows a visual representation of message flow between modules. Drag and zoom to adjust the graph.

The Health section presents various metrics related to overall health of the messaging subsystem. Progressively drill-in to details if any errors are noted.

Modules

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:

• Module availability
• Per-module CPU and memory use
• CPU and memory use across all modules
• Modules restart count and restart timeline

Host

The Host view presents metrics from the edgeAgent module. It includes information such as:

• Host component version information
• Uptime
• CPU, memory, and disk space use at the host-level

Live logs

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.

Alerts workbook

See the generated alerts from pre-created alert rules in the Alerts workbook. This view lets you see alerts from multiple IoT Hubs or IoT Central applications.

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.

Customize workbooks

Azure Monitor workbooks are very customizable. You can edit the public templates to suit your requirements. All the visualizations are driven by resource-centric Kusto Query Language queries on the InsightsMetrics table.

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.

Save your changes as a new workbook. You can share the saved workbook with your team or deploy them programmatically as part of your organization's resource deployments.

Next steps

Customize your monitoring solution with alert rules and metrics from custom modules.