mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-10 04:58:59 +00:00
4bb544e615
* d and e integrations: apply sentence-style capitalization - add references to glossary terms * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * Apply suggestions from code review Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * Fix typo --------- Co-authored-by: Joakim Sørensen <joasoe@gmail.com> Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
---
|
|
title: Diagnostics
|
|
description: The diagnostics integration can provide integration and device information for debugging purposes.
|
|
ha_category:
|
|
- Other
|
|
ha_release: 2022.2
|
|
ha_quality_scale: internal
|
|
ha_domain: diagnostics
|
|
ha_codeowners:
|
|
- '@home-assistant/core'
|
|
ha_integration_type: system
|
|
---
|
|
|
|
The diagnostics {% term integration %} provides a way to download diagnostic data from
|
|
a {% term device %} or {% term integration %}, that can be shared in issue reports. Sharing
|
|
diagnostics data when reporting an issue allows developers to diagnose
|
|
and fix your reported problem quicker.
|
|
|
|
<p class='img'>
|
|
<img class="no-shadow" src='/images/blog/2022-02/diagnostics.png' alt='Screenshot showing the Download Diagnostics button on a Sonos device page'>
|
|
Screenshot of the download diagnostics button on the device page
|
|
</p>
|
|
|
|
Diagnostics data is provided by an integration, and can be downloaded
|
|
as a text file on the device page, and from the integrations dashboard.
|
|
|
|
Integrations are required to redact sensitive information from the diagnostics
|
|
data, you can always open the text file and check it, before you send
|
|
it in a public issue.
|
|
|
|
The diagnostics integration is by default enabled, no action is required to
|
|
enable it. However, not all integrations provide the possibility to download
|
|
diagnostic data.
|