jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document debug configuration setting (#32411)

Browse Source 
* Document debug configuration setting

Enable Home Assistant's built-in debug, which can help locate misbehaving integrations by enabling run-time checks for implementation errors. It can block many unsafe thread operations from crashing the system. Enabling debug has a slight performance impact on the system and is not recommended for long-term use.

* Update basic.markdown

* add to troubleshooting as well

* cleanups

* cleanups

* restore lost info from merge conflict
This commit is contained in:
J. Nick Koston 2024-04-24 11:50:07 +02:00 committed by GitHub
parent 9eb3735e41
commit d0cb70f828
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
source/_docs/configuration/troubleshooting.markdown
View File

@ -123,3 +123,14 @@ After you download logs, you will also want to download the diagnostics for the
<img src='/images/docs/configuration/download-diagnostics.png' 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>
### Handling unexpected restarts or crashes
Suppose you find that Home Assistant unexpectedly restarts or crashes; it's likely that you have a misbehaving integration impacting system stability. Home Assistant has a built-in debug option that can help find implementation errors. It can also block many unsafe thread operations from crashing the system. Enabling debug has a slight performance impact on the system and is not recommended for long-term use. To enable debug, add the following to your `configuration.yaml`:
```yaml
homeassistant:
debug: true
```
Once debug is enabled, periodically check [Home Assistant System Logs](https://my.home-assistant.io/redirect/logs) for new messages.

6
source/_integrations/homeassistant.markdown
View File

@ -55,6 +55,7 @@ To get started with the general settings in YAML, follow these steps:
media_dirs: media_dirs:
media: "/media" media: "/media"
recordings: "/mnt/recordings" recordings: "/mnt/recordings"
debug: false
``` ```
2. Edit each entry to fit your home. 2. Edit each entry to fit your home.
@ -134,6 +135,11 @@ country:
description: "Country in which Home Assistant is running. This may, for example, influence radio settings to comply with local regulations. The country should be specified as an ISO 3166.1 alpha-2 code. Pick your country from the column **Code** of [Wikipedia's list of ISO 31661 alpha-2 officially assigned code codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)" description: "Country in which Home Assistant is running. This may, for example, influence radio settings to comply with local regulations. The country should be specified as an ISO 3166.1 alpha-2 code. Pick your country from the column **Code** of [Wikipedia's list of ISO 31661 alpha-2 officially assigned code codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)"
required: false required: false
type: string type: string
debug:
description: Enable Home Assistant's built-in debug, which can help locate misbehaving integrations by enabling run-time checks for implementation errors. It can block many unsafe thread operations from crashing the system. Enabling debug has a slight performance impact on the system and is not recommended for long-term use.
required: false
type: boolean
default: false
{% endconfiguration %} {% endconfiguration %}
## Services ## Services