Skip to content

Improve error message clarity by specifying to check supervisor logs #6250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 4, 2025
Merged

Improve error message clarity by specifying to check supervisor logs #6250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a0d0ff
Improve error message clarity by specifying to check supervisor logs …
cogneato Oct 13, 2025
047c568
Fix ruff, supervisor -> Supervisor
sairon Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion supervisor/api/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ def api_return_error(
if check_exception_chain(error, DockerAPIError):
message = format_message(message)
if not message:
message = "Unknown error, see supervisor"
message = "Unknown error, see Supervisor logs (check with 'ha supervisor logs')"

match error_type:
case const.CONTENT_TYPE_TEXT:
Expand Down
4 changes: 3 additions & 1 deletion supervisor/jobs/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,9 @@ class SupervisorJobError:
"""Representation of an error occurring during a supervisor job."""

type_: type[HassioError] = HassioError
message: str = "Unknown error, see supervisor logs"
message: str = (
"Unknown error, see Supervisor logs (check with 'ha supervisor logs')"
)
stage: str | None = None

def as_dict(self) -> dict[str, str | None]:
Expand Down
4 changes: 2 additions & 2 deletions tests/jobs/test_job_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ async def test_notify_on_change(coresys: CoreSys, ha_ws_client: AsyncMock):
"errors": [
{
"type": "HassioError",
"message": "Unknown error, see supervisor logs",
"message": "Unknown error, see Supervisor logs (check with 'ha supervisor logs')",
"stage": "test",
}
],
Expand Down Expand Up @@ -226,7 +226,7 @@ async def test_notify_on_change(coresys: CoreSys, ha_ws_client: AsyncMock):
"errors": [
{
"type": "HassioError",
"message": "Unknown error, see supervisor logs",
"message": "Unknown error, see Supervisor logs (check with 'ha supervisor logs')",
"stage": "test",
}
],
Expand Down
Loading