mirror of
https://github.com/esphome/esphome.git
synced 2025-09-01 19:02:18 +01:00
Add runtime_stats component for performance debugging and analysis (#9386)
Co-authored-by: Keith Burzinski <kbx81x@gmail.com>
This commit is contained in:
2
tests/components/runtime_stats/common.yaml
Normal file
2
tests/components/runtime_stats/common.yaml
Normal file
@@ -0,0 +1,2 @@
|
||||
# Test runtime_stats component with default configuration
|
||||
runtime_stats:
|
1
tests/components/runtime_stats/test.esp32-ard.yaml
Normal file
1
tests/components/runtime_stats/test.esp32-ard.yaml
Normal file
@@ -0,0 +1 @@
|
||||
<<: !include common.yaml
|
39
tests/integration/fixtures/runtime_stats.yaml
Normal file
39
tests/integration/fixtures/runtime_stats.yaml
Normal file
@@ -0,0 +1,39 @@
|
||||
esphome:
|
||||
name: runtime-stats-test
|
||||
|
||||
host:
|
||||
|
||||
api:
|
||||
|
||||
logger:
|
||||
level: DEBUG
|
||||
logs:
|
||||
runtime_stats: INFO
|
||||
|
||||
runtime_stats:
|
||||
log_interval: 1s
|
||||
|
||||
# Add some components that will execute periodically to generate stats
|
||||
sensor:
|
||||
- platform: template
|
||||
name: "Test Sensor 1"
|
||||
id: test_sensor_1
|
||||
lambda: return 42.0;
|
||||
update_interval: 0.1s
|
||||
|
||||
- platform: template
|
||||
name: "Test Sensor 2"
|
||||
id: test_sensor_2
|
||||
lambda: return 24.0;
|
||||
update_interval: 0.2s
|
||||
|
||||
switch:
|
||||
- platform: template
|
||||
name: "Test Switch"
|
||||
id: test_switch
|
||||
optimistic: true
|
||||
|
||||
interval:
|
||||
- interval: 0.5s
|
||||
then:
|
||||
- switch.toggle: test_switch
|
88
tests/integration/test_runtime_stats.py
Normal file
88
tests/integration/test_runtime_stats.py
Normal file
@@ -0,0 +1,88 @@
|
||||
"""Test runtime statistics component."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import re
|
||||
|
||||
import pytest
|
||||
|
||||
from .types import APIClientConnectedFactory, RunCompiledFunction
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_runtime_stats(
|
||||
yaml_config: str,
|
||||
run_compiled: RunCompiledFunction,
|
||||
api_client_connected: APIClientConnectedFactory,
|
||||
) -> None:
|
||||
"""Test runtime stats logs statistics at configured interval and tracks components."""
|
||||
loop = asyncio.get_running_loop()
|
||||
|
||||
# Track how many times we see the total stats
|
||||
stats_count = 0
|
||||
first_stats_future = loop.create_future()
|
||||
second_stats_future = loop.create_future()
|
||||
|
||||
# Track component stats
|
||||
component_stats_found = set()
|
||||
|
||||
# Patterns to match - need to handle ANSI color codes and timestamps
|
||||
# The log format is: [HH:MM:SS][color codes][I][tag]: message
|
||||
total_stats_pattern = re.compile(r"Total stats \(since boot\):")
|
||||
# Match component names that may include dots (e.g., template.sensor)
|
||||
component_pattern = re.compile(
|
||||
r"^\[[^\]]+\].*?\s+([\w.]+):\s+count=(\d+),\s+avg=([\d.]+)ms"
|
||||
)
|
||||
|
||||
def check_output(line: str) -> None:
|
||||
"""Check log output for runtime stats messages."""
|
||||
nonlocal stats_count
|
||||
|
||||
# Check for total stats line
|
||||
if total_stats_pattern.search(line):
|
||||
stats_count += 1
|
||||
|
||||
if stats_count == 1 and not first_stats_future.done():
|
||||
first_stats_future.set_result(True)
|
||||
elif stats_count == 2 and not second_stats_future.done():
|
||||
second_stats_future.set_result(True)
|
||||
|
||||
# Check for component stats
|
||||
match = component_pattern.match(line)
|
||||
if match:
|
||||
component_name = match.group(1)
|
||||
component_stats_found.add(component_name)
|
||||
|
||||
async with (
|
||||
run_compiled(yaml_config, line_callback=check_output),
|
||||
api_client_connected() as client,
|
||||
):
|
||||
# Verify device is connected
|
||||
device_info = await client.device_info()
|
||||
assert device_info is not None
|
||||
|
||||
# Wait for first "Total stats" log (should happen at 1s)
|
||||
try:
|
||||
await asyncio.wait_for(first_stats_future, timeout=5.0)
|
||||
except asyncio.TimeoutError:
|
||||
pytest.fail("First 'Total stats' log not seen within 5 seconds")
|
||||
|
||||
# Wait for second "Total stats" log (should happen at 2s)
|
||||
try:
|
||||
await asyncio.wait_for(second_stats_future, timeout=5.0)
|
||||
except asyncio.TimeoutError:
|
||||
pytest.fail(f"Second 'Total stats' log not seen. Total seen: {stats_count}")
|
||||
|
||||
# Verify we got at least 2 stats logs
|
||||
assert stats_count >= 2, (
|
||||
f"Expected at least 2 'Total stats' logs, got {stats_count}"
|
||||
)
|
||||
|
||||
# Verify we found stats for our components
|
||||
assert "template.sensor" in component_stats_found, (
|
||||
f"Expected template.sensor stats, found: {component_stats_found}"
|
||||
)
|
||||
assert "template.switch" in component_stats_found, (
|
||||
f"Expected template.switch stats, found: {component_stats_found}"
|
||||
)
|
Reference in New Issue
Block a user