Fix instructions for enabling and disabling debug logging (#28712)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Jakub Kadlubiec 2023-08-28 16:35:51 +02:00 committed by GitHub
parent 84bffc43dd
commit 80c5b54421
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 9 additions and 9 deletions

View File

@ -104,22 +104,22 @@ The first thing you will need before reporting an issue online is debug logs and
### Enabling Debug Logging ### Enabling Debug Logging
To enable debug logging for an integration, go to **Settings** > **Devices & Services** and select the integration. Select the triple dots for the integration giving you trouble and select **Enable Debug Logging**. To enable debug logging for an integration, go to **Settings** > **Devices & Services** > **Integrations** and go to the detail page of the integration. Select the **Enable Debug Logging** button on the left side of the integration detail page.
<p class='img'>
<img src='/images/docs/configuration/enable-debug-logging.png' alt='Example of Enable debug logging'>
Example of Enable debug logging.
</p>
### Disable Debug Logging and Download Logs ### Disable Debug Logging and Download Logs
Once you enable debug logging, you ideally need to make the error happen. Run your automation, change up your device or whatever was giving you an error and then come back and disable Debug Logging. Disabling debug logging is the same as enabling, but now you will see **Disable Debug Logging**. After you disable debug logging, it will automatically prompt you to download your log file. Save this to a safe location to upload later. Once you enable debug logging, you ideally need to make the error happen. Run your automation, change up your device or whatever was giving you an error and then come back and disable the debug logging. Disabling the debug logging is the same as enabling, but now the button says **Disable Debug Logging**. After you disable it, you will be automatically prompted you to download your log file. Save this to a safe location to upload later.
<p class='img'>
<img src='/images/docs/configuration/disable-debug-logging.gif' alt='Example of Disable Debug Logging'>
Example of Disable Debug Logging.
</p>
### Download Diagnostics ### Download Diagnostics
After you download logs, you will also want to download the diagnostics for the integration giving you trouble. If the integration provides diagnostics, it will appear in the same menu that the Debug Logging toggle appeared. After you download logs, you will also want to download the diagnostics for the integration giving you trouble. If the integration provides diagnostics, it will appear in the three dot menu next to the integration configuration.
<p class='img'> <p class='img'>
<img src='/images/docs/configuration/download-diagnostics.gif' alt='Example of Download Diagnostics'> <img src='/images/docs/configuration/download-diagnostics.png' alt='Example of Download Diagnostics'>
Example of Download Diagnostics. Example of Download Diagnostics.
</p> </p>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 360 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 159 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB