mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-20 18:09:05 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dab4b3ea57 | ||
|
|
0fd2bfae99 |
+3
-10
@@ -1419,16 +1419,9 @@ $ACTUAL_USER ALL=(ALL) NOPASSWD: $BASH_PATH $PROJECT_ROOT_DIR/scripts/fix_perms/
|
|||||||
EOF
|
EOF
|
||||||
if [ -n "$JOURNALCTL_PATH" ]; then
|
if [ -n "$JOURNALCTL_PATH" ]; then
|
||||||
cat >> /tmp/ledmatrix_web_sudoers << EOF
|
cat >> /tmp/ledmatrix_web_sudoers << EOF
|
||||||
# NOEXEC, because these rules end in a wildcard and journalctl starts a pager
|
$ACTUAL_USER ALL=(ALL) NOPASSWD: $JOURNALCTL_PATH -u ledmatrix.service *
|
||||||
# when its output is a terminal. From that pager (less) a "!sh" is a root
|
$ACTUAL_USER ALL=(ALL) NOPASSWD: $JOURNALCTL_PATH -u ledmatrix *
|
||||||
# shell -- the standard journalctl escalation. The web interface always passes
|
$ACTUAL_USER ALL=(ALL) NOPASSWD: $JOURNALCTL_PATH -t ledmatrix *
|
||||||
# --no-pager, so nothing here needs it, but the rule cannot require a flag that
|
|
||||||
# sits in the middle of the command line. NOEXEC stops the command executing
|
|
||||||
# another program at all, which closes the hole without depending on wildcard
|
|
||||||
# matching subtleties.
|
|
||||||
$ACTUAL_USER ALL=(ALL) NOPASSWD:NOEXEC: $JOURNALCTL_PATH -u ledmatrix.service *
|
|
||||||
$ACTUAL_USER ALL=(ALL) NOPASSWD:NOEXEC: $JOURNALCTL_PATH -u ledmatrix *
|
|
||||||
$ACTUAL_USER ALL=(ALL) NOPASSWD:NOEXEC: $JOURNALCTL_PATH -t ledmatrix *
|
|
||||||
EOF
|
EOF
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|||||||
@@ -49,6 +49,20 @@ class ResourceMetrics:
|
|||||||
self.total_execution_time = self.total_execution_time / self.call_count
|
self.total_execution_time = self.total_execution_time / self.call_count
|
||||||
|
|
||||||
|
|
||||||
|
#: How often a plugin's metrics are written to the cache, in seconds.
|
||||||
|
#:
|
||||||
|
#: Persisting on every call meant a small file rewritten roughly nine times a
|
||||||
|
#: minute per plugin. On a rig with fourteen active plugins that was ~126
|
||||||
|
#: writes a minute for metrics alone, and since each ~350-byte file costs a
|
||||||
|
#: 4KB block plus an ext4 journal entry, it dominated the device's write
|
||||||
|
#: volume -- on an SD card, which wears out.
|
||||||
|
#:
|
||||||
|
#: The in-memory copy stays authoritative and exact; only the cross-process
|
||||||
|
#: snapshot the web UI reads is delayed, and telemetry up to half a minute old
|
||||||
|
#: is still a fair description of a long-running plugin.
|
||||||
|
_METRICS_PERSIST_INTERVAL = 30.0
|
||||||
|
|
||||||
|
|
||||||
class PluginResourceMonitor:
|
class PluginResourceMonitor:
|
||||||
"""
|
"""
|
||||||
Monitors resource usage for plugins.
|
Monitors resource usage for plugins.
|
||||||
@@ -75,6 +89,10 @@ class PluginResourceMonitor:
|
|||||||
# Resource metrics per plugin
|
# Resource metrics per plugin
|
||||||
self._metrics: Dict[str, ResourceMetrics] = {}
|
self._metrics: Dict[str, ResourceMetrics] = {}
|
||||||
self._limits: Dict[str, ResourceLimits] = {}
|
self._limits: Dict[str, ResourceLimits] = {}
|
||||||
|
# When each plugin's metrics last reached the cache. Metrics change on
|
||||||
|
# every call, so they cannot be de-duplicated the way health state can;
|
||||||
|
# they are rate-limited instead. See _METRICS_PERSIST_INTERVAL.
|
||||||
|
self._metrics_persisted_at: Dict[str, float] = {}
|
||||||
|
|
||||||
# Thread-local storage for execution tracking
|
# Thread-local storage for execution tracking
|
||||||
self._local = threading.local()
|
self._local = threading.local()
|
||||||
@@ -232,18 +250,8 @@ class PluginResourceMonitor:
|
|||||||
# CPU is harder to measure per-call, so we track it separately
|
# CPU is harder to measure per-call, so we track it separately
|
||||||
metrics.cpu_percent = self._get_process_cpu_percent()
|
metrics.cpu_percent = self._get_process_cpu_percent()
|
||||||
|
|
||||||
# Persist metrics
|
# Persist metrics, at most once per interval per plugin.
|
||||||
cache_key = self._get_metrics_key(plugin_id)
|
self._persist_metrics(plugin_id, metrics)
|
||||||
self.cache_manager.set(cache_key, {
|
|
||||||
'memory_mb': metrics.memory_mb,
|
|
||||||
'cpu_percent': metrics.cpu_percent,
|
|
||||||
'execution_time': metrics.execution_time,
|
|
||||||
'call_count': metrics.call_count,
|
|
||||||
'total_execution_time': metrics.total_execution_time,
|
|
||||||
'max_execution_time': metrics.max_execution_time,
|
|
||||||
'min_execution_time': metrics.min_execution_time if metrics.min_execution_time != float('inf') else 0.0,
|
|
||||||
'last_update_time': metrics.last_update_time
|
|
||||||
})
|
|
||||||
|
|
||||||
# Check limits
|
# Check limits
|
||||||
if limits:
|
if limits:
|
||||||
@@ -363,6 +371,37 @@ class PluginResourceMonitor:
|
|||||||
summaries[plugin_id] = self.get_metrics_summary(plugin_id)
|
summaries[plugin_id] = self.get_metrics_summary(plugin_id)
|
||||||
return summaries
|
return summaries
|
||||||
|
|
||||||
|
def _persist_metrics(self, plugin_id: str, metrics: ResourceMetrics,
|
||||||
|
force: bool = False) -> None:
|
||||||
|
"""Write a plugin's metrics to the cache, at most once per interval.
|
||||||
|
|
||||||
|
Caller must hold ``self._lock``.
|
||||||
|
"""
|
||||||
|
# Monotonic, not wall clock: these devices have no RTC, so the clock
|
||||||
|
# jumps by however far off boot-time was the moment NTP first syncs.
|
||||||
|
# A forward jump would allow an early write, a backward one would
|
||||||
|
# stall the snapshot well past the interval.
|
||||||
|
now = time.monotonic()
|
||||||
|
if not force and now - self._metrics_persisted_at.get(plugin_id, 0.0) \
|
||||||
|
< _METRICS_PERSIST_INTERVAL:
|
||||||
|
return
|
||||||
|
cache_key = self._get_metrics_key(plugin_id)
|
||||||
|
self.cache_manager.set(cache_key, {
|
||||||
|
'memory_mb': metrics.memory_mb,
|
||||||
|
'cpu_percent': metrics.cpu_percent,
|
||||||
|
'execution_time': metrics.execution_time,
|
||||||
|
'call_count': metrics.call_count,
|
||||||
|
'total_execution_time': metrics.total_execution_time,
|
||||||
|
'max_execution_time': metrics.max_execution_time,
|
||||||
|
'min_execution_time': (metrics.min_execution_time
|
||||||
|
if metrics.min_execution_time != float('inf')
|
||||||
|
else 0.0),
|
||||||
|
'last_update_time': metrics.last_update_time,
|
||||||
|
})
|
||||||
|
# Only after the write lands. Marking it first would mean a failed
|
||||||
|
# set() bought the next interval's silence without leaving a snapshot.
|
||||||
|
self._metrics_persisted_at[plugin_id] = now
|
||||||
|
|
||||||
def reset_metrics(self, plugin_id: str) -> None:
|
def reset_metrics(self, plugin_id: str) -> None:
|
||||||
"""Reset metrics for a plugin."""
|
"""Reset metrics for a plugin."""
|
||||||
with self._lock:
|
with self._lock:
|
||||||
@@ -370,4 +409,7 @@ class PluginResourceMonitor:
|
|||||||
self._metrics[plugin_id] = ResourceMetrics()
|
self._metrics[plugin_id] = ResourceMetrics()
|
||||||
cache_key = self._get_metrics_key(plugin_id)
|
cache_key = self._get_metrics_key(plugin_id)
|
||||||
self.cache_manager.delete(cache_key)
|
self.cache_manager.delete(cache_key)
|
||||||
|
# Let the next call persist immediately rather than leaving the
|
||||||
|
# deleted key absent for the rest of the interval.
|
||||||
|
self._metrics_persisted_at.pop(plugin_id, None)
|
||||||
|
|
||||||
|
|||||||
@@ -127,3 +127,67 @@ class TestForceReload:
|
|||||||
fresh = mon.get_metrics_summary("p", force_reload=True)
|
fresh = mon.get_metrics_summary("p", force_reload=True)
|
||||||
assert fresh["call_count"] == 7
|
assert fresh["call_count"] == 7
|
||||||
assert any(c.kwargs.get("memory_ttl") == 0 for c in cache.get.call_args_list)
|
assert any(c.kwargs.get("memory_ttl") == 0 for c in cache.get.call_args_list)
|
||||||
|
|
||||||
|
|
||||||
|
class TestMetricsPersistenceChurn:
|
||||||
|
"""Metrics are telemetry; writing them on every call wore the SD card.
|
||||||
|
|
||||||
|
Each write is a ~350-byte file, which on ext4 costs a 4KB block plus a
|
||||||
|
journal entry. At roughly nine calls a minute per plugin across fourteen
|
||||||
|
plugins it dominated the device's write volume.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def test_repeated_calls_persist_once_per_interval(self):
|
||||||
|
cache = _cache()
|
||||||
|
mon = PluginResourceMonitor(cache, enable_monitoring=False)
|
||||||
|
for _ in range(50):
|
||||||
|
mon.monitor_call("p", lambda: None)
|
||||||
|
writes = [c for c in cache.set.call_args_list
|
||||||
|
if c.args and str(c.args[0]).startswith("plugin_metrics:")]
|
||||||
|
assert len(writes) == 1, (
|
||||||
|
f"50 calls produced {len(writes)} metric writes; expected 1")
|
||||||
|
|
||||||
|
def test_the_interval_elapsing_allows_the_next_write(self, monkeypatch):
|
||||||
|
import src.plugin_system.resource_monitor as rm
|
||||||
|
cache = _cache()
|
||||||
|
mon = PluginResourceMonitor(cache, enable_monitoring=False)
|
||||||
|
mon.monitor_call("p", lambda: None)
|
||||||
|
# pretend the interval has passed
|
||||||
|
mon._metrics_persisted_at["p"] -= rm._METRICS_PERSIST_INTERVAL + 1
|
||||||
|
mon.monitor_call("p", lambda: None)
|
||||||
|
writes = [c for c in cache.set.call_args_list
|
||||||
|
if c.args and str(c.args[0]).startswith("plugin_metrics:")]
|
||||||
|
assert len(writes) == 2
|
||||||
|
|
||||||
|
def test_in_memory_metrics_stay_exact_while_writes_are_skipped(self):
|
||||||
|
mon = PluginResourceMonitor(_cache(), enable_monitoring=False)
|
||||||
|
for _ in range(20):
|
||||||
|
mon.monitor_call("p", lambda: None)
|
||||||
|
assert mon.get_metrics("p").call_count == 20
|
||||||
|
|
||||||
|
def test_reset_lets_the_next_call_persist_immediately(self):
|
||||||
|
cache = _cache()
|
||||||
|
mon = PluginResourceMonitor(cache, enable_monitoring=False)
|
||||||
|
mon.monitor_call("p", lambda: None)
|
||||||
|
mon.reset_metrics("p")
|
||||||
|
mon.monitor_call("p", lambda: None)
|
||||||
|
writes = [c for c in cache.set.call_args_list
|
||||||
|
if c.args and str(c.args[0]).startswith("plugin_metrics:")]
|
||||||
|
assert len(writes) == 2, "reset should clear the throttle timestamp"
|
||||||
|
|
||||||
|
def test_a_failed_write_does_not_buy_the_next_interval_of_silence(self):
|
||||||
|
"""A set() that raises must not count as having persisted.
|
||||||
|
|
||||||
|
Marking the timestamp before the write would leave no snapshot in the
|
||||||
|
cache and still suppress the next 30 seconds of attempts.
|
||||||
|
"""
|
||||||
|
cache = _cache()
|
||||||
|
cache.set.side_effect = [OSError("disk full"), None]
|
||||||
|
mon = PluginResourceMonitor(cache, enable_monitoring=False)
|
||||||
|
with pytest.raises(OSError):
|
||||||
|
mon.monitor_call("p", lambda: None)
|
||||||
|
# the very next call must try again rather than skip the interval
|
||||||
|
mon.monitor_call("p", lambda: None)
|
||||||
|
writes = [c for c in cache.set.call_args_list
|
||||||
|
if c.args and str(c.args[0]).startswith("plugin_metrics:")]
|
||||||
|
assert len(writes) == 2, "a failed write should be retried, not skipped"
|
||||||
|
|||||||
@@ -1,87 +0,0 @@
|
|||||||
"""Wildcard grants to commands that start a pager must carry NOEXEC.
|
|
||||||
|
|
||||||
`journalctl` runs a pager when its output is a terminal, and from `less` a
|
|
||||||
`!sh` is a shell with the privileges journalctl was given. That is the standard
|
|
||||||
journalctl privilege escalation, and the installer's rules end in a wildcard:
|
|
||||||
|
|
||||||
<user> ALL=(ALL) NOPASSWD: /usr/bin/journalctl -u ledmatrix *
|
|
||||||
|
|
||||||
The web interface always passes --no-pager -- both call sites do, in app.py and
|
|
||||||
api_v3.py -- so nothing the project runs needs the pager. But a sudoers rule
|
|
||||||
cannot require a flag that sits in the middle of the command line, and reasoning
|
|
||||||
about what a trailing `*` does or does not admit is exactly the kind of
|
|
||||||
subtlety that produces a hole.
|
|
||||||
|
|
||||||
sudo's NOEXEC tag stops the command executing another program at all, which
|
|
||||||
closes it without depending on that reasoning. It works by LD_PRELOAD, so it
|
|
||||||
applies to dynamically linked binaries; journalctl is one.
|
|
||||||
|
|
||||||
On a stock Raspberry Pi image none of this is reachable, because
|
|
||||||
/etc/sudoers.d/010_pi-nopasswd already grants the default user
|
|
||||||
`ALL=(ALL) NOPASSWD: ALL`. It matters on a hardened install, or where the
|
|
||||||
service runs as a user without that blanket rule.
|
|
||||||
"""
|
|
||||||
import re
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
ROOT = Path(__file__).resolve().parent.parent
|
|
||||||
INSTALLERS = (
|
|
||||||
ROOT / "first_time_install.sh",
|
|
||||||
ROOT / "scripts" / "install" / "configure_wifi_permissions.sh",
|
|
||||||
)
|
|
||||||
|
|
||||||
#: Commands that will start another program of their own accord -- a pager, an
|
|
||||||
#: editor, a shell -- and so must not be granted the ability to do so.
|
|
||||||
SPAWNS_A_PROGRAM = ("journalctl", "systemctl", "less", "more", "man", "git")
|
|
||||||
|
|
||||||
|
|
||||||
def _grant_lines():
|
|
||||||
lines = []
|
|
||||||
for installer in INSTALLERS:
|
|
||||||
if not installer.is_file():
|
|
||||||
continue
|
|
||||||
for line in installer.read_text(encoding="utf-8", errors="replace").splitlines():
|
|
||||||
stripped = line.strip()
|
|
||||||
if "NOPASSWD" in stripped and not stripped.startswith("#"):
|
|
||||||
lines.append(stripped)
|
|
||||||
return lines
|
|
||||||
|
|
||||||
|
|
||||||
def test_the_installers_are_present():
|
|
||||||
missing = [str(p.relative_to(ROOT)) for p in INSTALLERS if not p.is_file()]
|
|
||||||
assert not missing, f"installer(s) missing: {missing}"
|
|
||||||
|
|
||||||
|
|
||||||
def test_wildcard_pager_grants_carry_noexec():
|
|
||||||
offenders = []
|
|
||||||
for rule in _grant_lines():
|
|
||||||
command = rule.split("NOPASSWD", 1)[1]
|
|
||||||
if not command.rstrip().endswith("*"):
|
|
||||||
continue
|
|
||||||
tool = command.replace("_PATH", "").replace("$", "").lower()
|
|
||||||
for name in SPAWNS_A_PROGRAM:
|
|
||||||
if re.search(rf"(^|/|\s){name}(\s|$)", tool):
|
|
||||||
if "NOEXEC" not in rule:
|
|
||||||
offenders.append(rule)
|
|
||||||
break
|
|
||||||
assert not offenders, (
|
|
||||||
"wildcard grant to a command that can start a pager or shell, without "
|
|
||||||
"NOEXEC:\n " + "\n ".join(offenders))
|
|
||||||
|
|
||||||
|
|
||||||
def test_journalctl_is_granted_at_all():
|
|
||||||
"""Guard against 'fixing' the above by deleting the rules."""
|
|
||||||
text = "\n".join(_grant_lines())
|
|
||||||
assert "JOURNALCTL_PATH" in text or "journalctl" in text, (
|
|
||||||
"no journalctl grant remains; the web interface reads logs through it")
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("unit", ["ledmatrix.service", "ledmatrix"])
|
|
||||||
def test_each_journalctl_rule_is_tagged(unit):
|
|
||||||
matching = [r for r in _grant_lines()
|
|
||||||
if "JOURNALCTL_PATH" in r and f"-u {unit} " in r]
|
|
||||||
assert matching, f"no journalctl rule for -u {unit}"
|
|
||||||
untagged = [r for r in matching if "NOEXEC" not in r]
|
|
||||||
assert not untagged, f"untagged journalctl rule(s): {untagged}"
|
|
||||||
Reference in New Issue
Block a user