Skip to content

Commit c2e0928

Browse files
author
Venkat Yalla
committed
add support-bundle troubleshooting step
1 parent 609249d commit c2e0928

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

articles/iot-edge/troubleshoot.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,28 @@ The types of checks run by the tool can be classified as:
4040

4141
For a complete list of diagnostic checks, see [Built-in troubleshooting functionality](https://github.com/Azure/iotedge/blob/master/doc/troubleshoot-checks.md).
4242

43+
## Gather debug information with iotedge 'support-bundle' command
44+
45+
When you need to gather logs from an IoT Edge device, the most convenient way is to use the `support-bundle` command. By default, this command collects module, `iotedged` and container engine logs, 'iotedge check' JSON output and other useful debug information. It compresses them into a single file for easy sharing. The `support-bundle` command is available in [release 1.0.9](https://github.com/Azure/azure-iotedge/releases/tag/1.0.9) and later.
46+
47+
Run the `support-bundle` command with the `--since` flag to specify how long from the past you want to get logs from. For example `6h` will get logs since the last 6 hours, `6d` since the last 6 days, `6m` since the last 6 minutes and so on. Include the `--help` flag to see a complete list of options.
48+
49+
50+
* On Linux:
51+
52+
```bash
53+
sudo iotedge support-bundle --since 6h
54+
```
55+
56+
* On Windows:
57+
58+
```powershell
59+
iotedge support-bundle --since 6h
60+
```
61+
62+
> [!WARNING]
63+
> Output from the `support-bundle` command can contain information such as host, device and module names, information logged by your modules etc. Please be aware of this if sharing the output in a public forum.
64+
4365
## Standard diagnostic steps
4466

4567
If you encounter an issue, you can learn more about the state of your IoT Edge device by reviewing the container logs and the messages that pass to and from the device. Use the commands and tools in this section to gather information.

0 commit comments

Comments
 (0)