home-assistant.io/source/_integrations/diagnostics.markdown
c0ffeeca7 4bb544e615
d and e integrations: apply sentence-style capitalization (#29901)
* 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>
2023-11-19 14:03:36 +01:00

1.3 KiB

title, description, ha_category, ha_release, ha_quality_scale, ha_domain, ha_codeowners, ha_integration_type
title description ha_category ha_release ha_quality_scale ha_domain ha_codeowners ha_integration_type
Diagnostics The diagnostics integration can provide integration and device information for debugging purposes.
Other
2022.2 internal diagnostics
@home-assistant/core
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.

Screenshot showing the Download Diagnostics button on a Sonos device page Screenshot of the download diagnostics button on the device page

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.