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
IoT Edge provides a streamlined way of monitoring and troubleshooting modules in the Azure portal. The troubleshooting page is a wrapper for the IoT Edge agent's direct methods so that you can easily retrieve logs from deployed modules and remotely restart them. This article shows you how to access and filter device and module logs in the Azure portal.
17
+
IoT Edge lets you monitor and troubleshoot modules in the Azure portal. The troubleshooting page wraps the IoT Edge agent's direct methods, letting you retrieve logs from deployed modules and restart them remotely. This article explains how to access and filter device and module logs in the Azure portal.
18
18
19
19
## Access the troubleshooting page
20
20
21
21
You can access the troubleshooting page in the portal through either the IoT Edge device details page or the IoT Edge module details page.
22
22
23
-
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your IoT hub.
23
+
1. Sign in to the [Azure portal](https://portal.azure.com), and go to your IoT hub.
24
24
25
-
1. In the left pane, select **Devices** under the **Device management** menu.
25
+
1. In the left pane, select **Devices** under **Device management**.
26
26
27
27
1. Select the IoT Edge device that you want to monitor from the list of devices.
28
28
29
-
1. On this device details page, you can either select **Troubleshoot** from the menu.
29
+
1. On the device details page, select **Troubleshoot** from the menu.
30
30
31
-
:::image type="content" source="./media/troubleshoot-in-portal/troubleshoot-tab.png" alt-text="Screenshot of the location of the Troubleshoot tab on the Azure portal, device details page.":::
31
+
:::image type="content" source="./media/troubleshoot-in-portal/troubleshoot-tab.png" alt-text="Screenshot of the Troubleshoot tab on the Azure portal device details page.":::
32
32
33
-
Or, select the runtime status of a particular module that you want to inspect.
33
+
Or, select the runtime status of the module you want to inspect.
34
34
35
-
:::image type="content" source="./media/troubleshoot-in-portal/runtime-status.png" alt-text="Screenshot of the location of the Runtime status column on the Azure portal, device details page." lightbox="./media/troubleshoot-in-portal/runtime-status.png":::
35
+
:::image type="content" source="./media/troubleshoot-in-portal/runtime-status.png" alt-text="Screenshot of the Runtime status column on the Azure portal device details page." lightbox="./media/troubleshoot-in-portal/runtime-status.png":::
36
36
37
-
1. From the device details page, you can also select the name of a module to open the module details page. From there, you can select **Troubleshoot** from the menu.
37
+
1. From the device details page, select the name of a module to open the module details page. Then, select **Troubleshoot** from the menu.
38
38
39
-
:::image type="content" source="./media/troubleshoot-in-portal/troubleshoot-module.png" alt-text="Screenshot of the location of the Troubleshoot tab on the Azure portal, module details page.":::
39
+
:::image type="content" source="./media/troubleshoot-in-portal/troubleshoot-module.png" alt-text="Screenshot of the Troubleshoot tab on the Azure portal module details page.":::
40
40
41
41
## View module logs in the portal
42
42
43
43
On the **Troubleshoot** page of your device, you can view and download logs from any of the running modules on your IoT Edge device.
44
44
45
-
This page has a maximum limit of 1,500 log lines, and any logs longer are truncated. If the logs are too large, the attempt to get module logs fails. In that case, try to change the time range filter to retrieve less data or consider using direct methods to [Retrieve logs from IoT Edge deployments](how-to-retrieve-iot-edge-logs.md) to gather larger log files.
45
+
This page has a maximum limit of 1,500 log lines, and logs longer than this are truncated. If the logs are too large, the attempt to get module logs fails. In that case, change the time range filter to retrieve less data or use direct methods to [retrieve logs from IoT Edge deployments](how-to-retrieve-iot-edge-logs.md) to gather larger log files.
46
46
47
47
Use the dropdown menu to choose which module to inspect.
48
48
49
49
:::image type="content" source="./media/troubleshoot-in-portal/select-module.png" alt-text="Screenshot showing how to choose a module from the dropdown menu that you want to inspect.":::
50
50
51
-
By default, this page displays the last 15 minutes of logs. Select the **Time range** filter to see different logs. Use the slider to select a time window within the last 60 minutes, or check**Enter time instead** to choose a specific datetime window.
51
+
By default, this page shows the last 15 minutes of logs. Select the **Time range** filter to view different logs. Use the slider to select a time window within the last 60 minutes, or select**Enter time instead** to choose a specific datetime window.
52
52
53
53
:::image type="content" source="./media/troubleshoot-in-portal/select-time-range.png" alt-text="Screenshot showing how to choose a time or time range from the time range popup filter.":::
54
54
55
-
Once you have the logs and set your time filter from the module you want to troubleshoot, you can use the **Find** filter to retrieve specific lines from the logs. You can filter for either warnings or errors, or provide a specific term or phrase to search for.
55
+
After you get the logs and set your time filter for the module you want to troubleshoot, use the **Find** filter to retrieve specific lines from the logs. Filter for warnings, errors, or a specific term or phrase.
56
56
57
57
:::image type="content" source="./media/troubleshoot-in-portal/find-filter.png" alt-text="Screenshot showing how to use a dotnet regex pattern to search the logs, using the Find filter.":::
58
58
59
-
The **Find** feature supports plaintext searches or[.NET regular expressions](/dotnet/standard/base-types/regular-expression-language-quick-reference) for more complex searches.
59
+
The **Find** feature supports plaintext searches and[.NET regular expressions](/dotnet/standard/base-types/regular-expression-language-quick-reference) for complex searches.
60
60
61
61
You can download the module logs as a text file. The downloaded log file reflects any active filters you applied to the logs.
62
62
63
63
>[!TIP]
64
-
>The CPU utilization on a device spikes temporarily as it gathers logs in response to a request from the portal. This behavior is expected, and the utilization should stabilize after the task is complete.
64
+
>The CPU utilization on a device temporarily spikes as it gathers logs in response to a portal request. This behavior is expected, and the utilization stabilizes after the task is complete.
65
65
66
66
## Restart modules
67
67
68
-
The **Troubleshoot** page includes a feature to restart a module. Selecting this option sends a command to the IoT Edge agent to restart the selected module. Restarting a module won't affect your ability to retrieve logs from before the restart.
68
+
The **Troubleshoot** page lets you restart a module. Selecting this option sends a command to the IoT Edge agent to restart the selected module. Restarting a module doesn't affect your ability to retrieve logs from before the restart.
69
69
70
-
:::image type="content" source="./media/troubleshoot-in-portal/restart-module.png" alt-text="Screenshot that shows how to restart a module from the Troubleshoot page.":::
70
+
:::image type="content" source="./media/troubleshoot-in-portal/restart-module.png" alt-text="Screenshot of how to restart a module from the Troubleshoot page.":::
71
71
72
72
## Next steps
73
73
74
-
Find more tips for [Troubleshooting your IoT Edge device](troubleshoot.md) or learn about [Common issues and resolutions](troubleshoot-common-errors.md).
74
+
Find more tips for [troubleshooting your IoT Edge device](troubleshoot.md) or learn about [common issues and resolutions](troubleshoot-common-errors.md).
75
75
76
-
If you have more questions, create a [Support request](https://portal.azure.com/#create/Microsoft.Support) for help.
76
+
If you have more questions, create a [support request](https://portal.azure.com/#create/Microsoft.Support) for help.
0 commit comments