Instruction file imported from woutercoppens/home-assistant-test (.github/instructions/diagnostics.instructions.md). Copyright stays with the author.

Diagnostics Instructions

Applies to: Diagnostics implementation files

Critical: Always Redact Sensitive Data

Use async_redact_data() for all user data:

from homeassistant.helpers.redact import async_redact_data
from homeassistant.const import CONF_PASSWORD, CONF_USERNAME

# Define what to redact
TO_REDACT = {
    CONF_PASSWORD,
    CONF_USERNAME,
    "api_key",
    "token",
    "refresh_token",
}

async def async_get_config_entry_diagnostics(
    hass: HomeAssistant,
    entry: ConfigEntry,
) -> dict[str, Any]:
    """Return diagnostics for a config entry."""
    coordinator: OpenMoticsDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id].coordinator

    return {
        "entry_data": async_redact_data(entry.data, TO_REDACT),
        "entry_options": async_redact_data(entry.options, TO_REDACT),
        "coordinator_data": coordinator.data,
    }

Never Expose

The following must ALWAYS be redacted:

• Passwords
• API keys / tokens (access_token, refresh_token, api_key, etc.)
• OAuth credentials
• Location data (latitude/longitude)
• Personal information (email, phone, name)
• Device serial numbers (if considered sensitive)
• MAC addresses (use format_mac if needed for identification)

When in Doubt

If you're unsure whether data is sensitive, redact it. Better to redact too much than expose credentials.