Skip to content

Add request context logging for failed HASS API calls #2465

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Add request context logging for failed HASS API calls #2465

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5695c50
Add request context logging for failed HASS API calls
ekutner Nov 2, 2025
cff5b6b
fix member name
ekutner Nov 6, 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
9 changes: 7 additions & 2 deletions appdaemon/plugins/hass/hassplugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ class HassPlugin(PluginBase):

_result_futures: dict[int, asyncio.Future]
_silent_results: dict[int, bool]
_request_context: dict[int, dict[str, Any]]
startup_conditions: list[StartupWaitCondition]
maintenance_tasks: list[asyncio.Task]
"""List of tasks that run in the background as part of the plugin operation. These are tracked because they might
Expand All @@ -98,6 +99,7 @@ def __init__(self, ad: "AppDaemon", name: str, config: HASSConfig):
self.services = {}
self._result_futures = {}
self._silent_results = {}
self._request_context = {}
self.startup_conditions = []
self.maintenance_tasks = []

Expand Down Expand Up @@ -270,6 +272,7 @@ async def ping(self, timeout: float = 1.0) -> dict[str, Any] | None:
@utils.warning_decorator(error_text="Unexpected error during receive_result")
async def receive_result(self, resp: dict):
silent = self._silent_results.pop(resp["id"], False) or self.AD.config.suppress_log_messages
request_context = self._request_context.pop(resp["id"], {})

if (future := self._result_futures.pop(resp["id"], None)) is not None:
if not future.done():
Expand All @@ -286,9 +289,9 @@ async def receive_result(self, resp: dict):
case True:
self.logger.debug(f"Received successful result from ID {resp['id']}")
case False:
self.logger.warning("Error with websocket result: %s: %s", resp["error"]["code"], resp["error"]["message"])
self.logger.warning("Error with websocket result: %s: %s: request=%s", resp["error"]["code"], resp["error"]["message"], str(request_context))
case None:
self.logger.error(f"Invalid response success value: {resp['success']}")
self.logger.error(f"Invalid response success value: {resp['success']} for request: {str(request_context)}")

@utils.warning_decorator(error_text="Unexpected error during receive_event")
async def receive_event(self, event: dict[str, Any]) -> None:
Expand Down Expand Up @@ -416,6 +419,7 @@ async def websocket_send_json(
future = self.AD.loop.create_future()
self._result_futures[self.id] = future
self._silent_results[self.id] = silent
self._request_context[self.id] = request

try:
timeout = utils.parse_timedelta(self.config.ws_timeout if timeout is None else timeout)
Expand Down Expand Up @@ -596,6 +600,7 @@ async def get_updates(self):
fut.cancel()
self._result_futures.clear()
self._silent_results.clear()
self._request_context.clear()

# remove callback from getting local events
await self.AD.callbacks.clear_callbacks(self.name)
Expand Down
Loading