Improve logging messages

Author: jscruz

custom_components/carbon_intensity_uk/__init__.py

@@ -6,7 +6,6 @@
 """
 import asyncio
 import logging
-import traceback
 from datetime import timedelta
 
 from homeassistant.config_entries import ConfigEntry
@@ -42,25 +41,22 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
         _LOGGER.info(STARTUP_MESSAGE)
 
     postcode = entry.data.get(CONF_POSTCODE)
-    _LOGGER.error("[carbon_intensity_uk] Setting up entry for postcode: %s", postcode)
+    _LOGGER.debug("Setting up Carbon Intensity UK for postcode: %s", postcode)
 
     coordinator = CarbonIntensityDataUpdateCoordinator(hass, postcode=postcode)
-    _LOGGER.error("[carbon_intensity_uk] Triggering initial coordinator refresh")
+    _LOGGER.debug("Performing initial data fetch for postcode: %s", postcode)
     await coordinator.async_refresh()
-    _LOGGER.error(
-        "[carbon_intensity_uk] Refresh done. last_update_success=%s data=%s",
-        coordinator.last_update_success,
-        coordinator.data,
-    )
 
     if not coordinator.last_update_success:
-        _LOGGER.error("[carbon_intensity_uk] Coordinator refresh failed — raising ConfigEntryNotReady")
+        _LOGGER.warning(
+            "Initial data fetch failed for postcode %s — will retry on next poll", postcode
+        )
         raise ConfigEntryNotReady
 
     hass.data[DOMAIN][entry.entry_id] = coordinator
 
     platforms = [p for p in PLATFORMS if entry.options.get(p, True)]
-    _LOGGER.error("[carbon_intensity_uk] Forwarding setup to platforms: %s", platforms)
+    _LOGGER.debug("Forwarding entry setup to platforms: %s", platforms)
     coordinator.platforms.extend(platforms)
     await hass.config_entries.async_forward_entry_setups(entry, platforms)
 
@@ -83,23 +79,24 @@ def __init__(self, hass, postcode):
     async def _async_update_data(self):
         """Update data via library."""
         try:
-            _LOGGER.error("[carbon_intensity_uk] Fetching data from API")
+            _LOGGER.debug("Fetching data from Carbon Intensity API")
             data = await self.api.async_get_data()
-            _LOGGER.error("[carbon_intensity_uk] Raw API response: %s", data)
             result = data.get("data", {})
-            _LOGGER.error("[carbon_intensity_uk] Parsed data keys: %s", list(result.keys()) if isinstance(result, dict) else result)
+            _LOGGER.debug(
+                "Data fetch succeeded: index=%s, forecast=%s gCO2/kWh",
+                result.get("current_period_index"),
+                result.get("current_period_forecast"),
+            )
             return result
         except Exception as exception:
-            _LOGGER.error(
-                "[carbon_intensity_uk] Exception fetching data: %s\n%s",
-                exception,
-                traceback.format_exc(),
-            )
+            _LOGGER.warning("Failed to fetch data from Carbon Intensity API: %s", exception)
             raise UpdateFailed(exception)
 
 
 async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
     """Handle removal of an entry."""
+    postcode = entry.data.get(CONF_POSTCODE)
+    _LOGGER.debug("Unloading Carbon Intensity UK entry for postcode: %s", postcode)
     coordinator = hass.data[DOMAIN][entry.entry_id]
     unloaded = all(
         await asyncio.gather(
@@ -112,11 +109,15 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
     )
     if unloaded:
         hass.data[DOMAIN].pop(entry.entry_id)
+        _LOGGER.debug("Successfully unloaded Carbon Intensity UK entry for postcode: %s", postcode)
+    else:
+        _LOGGER.warning("Failed to unload one or more platforms for postcode: %s", postcode)
 
     return unloaded
 
 
 async def async_reload_entry(hass: HomeAssistant, entry: ConfigEntry):
     """Reload config entry."""
+    _LOGGER.debug("Reloading Carbon Intensity UK entry for postcode: %s", entry.data.get(CONF_POSTCODE))
     await async_unload_entry(hass, entry)
     await async_setup_entry(hass, entry)

custom_components/carbon_intensity_uk/config_flow.py

@@ -37,12 +37,12 @@ async def async_step_user(
         if user_input is not None:
             valid = await self._test_credentials(user_input[CONF_POSTCODE])
             if valid:
-                _LOGGER.debug("Input is valid")
+                _LOGGER.debug("Postcode %s validated, creating config entry", user_input[CONF_POSTCODE])
                 return self.async_create_entry(
                     title=user_input[CONF_POSTCODE], data=user_input
                 )
             else:
-                _LOGGER.debug("Input not valid")
+                _LOGGER.warning("Postcode %s failed validation — check it is a valid UK postcode area", user_input[CONF_POSTCODE])
                 self._errors["base"] = "auth"
 
             return await self._show_config_form(user_input)
@@ -67,11 +67,10 @@ async def _test_credentials(self, postcode):
         try:
             client = CarbonIntentisityApi(postcode)
             await client.async_get_data()
-            _LOGGER.debug("Input successfully")
+            _LOGGER.debug("API connectivity test for postcode %s succeeded", postcode)
             return True
         except Exception as exception:  # pylint: disable=broad-except
-            _LOGGER.debug(exception)
-        _LOGGER.debug("Oops! Input failed!")
+            _LOGGER.warning("API connectivity test for postcode %s failed: %s", postcode, exception)
         return False
 
 

custom_components/carbon_intensity_uk/sensor.py

@@ -90,12 +90,8 @@
 async def async_setup_entry(hass, entry, async_add_devices):
     """Setup sensor platform."""
     coordinator = hass.data[DOMAIN][entry.entry_id]
-    _LOGGER.error(
-        "[carbon_intensity_uk] sensor async_setup_entry — coordinator data keys: %s",
-        list(coordinator.data.keys()) if coordinator.data else None,
-    )
     sensors = [CarbonIntensitySensor(coordinator, entry, sensor) for sensor in SENSOR_TYPES]
-    _LOGGER.error("[carbon_intensity_uk] Creating %d sensors: %s", len(sensors), [s.name for s in sensors])
+    _LOGGER.debug("Registering %d Carbon Intensity UK sensors", len(sensors))
     async_add_devices(sensors)