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 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add diagnostics documentation (#21487)

Browse Source 
Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
Franck Nijhof 2022-02-05 01:39:21 +01:00 committed by GitHub
parent 7400eb6947
commit 682ca07d30
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
source/_integrations/diagnostics.markdown Normal file
View File

@ -0,0 +1,30 @@
---
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
---
The diagnostics integration provides a way to download diagnostic data from
a device or 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.