From 682ca07d30563a9131ec82c1cb80423bcfea20cd Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sat, 5 Feb 2022 01:39:21 +0100 Subject: [PATCH] Add diagnostics documentation (#21487) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Joakim Sørensen --- source/_integrations/diagnostics.markdown | 30 +++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 source/_integrations/diagnostics.markdown diff --git a/source/_integrations/diagnostics.markdown b/source/_integrations/diagnostics.markdown new file mode 100644 index 00000000000..ec20dbd6f54 --- /dev/null +++ b/source/_integrations/diagnostics.markdown @@ -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. + +

+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.