mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-22 19:08:17 +00:00
Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
73fff8d2d5 | ||
|
|
446207ffbc |
@@ -9,7 +9,7 @@ import time
|
|||||||
import logging
|
import logging
|
||||||
import threading
|
import threading
|
||||||
from typing import Dict, Optional, Any, Callable
|
from typing import Dict, Optional, Any, Callable
|
||||||
from dataclasses import dataclass, field, fields
|
from dataclasses import dataclass, field
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import psutil
|
import psutil
|
||||||
@@ -102,50 +102,6 @@ class PluginResourceMonitor:
|
|||||||
"psutil not available - resource monitoring will be limited to execution time only"
|
"psutil not available - resource monitoring will be limited to execution time only"
|
||||||
)
|
)
|
||||||
|
|
||||||
def _metrics_from_cache(self, plugin_id: str, cached: Any) -> "ResourceMetrics":
|
|
||||||
"""Build metrics from a cached record, ignoring anything unrecognised.
|
|
||||||
|
|
||||||
ResourceMetrics(**cached) raises TypeError on a single unexpected key,
|
|
||||||
and that exception escapes into plugin_manager, which reports it as
|
|
||||||
"plugin <id> operation failed". Every plugin fails, and the plugin
|
|
||||||
system never finishes initialising.
|
|
||||||
|
|
||||||
Seen on a live rig: every plugin failing with
|
|
||||||
|
|
||||||
ResourceMetrics.__init__() got an unexpected keyword argument
|
|
||||||
'consecutive_failures'
|
|
||||||
|
|
||||||
which is a plugin_health field, not a metrics one. How a health-shaped
|
|
||||||
record came to sit under a plugin_metrics key on that machine is not
|
|
||||||
established -- a restored backup that mixed two machines' caches is the
|
|
||||||
likeliest explanation -- but the loader should not be brittle enough for
|
|
||||||
it to matter. plugin_health already repairs its records field by field
|
|
||||||
rather than trusting whatever is on disk; this does the same.
|
|
||||||
|
|
||||||
Unknown keys are dropped and named once, so a genuine schema change is
|
|
||||||
visible in the log instead of silently discarded.
|
|
||||||
"""
|
|
||||||
if not isinstance(cached, dict):
|
|
||||||
self.logger.warning(
|
|
||||||
"Ignoring cached metrics for %s: expected a mapping, got %s",
|
|
||||||
plugin_id, type(cached).__name__)
|
|
||||||
return ResourceMetrics()
|
|
||||||
|
|
||||||
known = {f.name for f in fields(ResourceMetrics)}
|
|
||||||
unknown = sorted(set(cached) - known)
|
|
||||||
if unknown:
|
|
||||||
self.logger.warning(
|
|
||||||
"Dropping unrecognised field(s) from cached metrics for %s: %s",
|
|
||||||
plugin_id, ", ".join(unknown))
|
|
||||||
usable = {k: v for k, v in cached.items() if k in known}
|
|
||||||
try:
|
|
||||||
return ResourceMetrics(**usable)
|
|
||||||
except (TypeError, ValueError) as e:
|
|
||||||
self.logger.warning(
|
|
||||||
"Cached metrics for %s unusable (%s); starting fresh",
|
|
||||||
plugin_id, e)
|
|
||||||
return ResourceMetrics()
|
|
||||||
|
|
||||||
def _get_metrics_key(self, plugin_id: str) -> str:
|
def _get_metrics_key(self, plugin_id: str) -> str:
|
||||||
"""Get cache key for plugin metrics."""
|
"""Get cache key for plugin metrics."""
|
||||||
return f"plugin_metrics:{plugin_id}"
|
return f"plugin_metrics:{plugin_id}"
|
||||||
@@ -170,7 +126,7 @@ class PluginResourceMonitor:
|
|||||||
cache_key, max_age=None, memory_ttl=0 if force_reload else None
|
cache_key, max_age=None, memory_ttl=0 if force_reload else None
|
||||||
)
|
)
|
||||||
if cached:
|
if cached:
|
||||||
metrics = self._metrics_from_cache(plugin_id, cached)
|
metrics = ResourceMetrics(**cached)
|
||||||
else:
|
else:
|
||||||
metrics = ResourceMetrics()
|
metrics = ResourceMetrics()
|
||||||
self._metrics[plugin_id] = metrics
|
self._metrics[plugin_id] = metrics
|
||||||
|
|||||||
@@ -8,6 +8,18 @@ Type=simple
|
|||||||
User=root
|
User=root
|
||||||
WorkingDirectory=__PROJECT_ROOT_DIR__
|
WorkingDirectory=__PROJECT_ROOT_DIR__
|
||||||
Environment=PYTHONDONTWRITEBYTECODE=1
|
Environment=PYTHONDONTWRITEBYTECODE=1
|
||||||
|
# glibc gives each allocating thread its own malloc arena, up to 8 x CPU count,
|
||||||
|
# and an arena that has grown is never handed back to the OS. This process runs
|
||||||
|
# 9 threads on a 3-core Pi, so the ceiling is 24 arenas -- and a rig measured at
|
||||||
|
# 1030 MB resident held 23 large anonymous mappings on 64 MB-aligned addresses,
|
||||||
|
# 920 MB of them, while the live data it was actually holding (widest scroll
|
||||||
|
# strip seen: 35,746 x 64) accounts for roughly 15 MB. That gap is arena bloat,
|
||||||
|
# not leaked objects: RSS was flat across repeated sampling, not climbing.
|
||||||
|
#
|
||||||
|
# Capping the arenas trades a little allocator concurrency for a large amount of
|
||||||
|
# resident memory on a device that has neither to spare. 2 is the usual value;
|
||||||
|
# raise it if frame times regress.
|
||||||
|
Environment=MALLOC_ARENA_MAX=2
|
||||||
ExecStart=/usr/bin/python3 __PROJECT_ROOT_DIR__/run.py
|
ExecStart=/usr/bin/python3 __PROJECT_ROOT_DIR__/run.py
|
||||||
# Restart=always, not on-failure: run.py exiting 0 (a clean shutdown path taken
|
# Restart=always, not on-failure: run.py exiting 0 (a clean shutdown path taken
|
||||||
# for a reason that no longer applies, e.g. a config reload) would otherwise leave
|
# for a reason that no longer applies, e.g. a config reload) would otherwise leave
|
||||||
|
|||||||
@@ -1,100 +0,0 @@
|
|||||||
"""A malformed metrics cache entry must not take every plugin down with it.
|
|
||||||
|
|
||||||
`ResourceMetrics(**cached)` raises TypeError on a single unexpected key, and
|
|
||||||
that exception escapes into plugin_manager, which reports it per plugin as
|
|
||||||
"plugin <id> operation failed". Every plugin fails and the plugin system never
|
|
||||||
finishes initialising -- the health endpoint reports
|
|
||||||
`plugin_system: not_initialized` while the display itself keeps running.
|
|
||||||
|
|
||||||
Seen on a live rig, once per plugin, continuously:
|
|
||||||
|
|
||||||
ERROR - src.plugin_system.plugin_manager - plugin geochron operation failed:
|
|
||||||
ResourceMetrics.__init__() got an unexpected keyword argument
|
|
||||||
'consecutive_failures'
|
|
||||||
|
|
||||||
`consecutive_failures` belongs to plugin_health, not to metrics. How a
|
|
||||||
health-shaped record came to sit under a plugin_metrics key on that machine is
|
|
||||||
not established -- a restored backup that mixed two machines' caches is the
|
|
||||||
likeliest explanation, and the same rig had one restored onto it -- but a
|
|
||||||
loader that turns one bad cache entry into a total outage is the part worth
|
|
||||||
fixing. plugin_health already repairs its own records field by field rather
|
|
||||||
than trusting what is on disk.
|
|
||||||
"""
|
|
||||||
import logging
|
|
||||||
from dataclasses import fields
|
|
||||||
from unittest.mock import MagicMock
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from src.plugin_system.resource_monitor import PluginResourceMonitor, ResourceMetrics
|
|
||||||
|
|
||||||
|
|
||||||
class _Cache:
|
|
||||||
def __init__(self, payload=None):
|
|
||||||
self.payload = payload
|
|
||||||
|
|
||||||
def get(self, key, max_age=None, memory_ttl=None, **kwargs):
|
|
||||||
return self.payload
|
|
||||||
|
|
||||||
def set(self, key, data, ttl=None, **kwargs):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
def _monitor(payload):
|
|
||||||
m = PluginResourceMonitor(cache_manager=_Cache(payload))
|
|
||||||
m.logger = logging.getLogger("test")
|
|
||||||
return m
|
|
||||||
|
|
||||||
|
|
||||||
#: What the rig actually had under the metrics key.
|
|
||||||
HEALTH_SHAPED = {
|
|
||||||
"consecutive_failures": 0, "circuit_state": "closed",
|
|
||||||
"circuit_opened_time": None, "half_open_start_time": None,
|
|
||||||
"last_error": None, "last_failure_time": None,
|
|
||||||
"last_success_time": 1_700_000_000.0, "total_failures": 0,
|
|
||||||
"total_successes": 42,
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def test_a_health_record_under_the_metrics_key_does_not_raise():
|
|
||||||
"""The exact failure: it must degrade, not take the plugin system down."""
|
|
||||||
monitor = _monitor(HEALTH_SHAPED)
|
|
||||||
metrics = monitor.get_metrics(" plugin-a".strip())
|
|
||||||
assert isinstance(metrics, ResourceMetrics)
|
|
||||||
|
|
||||||
|
|
||||||
def test_recognised_fields_in_a_mixed_record_are_kept():
|
|
||||||
"""Dropping the record wholesale would lose real history unnecessarily."""
|
|
||||||
mixed = dict(HEALTH_SHAPED, call_count=7, memory_mb=12.5)
|
|
||||||
metrics = _monitor(mixed).get_metrics("plugin-b")
|
|
||||||
assert metrics.call_count == 7
|
|
||||||
assert metrics.memory_mb == 12.5
|
|
||||||
|
|
||||||
|
|
||||||
def test_a_clean_record_still_loads_unchanged():
|
|
||||||
clean = {f.name: 3 for f in fields(ResourceMetrics)}
|
|
||||||
metrics = _monitor(clean).get_metrics("plugin-c")
|
|
||||||
for name in (f.name for f in fields(ResourceMetrics)):
|
|
||||||
assert getattr(metrics, name) == 3
|
|
||||||
|
|
||||||
|
|
||||||
def test_unknown_fields_are_named_in_the_log(caplog):
|
|
||||||
"""Silently discarding them would hide a real schema change."""
|
|
||||||
with caplog.at_level(logging.WARNING):
|
|
||||||
_monitor(HEALTH_SHAPED).get_metrics("plugin-d")
|
|
||||||
# getMessage(), not .message: the latter is only populated once a handler
|
|
||||||
# formats the record, so the obvious spelling silently never matches.
|
|
||||||
assert any("consecutive_failures" in r.getMessage() for r in caplog.records), \
|
|
||||||
caplog.text
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("payload", ["a string", 42, ["a", "list"]])
|
|
||||||
def test_a_non_mapping_cache_entry_does_not_raise(payload):
|
|
||||||
metrics = _monitor(payload).get_metrics("plugin-e")
|
|
||||||
assert isinstance(metrics, ResourceMetrics)
|
|
||||||
|
|
||||||
|
|
||||||
def test_values_of_the_wrong_type_do_not_raise():
|
|
||||||
"""A dataclass will accept these, but a later float() on them would not."""
|
|
||||||
metrics = _monitor({"call_count": "not a number"}).get_metrics("plugin-f")
|
|
||||||
assert isinstance(metrics, ResourceMetrics)
|
|
||||||
@@ -0,0 +1,95 @@
|
|||||||
|
"""The display unit must cap glibc's malloc arenas.
|
||||||
|
|
||||||
|
glibc hands each allocating thread its own malloc arena, up to 8 x CPU count,
|
||||||
|
and an arena that has grown is never returned to the OS. This process runs
|
||||||
|
threads for the render loop, the update workers and the background fetchers, so
|
||||||
|
on a 3-core Pi the ceiling is 24 arenas.
|
||||||
|
|
||||||
|
Measured on a live rig, 2.5 hours in:
|
||||||
|
|
||||||
|
RSS 1030 MB
|
||||||
|
Private_Dirty 988 MB
|
||||||
|
anonymous mappings > 10 MB 23 (ceiling is 8 x 3 = 24)
|
||||||
|
largest few 104, 79, 66, 63, 63 MB, on 64 MB-aligned addresses
|
||||||
|
|
||||||
|
against live data that accounts for perhaps 15 MB -- the widest scroll strip
|
||||||
|
observed was 35,746 x 64, about 7 MB as RGB and the same again for its numpy
|
||||||
|
mirror. Repeated sampling showed RSS flat between 990 and 1030 MB rather than
|
||||||
|
climbing, so this is arena bloat rather than a leak: memory Python has freed
|
||||||
|
but glibc is holding per-arena.
|
||||||
|
|
||||||
|
The device had 59 MB free at the time.
|
||||||
|
|
||||||
|
Capping the arena count trades a little allocator concurrency for that resident
|
||||||
|
memory. The render loop is latency-sensitive, so if p99 frame time regresses the
|
||||||
|
right response is to raise this rather than remove it.
|
||||||
|
"""
|
||||||
|
import re
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
UNIT = (Path(__file__).resolve().parent.parent / "systemd" / "ledmatrix.service")
|
||||||
|
|
||||||
|
#: The value the unit is expected to carry. 2 is the usual choice for a
|
||||||
|
#: threaded Python process; 1-4 all keep some of the saving, but only one of
|
||||||
|
#: them is what this project ships.
|
||||||
|
EXPECTED_ARENA_MAX = 2
|
||||||
|
|
||||||
|
|
||||||
|
def _environment(unit_text):
|
||||||
|
return dict(
|
||||||
|
line.split("=", 2)[1:3] if line.count("=") >= 2 else (line.split("=", 1)[1], "")
|
||||||
|
for line in unit_text.splitlines()
|
||||||
|
if line.startswith("Environment=")
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_the_unit_exists():
|
||||||
|
assert UNIT.is_file(), f"{UNIT} is missing"
|
||||||
|
|
||||||
|
|
||||||
|
def test_malloc_arena_max_is_capped():
|
||||||
|
env = _environment(UNIT.read_text(encoding="utf-8"))
|
||||||
|
assert "MALLOC_ARENA_MAX" in env, (
|
||||||
|
"the display unit does not cap glibc arenas; on a 3-core Pi the default "
|
||||||
|
"ceiling is 24 and a measured rig held 23 of them, 920 MB"
|
||||||
|
)
|
||||||
|
value = int(env["MALLOC_ARENA_MAX"])
|
||||||
|
# Pinned, not a range. A range let a change to 4 -- which hands most of the
|
||||||
|
# saving back -- pass unnoticed, which was the point of the finding that
|
||||||
|
# prompted this. Raising it is a legitimate response to a frame-time
|
||||||
|
# regression, but it should be a visible edit here rather than a silent
|
||||||
|
# drift, so the number lives in one place and changing it shows up in
|
||||||
|
# review.
|
||||||
|
assert value == EXPECTED_ARENA_MAX, (
|
||||||
|
f"MALLOC_ARENA_MAX={value}, expected {EXPECTED_ARENA_MAX}. If this was "
|
||||||
|
"raised deliberately because frame times regressed, update "
|
||||||
|
"EXPECTED_ARENA_MAX here and say so in the commit."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_the_reason_is_recorded_next_to_it():
|
||||||
|
"""A bare tuning knob invites removal by whoever meets it next."""
|
||||||
|
text = UNIT.read_text(encoding="utf-8")
|
||||||
|
index = text.index("Environment=MALLOC_ARENA_MAX")
|
||||||
|
preamble = text[:index].splitlines()[-12:]
|
||||||
|
comment = "\n".join(line for line in preamble if line.startswith("#"))
|
||||||
|
assert "arena" in comment.lower(), "no explanation precedes the setting"
|
||||||
|
assert re.search(r"\d", comment), (
|
||||||
|
"the explanation cites no measurement, so a reader cannot tell whether "
|
||||||
|
"it still applies to their hardware"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("unit", ["ledmatrix.service"])
|
||||||
|
def test_the_unit_still_parses_as_ini(unit):
|
||||||
|
"""systemd will refuse a malformed unit, and the panel stays dark."""
|
||||||
|
import configparser
|
||||||
|
|
||||||
|
path = UNIT.parent / unit
|
||||||
|
parser = configparser.ConfigParser(strict=False)
|
||||||
|
# systemd allows repeated keys; ConfigParser needs them merged, not rejected.
|
||||||
|
parser.read_string(path.read_text(encoding="utf-8"))
|
||||||
|
assert parser.has_section("Service")
|
||||||
|
assert parser.has_option("Service", "ExecStart")
|
||||||
Reference in New Issue
Block a user