Merge pull request #3794 from bramstroker/feat/group-types-analytics

Add group type counts to analytics

Author: bramstroker

custom_components/powercalc/analytics/analytics.py

@@ -23,6 +23,7 @@
     DATA_ANALYTICS,
     DATA_CONFIG_TYPES,
     DATA_GROUP_SIZES,
+    DATA_GROUP_TYPES,
     DATA_HAS_GROUP_INCLUDE,
     DATA_POWER_PROFILES,
     DATA_SENSOR_TYPES,
@@ -32,6 +33,7 @@
     DOMAIN_CONFIG,
     ENTRY_GLOBAL_CONFIG_UNIQUE_ID,
     CalculationStrategy,
+    GroupType,
     SensorType,
 )
 from custom_components.powercalc.power_profile.library import ProfileLibrary
@@ -54,6 +56,7 @@ class RuntimeAnalyticsData(TypedDict, total=False):
     strategies: Counter[CalculationStrategy]
     power_profiles: list[PowerProfile]
     source_domains: Counter[str]
+    group_types: Counter[GroupType]
     group_sizes: list[int]
     uses_include: bool
     _seen: dict[str, set[str]]
@@ -170,6 +173,7 @@ async def _prepare_payload(self) -> dict:
                 "by_model": Counter(f"{profile.manufacturer}:{profile.model}" for profile in power_profiles),
                 "by_strategy": runtime_data.setdefault(DATA_STRATEGIES, Counter()),
                 "by_source_domain": runtime_data.setdefault(DATA_SOURCE_DOMAINS, Counter()),
+                "by_group_type": runtime_data.setdefault(DATA_GROUP_TYPES, Counter()),
             },
         }
 

custom_components/powercalc/const.py

@@ -35,6 +35,7 @@
 DATA_SENSOR_TYPES: Literal["sensor_types"] = "sensor_types"
 DATA_CONFIG_TYPES: Literal["config_types"] = "config_types"
 DATA_SOURCE_DOMAINS: Literal["source_domains"] = "source_domains"
+DATA_GROUP_TYPES: Literal["group_types"] = "group_types"
 DATA_STRATEGIES: Literal["strategies"] = "strategies"
 DATA_GROUP_SIZES: Literal["group_sizes"] = "group_sizes"
 DATA_HAS_GROUP_INCLUDE: Literal["has_group_include"] = "has_group_include"

custom_components/powercalc/sensors/group/factory.py

@@ -3,7 +3,8 @@
 from homeassistant.helpers.entity import Entity
 from homeassistant.helpers.typing import ConfigType
 
-from custom_components.powercalc.const import CONF_GROUP_TYPE, GroupType
+from custom_components.powercalc.analytics.analytics import collect_analytics
+from custom_components.powercalc.const import CONF_GROUP_TYPE, DATA_GROUP_TYPES, GroupType
 from custom_components.powercalc.errors import SensorConfigurationError
 import custom_components.powercalc.sensors.group.custom as custom_group
 import custom_components.powercalc.sensors.group.domain as domain_group
@@ -20,6 +21,8 @@ async def create_group_sensors(
 ) -> list[Entity]:
     """Create group sensors for a given sensor configuration."""
     group_type: GroupType = GroupType(sensor_config.get(CONF_GROUP_TYPE, GroupType.CUSTOM))
+    collect_analytics(hass, config_entry).inc(DATA_GROUP_TYPES, group_type)
+
     if group_type == GroupType.DOMAIN:
         return await domain_group.create_domain_group_sensor(
             hass,

docs/source/misc/analytics.md

@@ -28,6 +28,12 @@ The payload only contains **aggregated counts**, for example:
 - total number of Powercalc entities
 - counts per sensor type (e.g. virtual power, group, daily energy)
 - counts per manufacturer and model (aggregated)
+- counts per device type (e.g. light, plug)
+- counts per calculation strategy (e.g. lut, fixed)
+- counts per source domain (e.g. light, switch)
+- counts per group type (e.g. custom, standby)
+- group sizes (number of entities in each group)
+- whether group includes are used
 - Powercalc version and Home Assistant version
 
 No per-device identifiers are included.
@@ -53,16 +59,35 @@ No per-device identifiers are included.
         "by_manufacturer": {
           "shelly": 1,
           "signify": 4
+        },
+        "by_device_type": {
+          "light": 4,
+          "plug": 1
+        },
+        "by_strategy": {
+          "lut": 4,
+          "fixed": 1
+        },
+        "by_source_domain": {
+          "light": 4,
+          "switch": 1
+        },
+        "by_group_type": {
+          "custom": 1,
+          "standby": 1
         }
       },
       "ha_version": "2025.10.0.dev0",
       "install_id": "081ac191-2667-4242-8226-ecc66b1f7e9e",
-      "group_size_max": 2,
-      "group_size_min": 2,
+      "group_sizes": {
+        "2": 1,
+        "5": 1
+      },
       "powercalc_version": "0.1.1",
       "config_entry_count": 8,
       "custom_profile_count": 12,
-      "has_global_gui_config": true
+      "has_global_gui_config": true,
+      "has_group_include": false
     }
     ```
 

tests/analytics/test_analytics.py

@@ -23,6 +23,7 @@
     DOMAIN_CONFIG,
     SERVICE_RELOAD,
     CalculationStrategy,
+    GroupType,
     SensorType,
 )
 from tests.common import get_simple_fixed_config, run_powercalc_setup, setup_config_entry
@@ -240,3 +241,4 @@ async def test_group_sizes(hass: HomeAssistant) -> None:
     payload = await analytics._prepare_payload()  # noqa: SLF001
 
     assert payload["group_sizes"] == {6: 1, 10: 1}
+    assert payload["counts"]["by_group_type"] == {GroupType.CUSTOM: 2, GroupType.STANDBY: 1}