Skip to content

Commit 4129fc5

Browse files
committed
Updated for freshness
1 parent 5cea3cf commit 4129fc5

10 files changed

+19
-11
lines changed
63.9 KB
Loading
-13.2 KB
Loading
32.5 KB
Loading
-82 Bytes
Loading
22.7 KB
Loading
36.3 KB
Loading
42.1 KB
Loading

articles/iot-edge/troubleshoot-in-portal.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,44 +26,52 @@ You can access the troubleshooting page in the portal through either the IoT Edg
2626

2727
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your IoT hub.
2828

29-
1. In the left pane,select **Devices** under the **Device management** menu.
29+
1. In the left pane, select **Devices** under the **Device management** menu.
3030

3131
1. Select the IoT Edge device that you want to monitor from the list of devices.
3232

33-
1. From the device details page, you can either select **Troubleshoot** from the menu or select the runtime status of a particular module that you want to inspect.
33+
1. On this device details page, you can either select **Troubleshoot** from the menu.
3434

35-
![From the device details page select troubleshoot or a module runtime status](./media/troubleshoot-in-portal/troubleshoot-from-device-details.png)
35+
:::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.":::
36+
37+
Or, select the runtime status of a particular module that you want to inspect.
38+
39+
:::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.":::
3640

3741
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.
3842

39-
![From the module details page select troubleshoot](./media/troubleshoot-in-portal/troubleshoot-from-module-details.png)
43+
:::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.":::
4044

4145
## View module logs in the portal
4246

43-
On the **Troubleshoot** page, you can view and download logs from any of the running modules on your IoT Edge device.
47+
On the **Troubleshoot** page of your device, you can view and download logs from any of the running modules on your IoT Edge device.
4448

4549
This page has a maximum limit of 1500 log lines, and any logs longer than that will be truncated. If the logs are too large, the attempt to get module logs will fail. 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.
4650

4751
Use the dropdown menu to choose which module to inspect.
4852

49-
![Choose modules from the dropdown menu](./media/troubleshoot-in-portal/select-module.png)
53+
:::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.":::
5054

5155
By default, this page displays the last fifteen 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.
5256

53-
![Select time range](./media/troubleshoot-in-portal/select-time-range.png)
57+
:::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.":::
58+
59+
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.
60+
61+
:::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.":::
5462

55-
Once you have the logs from the module that you want to troubleshoot during the time range that you want to inspect, 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. The **Find** feature supports plaintext searches or [.NET regular expressions](/dotnet/standard/base-types/regular-expression-language-quick-reference) for more complex searches.
63+
The **Find** feature supports plaintext searches or [.NET regular expressions](/dotnet/standard/base-types/regular-expression-language-quick-reference) for more complex searches.
5664

57-
You can download the module logs as a text file. The downloaded log file will reflect any active filters you have applied to the logs.
65+
You can download the module logs as a text file. The downloaded log file reflects any active filters you applied to the logs.
5866

5967
>[!TIP]
60-
>The CPU utilization on a device will spike 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.
68+
>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.
6169
6270
## Restart modules
6371

6472
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.
6573

66-
![Restart a module from the troubleshoot page](./media/troubleshoot-in-portal/restart-module.png)
74+
:::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.":::
6775

6876
## Next steps
6977

0 commit comments

Comments
 (0)