Gold and platinum integrations should implement diagnostic #117576

epenet · 2024-05-16T15:39:30Z

home-assistant · 2024-05-16T15:39:33Z

Hey there @fredrike, mind taking a look at this issue as it has been labeled with an integration (point) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of point can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign point Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

point documentation
point source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:33Z

Hey there @fredrike, mind taking a look at this issue as it has been labeled with an integration (tellduslive) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of tellduslive can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign tellduslive Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

tellduslive documentation
tellduslive source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:33Z

Hey there @janiversen, mind taking a look at this issue as it has been labeled with an integration (modbus) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of modbus can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign modbus Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

modbus documentation
modbus source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:34Z

Hey there @dermotduffy, mind taking a look at this issue as it has been labeled with an integration (hyperion) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of hyperion can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign hyperion Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

hyperion documentation
hyperion source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:34Z

Hey there @mdz, mind taking a look at this issue as it has been labeled with an integration (smarttub) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of smarttub can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign smarttub Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

smarttub documentation
smarttub source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:34Z

Hey there @OnFreund, mind taking a look at this issue as it has been labeled with an integration (risco) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of risco can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign risco Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

risco documentation
risco source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:34Z

Hey there @rytilahti, @shenxn, mind taking a look at this issue as it has been labeled with an integration (songpal) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of songpal can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign songpal Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

songpal documentation
songpal source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:34Z

Hey there @exxamalte, mind taking a look at this issue as it has been labeled with an integration (gdacs) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of gdacs can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign gdacs Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

gdacs documentation
gdacs source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:34Z

Hey there @exxamalte, mind taking a look at this issue as it has been labeled with an integration (geonetnz_quakes) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of geonetnz_quakes can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign geonetnz_quakes Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

geonetnz_quakes documentation
geonetnz_quakes source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:34Z

Hey there @marciogranzotto, mind taking a look at this issue as it has been labeled with an integration (nightscout) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of nightscout can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign nightscout Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

nightscout documentation
nightscout source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:34Z

Hey there @raman325, mind taking a look at this issue as it has been labeled with an integration (vizio) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of vizio can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign vizio Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

vizio documentation
vizio source
_{^{(message by IssueLinks)}}

home-assistant · 2024-05-16T15:39:35Z

Hey there @zewelor, @shenxn, @starkillerOG, @alexyao2015, mind taking a look at this issue as it has been labeled with an integration (yeelight) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of yeelight can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Renames the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign yeelight Removes the current integration label and assignees on the issue, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

yeelight documentation
yeelight source
_{^{(message by IssueLinks)}}

MatthewFlamm · 2024-05-16T15:49:54Z

Is there documentation for the diagnostic platform implementation somewhere? A search for "diagnostics" returns only hits for entity_category or snapshot testing in the dev docs.

rytilahti · 2024-05-16T16:08:14Z

@MatthewFlamm alas, no, not yet. But the implementation is usually rather simple, especially if one is using data update coordinator, for example: https://github.com/home-assistant/core/blob/dev/homeassistant/components/nam/diagnostics.py shows a very minimal implementation.

It's important to go through the data and scrub the unwanted keys as issue reporters may be asked to upload these files. Another example showing much more data being scrubbed can be seen in tplink/diagnostic.py.

janiversen · 2024-05-16T16:36:21Z

That link would not work for the modbus integration! Be aware that the modbus protocol do not have diagnostic capabilities, so real diagnostic would be nearly impossible to add.

We could of course make a service call that turns on debug, which is just about as close you can get to "diagnostic".

Please advice if the "should implement" will become a demand. That will exclude quite a number of integrations to maintain a platinum/gold status.

Personally I think the correct way would be to define the diagnostic demands before asking integrations to implement "something".

OnFreund · 2024-05-16T16:45:27Z

First of all I want to echo @janiversen's sentiment - if implementing diagnostics is a requirement, we should properly document it. In particular, it would be helpful to understand how it's used and what it's used for.
This leads me to the second point, which is that without further understanding of diagnostics I don't see how to implement this in the Risco integration. Since it's a security system, almost any piece of data that might be relevant for debugging would be redacted.

janiversen · 2024-05-16T17:11:26Z

A question can "async_get_config_entry_diagnostics" be used by integrations that are yaml based (I cannot find the platform as a configEntry).

It seems to work at entity level, but e.g. modbus is connection oriented so there no extra information pr entity as to what is already available in the entity state. At connection level (platform) the only diagnostic available is connected/disconnected which the user already knows if all entities are unavailable.

Another example is the fronius integration it uses the modbus integration for communication, so diagnostic what type of diagnostic should that integration provide ?

But of course modbus integration can return a near empty dict, but I highly doubt it will help any users.

And just to be sure, I think implementing diagnostic where available is a splendid idea but the "should" should be modified to "should if possible and it adds additional information".

MatthewFlamm · 2024-05-16T17:35:09Z

Looking at the how this works async_redact_data uses an opt-out policy for including data, meaning that you have to supply the keys to remove. All other data will be included. The data in my integration has keys with variations like "id" and "@id" that contain potentially sensitive information. And I'm not confident that new ones won't be added by the upstream API, or that the API won't accidentally mess up the data structure leaking sensitive information. This is a security problem. I would be much more confident to add this with an opt-in policy, something like async_redact_data_except where only the keys provided are collected for diagnostics.

In this case where we are unsure that the redaction process is complete, is it sufficient to just add in the config entry data that is completed redacted? This gets to @janiversen comment that this would be useless, but only to satisfy the integration level requirement.

joostlek · 2024-05-16T17:37:17Z

You can always just compile your own set of data to return. The async_redact_data is there because the majority case is that we have a bunch of uniform data that needs redacting.

tronikos · 2024-05-16T18:20:40Z

The requirement page at https://developers.home-assistant.io/docs/integration_quality_scale_index/ says: "When communicating with a device or service, the integration implements the diagnostics platform which redacts sensitive information."
The Google Assistant SDK integration doesn't add any device or entity so I thought I could skip the diagnostics platform. I cannot think of what I could include in diagnostics. Any recommendations?

joostlek · 2024-05-16T18:26:51Z

I mean, it still connects to a service. The only thing I could think off would be putting the language code in there.

farmio · 2024-05-16T18:44:20Z

@janiversen in knx we use it to dump the whole yaml config. Maybe that would be an option for Modbus too.
fronius integration doesn't use Modbus btw. but a local HTTP API. Not really sure what to log here though.

joostlek · 2024-05-16T18:46:25Z

Modbus isn't config entry based, so does diagnostics even work for them?

tronikos · 2024-05-16T18:51:30Z

Yes Google Assistant SDK still connects to a service but my understanding of: "When communicating with a device or service" refers to https://developers.home-assistant.io/docs/architecture/devices-and-services/ which doesn't apply here. Putting just the language code in diagnostics isn't particularly useful.

janiversen · 2024-05-16T18:55:02Z

@joostlek that is my point from earlier, the definition is "When communicating with a device or service, the integration implements the diagnostics platform which redacts sensitive information.", and not like the other demands, which have "if available", so it seems it MUST be implemented even if it does not work.

What I will be doing for modbus is to dump state of the entity...but honestly it is only to satisfy the quality demand, as it will not help in diagnosing a problem.

There is also something that I do not understand, the diagnostic platform is targeted at end-users, but it seems the dict is not being translated (I might have missed it, but at least the example tplink/diagnostic.py, does not use strings.json ??

joostlek · 2024-05-16T18:57:19Z

I think that wording comes from one of the Adr, modbus is a protocol integration like mqtt. And it doesn't connect with a specific device.

janiversen · 2024-05-16T19:23:23Z

The text says "device or service, modbus communicates with a specific device !! and it was added to this PR so surely someone thinks it should be done.

MatthewFlamm · 2024-05-16T19:28:49Z

I cannot edit the issue description, but nws is completed in #117587. Thanks for the pointers and quick merge!

epenet · 2024-05-21T07:21:11Z

I have adjusted the description above.
If an integration is unable to implement diagnostic, then a PR should be opened to add a comment against the integration in script/hassfest/manifest.py, explaining why it cannot be implemented.

core/script/hassfest/manifest.py

Lines 118 to 136 in d1bdf73

    
           NO_DIAGNOSTICS = [ 
        
               "dlna_dms", 
        
               "fronius", 
        
               "gdacs", 
        
               "geonetnz_quakes", 
        
               "google_assistant_sdk", 
        
               "hyperion", 
        
               # Modbus is excluded because it doesn't have to have a config flow 
        
               # according to ADR-0010, since it's a protocol integration. This 
        
               # means that it can't implement diagnostics. 
        
               "modbus", 
        
               "nightscout", 
        
               "pvpc_hourly_pricing", 
        
               "risco", 
        
               "smarttub", 
        
               "songpal", 
        
               "vizio", 
        
               "yeelight", 
        
           ]

tronikos · 2024-05-30T19:32:33Z

#118513 takes care of Google Assistant SDK

home-assistant bot assigned janiversen and rytilahti May 16, 2024

joostlek added the no-stale label May 16, 2024

epenet mentioned this issue May 16, 2024

Ensure gold and platinum integrations implement diagnostic #117565

Merged

20 tasks

rytilahti mentioned this issue May 16, 2024

Document diagnostics platform home-assistant/developers.home-assistant#1551

Open

MatthewFlamm mentioned this issue May 16, 2024

Add diagnostics for nws #117587

Merged

20 tasks

janiversen mentioned this issue May 16, 2024

Add diagnostics to modbus (Satisfy quality demand) #117591

Closed

20 tasks

This was referenced May 20, 2024

Downgrade point quality scale to silver #117783

Merged

Downgrade tellduslive quality scale to silver #117784

Merged

farmio mentioned this issue May 21, 2024

Add diagnostics support for Fronius #117845

Merged

20 tasks

epenet mentioned this issue May 21, 2024

Exclude modbus from diagnostics hassfest check #117855

Merged

20 tasks

janiversen removed their assignment May 30, 2024

tronikos mentioned this issue May 30, 2024

Add Google Assistant SDK diagnostics #118513

Merged

20 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Gold and platinum integrations should implement diagnostic #117576

Gold and platinum integrations should implement diagnostic #117576

epenet commented May 16, 2024 •

edited

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

MatthewFlamm commented May 16, 2024

rytilahti commented May 16, 2024 •

edited

janiversen commented May 16, 2024

OnFreund commented May 16, 2024 •

edited

janiversen commented May 16, 2024

MatthewFlamm commented May 16, 2024 •

edited

joostlek commented May 16, 2024

tronikos commented May 16, 2024

joostlek commented May 16, 2024

farmio commented May 16, 2024

joostlek commented May 16, 2024

tronikos commented May 16, 2024

janiversen commented May 16, 2024

joostlek commented May 16, 2024

janiversen commented May 16, 2024

MatthewFlamm commented May 16, 2024

epenet commented May 21, 2024 •

edited

tronikos commented May 30, 2024

Gold and platinum integrations should implement diagnostic #117576

Gold and platinum integrations should implement diagnostic #117576

Comments

epenet commented May 16, 2024 • edited

The problem

What version of Home Assistant Core has the issue?

What was the last working version of Home Assistant Core?

What type of installation are you running?

Integration causing the issue

Link to integration documentation on our website

Diagnostics information

Example YAML snippet

Anything in the logs that might be useful for us?

Additional information

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

home-assistant bot commented May 16, 2024

MatthewFlamm commented May 16, 2024

rytilahti commented May 16, 2024 • edited

janiversen commented May 16, 2024

OnFreund commented May 16, 2024 • edited

janiversen commented May 16, 2024

MatthewFlamm commented May 16, 2024 • edited

joostlek commented May 16, 2024

tronikos commented May 16, 2024

joostlek commented May 16, 2024

farmio commented May 16, 2024

joostlek commented May 16, 2024

tronikos commented May 16, 2024

janiversen commented May 16, 2024

joostlek commented May 16, 2024

janiversen commented May 16, 2024

MatthewFlamm commented May 16, 2024

epenet commented May 21, 2024 • edited

tronikos commented May 30, 2024

epenet commented May 16, 2024 •

edited

rytilahti commented May 16, 2024 •

edited

OnFreund commented May 16, 2024 •

edited

MatthewFlamm commented May 16, 2024 •

edited

epenet commented May 21, 2024 •

edited