mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
Reporting issues: update (#27935)
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
c0ffeeca7
GitHub
parent
5d5862bf42
commit
5c7e8b5027
@ -4,36 +4,42 @@ description: "Reporting issues about Home Assistant"
|
||||
sidebar: false
|
||||
---
|
||||
|
||||
If you have an installation, a setup or a configuration issue please use our [Forum](https://community.home-assistant.io/) to get help. We have a big community which will help you if they can.
|
||||
If you have an installation, a setup or a configuration issue, please use our [Forum](https://community.home-assistant.io/) to get help. We have a big community which will help you if they can.
|
||||
|
||||
If you found a bug then please report it in one of our [trackers](/help/#bugs-feature-requests-and-alike). To help you and our developers to identify the issue quickly, please fill out the provided template. The "weird" content you will see is there to render your entry in a nice format after submitting. It's just [markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
|
||||
If you found a bug, then please report it in one of our [trackers](/help/#bugs-feature-requests-and-alike). To help you and our developers to identify the issue quickly, please fill out the provided template. The "weird" content you will see, is there to render your entry in a nice format after submitting. It's just [markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
|
||||
|
||||
Please refer to the [**Settings** -> **About**](https://my.home-assistant.io/redirect/info/) page, which is accessible inside the Home Assistant frontend.
|
||||
To see the version information, refer to the {% my info title="**Settings** > **About**" %} page.
|
||||
|
||||
## First Home Assistant release with the issue
|
||||
## Description of the problem
|
||||
|
||||
Please provide the release which contains the issue.
|
||||
Provide a summary of your issue and tell us what's wrong. Tell us what you were trying to do and what happened.
|
||||
|
||||
There are integrations which require additional steps (installing third-party tools, compilers, etc.) to get your setup working. Please describe the steps you took and the ones to reproduce the issue if needed.
|
||||
|
||||
## First Home Assistant version with the issue
|
||||
|
||||
Please provide the version which contains the issue. You can find the version information under {% my system_health title="**Settings** > **System** > **Repairs** > Three dots in the upper right > **System information**" %}.
|
||||
|
||||
## Last working Home Assistant release (if known)
|
||||
|
||||
If possible, provide the latest release of which you know that the integration or platform was working. Home Assistant is evolving very fast and issues may already be addressed or be introduced by a recent change.
|
||||
If possible, provide the latest release of which you know that the integration or platform was working. Home Assistant is evolving very fast and issues may already be addressed or be introduced by a recent change. You can find the detailed information about your system under {% my system_health title="**Settings** > **System** > **Repairs** > Three dots in the upper right > **System information**" %}
|
||||
|
||||
## Operating environment
|
||||
|
||||
There are many different ways to run Home Assistant. In this section please mention which you are using, e.g., Home Assistant (using the Home Assistant Operating System), Home Assistant Supervised, Home Assistant Core in Docker or a manual installation of the Home Assistant Core. It can help if you mention which operating system you are using because not all are supported on the same level.
|
||||
There are many different ways to run Home Assistant. In this section, please mention which you are using: Home Assistant Operating System, Home Assistant Supervised, Home Assistant Core in Docker, or a manual installation of the Home Assistant Core. It would be helpful to mention which operating system you are using because not all are supported on the same level. You can find this information under {% my system_health title="**Settings** > **System** > **Repairs** > Three dots in the upper right > **System information**" %}.
|
||||
|
||||
## Integration
|
||||
|
||||
Please add the link to the documentation of the integration in question. E.g.,
|
||||
Please add the link to the documentation of the integration in question. For example:
|
||||
|
||||
- Issue with the `random` sensor: [/integrations/random#sensor](/integrations/random#sensor).
|
||||
- Issue with the `hue` integration: [/integrations/hue/](/integrations/hue/).
|
||||
|
||||
### Description of problem
|
||||
### Diagnostics information
|
||||
|
||||
Provide a summary of your issue and tell us what's wrong.
|
||||
Consider uploading [the diagnostics file](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics) along with your issue report to allow faster triaging and pinpointing the issue.
|
||||
The information contained in the generated diagnostics file is redacted to avoid any sensitive information while still remaining useful for developers to fix the issue.
|
||||
|
||||
There are integrations and platform which require additional steps (installing third-party tools, compilers, etc.) to get your setup working. Please describe the steps you took and the ones to reproduce the issue if needed.
|
||||
|
||||
### Problem-relevant `configuration.yaml` entries
|
||||
|
||||
@ -46,23 +52,18 @@ sensor:
|
||||
|
||||
Make sure that you don't post your username, password, API key, access token or other [secrets](/docs/configuration/secrets/).
|
||||
|
||||
### Diagnostics information
|
||||
|
||||
Consider uploading [the diagnostics file](docs/configuration/troubleshooting/#debug-logs-and-diagnostics) along with your issue report to allow faster triaging and pinpointing the issue.
|
||||
The information contained in the generated diagnostics file is redacted to avoid any sensitive information while still remaining useful for developers to fix the issue.
|
||||
|
||||
### Traceback and log information (if applicable)
|
||||
|
||||
If things go wrong, there will be a so-called traceback or an error message [in your log](https://my.home-assistant.io/redirect/logs/). Please include this. It starts with **Traceback** and can contain information about where the error was triggered in the code.
|
||||
If things go wrong, there will be a so-called traceback or an error message {% my logs title="in your log" %}. Please include this. It starts with **Traceback** and can contain information about where the error was triggered in the code.
|
||||
|
||||
```bash
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
```
|
||||
|
||||
In some cases, it is also necessary to [enable debug logging](docs/configuration/troubleshooting/#debug-logs-and-diagnostics) to get detailed logs to triage an issue.
|
||||
In some cases, it is also necessary to [enable debug logging](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics) to get detailed logs to triage an issue.
|
||||
Enabling this will instruct Home Assistant to log a lot of fine-grained information about the integration. This is helpful for debugging and fixing the issue.
|
||||
In contrast to the diagnostics information, debug logs are not automatically redacted. Make sure to include only the parts you think are relevant to the issue.
|
||||
In contrast to the diagnostics information, debug logs are not automatically redacted. Make sure to include only the parts you think are relevant to the issue.
|
||||
|
||||
### Additional information
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user