From c83aaf5b64427b25bb70e7c7b2c01ffcb0eb1c72 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 17 Sep 2024 09:13:55 +0200 Subject: [PATCH] debug logging: emphasize that screenshot is only for illu purposes (#34702) * debug logging: emphasize that screenshot is only for illu purposes * Tweak * rephrase * Fix format * Add step to disable debug logging --- .../_docs/configuration/troubleshooting.markdown | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index 33725aba440..ad25fd6f0b8 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -110,12 +110,18 @@ The first thing you will need before reporting an issue online is debug logs and ### Enabling 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. +To enable debug logging for a specific integration, follow these steps: -

- Example of Enable debug logging - Example of Enable debug logging. -

+1. Go to {% my integrations title="**Settings** > **Devices & services**" %}. +2. Select the integration card to open the detail page of the integration for which you want to enable debug logging. +3. On the left side of the integration detail page, select **Enable Debug Logging**. + - The screenshot uses the MQTT integration as an example for illustration purposes. It does not mean you need to install the MQTT integration. + +

+ Screenshot showing the Enable debug logging button on an integration detail page + Screenshot showing the Enable debug logging button on an integration detail page. The MQTT integration is used as an example to show where the button can be found. +

+4. To see the error in the logs, you need to reproduce the error. Continue with the steps on [disabling debug logging and download logs](#disable-debug-logging-and-download-logs). ### Disable debug logging and download logs