mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description Persist bounded, aggregate-only Lifetime dashboard metrics across proxy restarts and expose them through a new `/stats-lifetime` endpoint. The change keeps session/runtime stats separate from durable lifetime stats, gates sensitive dashboard metadata for loopback or explicitly trusted dashboard clients, and updates the dashboard Lifetime view to consume the new endpoint. Closes #2137 ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [x] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Performance improvement - [x] Code refactoring (no functional changes) ## Changes Made - Added bounded persistent lifetime metrics state and wired proxy metric events into it. - Added `/stats-lifetime` with sensitive project/persistence details gated behind dashboard metadata access checks. - Extended loopback/dashboard metadata access policy for trusted dashboard client CIDRs without widening admin/debug endpoints. - Reorganized dashboard session/lifetime presentation around runtime counters versus durable aggregates. - Added focused tests for persistent aggregation, persistence, endpoint registration, loopback gating, trusted dashboard CIDRs, and recent request ordering. - Fixed current Ruff/mypy issues in the lifetime metrics normalization code. ## Testing - [x] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check`) - [x] Type checking passes (`mypy`) - [x] New tests added for new functionality - [x] Manual testing performed ### Test Output ```text uv run --extra proxy --with pytest --with pytest-asyncio pytest tests/test_persistent_metrics.py tests/test_persistent_metrics_integration.py tests/test_persistent_metrics_persistence.py tests/test_proxy_loopback_gating.py tests/test_proxy_stats_recent_requests.py -q 53 passed, 1 warning uvx ruff==0.15.17 check headroom/proxy/forwarded_headers.py headroom/proxy/loopback_guard.py headroom/proxy/persistent_metrics.py headroom/proxy/savings_tracker.py headroom/proxy/server.py tests/test_forwarded_headers.py tests/test_persistent_metrics.py tests/test_persistent_metrics_integration.py tests/test_persistent_metrics_persistence.py tests/test_proxy_loopback_gating.py tests/test_proxy_project_savings.py tests/test_proxy_stats_recent_requests.py All checks passed! uv run --extra proxy --with mypy mypy headroom/proxy/persistent_metrics.py Success: no issues found in 1 source file ``` ## Real Behavior Proof - Environment: Windows review worktree, Python 3.13.3 via uv. - Exact command / steps: Ran the focused persistent metrics, persistence, loopback gating, and recent request tests; ran CI-matching Ruff on touched files; ran mypy on the new persistent metrics module. - Observed result: `/stats-lifetime` is registered, non-loopback callers receive only non-sensitive aggregate data, loopback/trusted dashboard clients receive the full lifetime payload, admin/debug endpoints remain loopback-only, and persistent metrics normalize malformed stored state without type/lint errors. - Not tested: Full repository pytest suite, full dashboard browser screenshot pass, or live long-running proxy traffic. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] I have updated the CHANGELOG.md if applicable ## Screenshots (if applicable) N/A ## Additional Notes No changelog entry is required for this dashboard/internal metrics iteration. The endpoint intentionally exposes only aggregate lifetime data to ordinary network callers and strips project/persistence details unless the caller passes the dashboard metadata access policy. --------- Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
245 lines
8 KiB
Python
245 lines
8 KiB
Python
from __future__ import annotations
|
|
|
|
import pytest
|
|
from fastapi.testclient import TestClient
|
|
|
|
from headroom.proxy import server
|
|
from headroom.proxy.models import ProxyConfig
|
|
from headroom.proxy.server import create_app
|
|
|
|
|
|
class FakeRequestLogger:
|
|
def __init__(self) -> None:
|
|
self._logs: list[dict[str, object]] = []
|
|
|
|
@property
|
|
def logs(self) -> list[dict[str, object]]:
|
|
return self._logs
|
|
|
|
@logs.setter
|
|
def logs(self, value: list[dict[str, object]]) -> None:
|
|
self._logs = value
|
|
|
|
def get_recent(self, limit: int) -> list[dict[str, object]]:
|
|
return self._logs[-limit:]
|
|
|
|
|
|
class FakeLogEntry(dict[str, object]):
|
|
def __getattr__(self, name: str) -> object:
|
|
return self.get(name)
|
|
|
|
|
|
def test_stats_refreshes_recent_requests_when_cached() -> None:
|
|
app = create_app(
|
|
ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
log_requests=False,
|
|
ccr_inject_tool=False,
|
|
ccr_handle_responses=False,
|
|
ccr_context_tracking=False,
|
|
http2=False,
|
|
)
|
|
)
|
|
logger = FakeRequestLogger()
|
|
app.state.proxy.logger = logger
|
|
|
|
first_log = FakeLogEntry(
|
|
{
|
|
"timestamp": "2026-06-11T10:00:00Z",
|
|
"provider": "openai",
|
|
"model": "gpt-4.1",
|
|
"input_tokens_original": 100,
|
|
"input_tokens_optimized": 60,
|
|
"tokens_saved": 40,
|
|
"savings_percent": 40.0,
|
|
}
|
|
)
|
|
second_log = FakeLogEntry(
|
|
{
|
|
"timestamp": "2026-06-11T10:01:00Z",
|
|
"provider": "anthropic",
|
|
"model": "claude-sonnet",
|
|
"input_tokens_original": 200,
|
|
"input_tokens_optimized": 120,
|
|
"tokens_saved": 80,
|
|
"savings_percent": 40.0,
|
|
}
|
|
)
|
|
|
|
# Loopback client/Host: recent_requests is served only to loopback callers.
|
|
with TestClient(app, base_url="http://127.0.0.1", client=("127.0.0.1", 12345)) as client:
|
|
logger.logs = [first_log]
|
|
first_response = client.get("/stats?cached=1")
|
|
assert first_response.status_code == 200
|
|
assert first_response.json()["recent_requests"][-1]["model"] == "gpt-4.1"
|
|
|
|
logger.logs = [first_log, second_log]
|
|
second_response = client.get("/stats?cached=1")
|
|
assert second_response.status_code == 200
|
|
second_payload = second_response.json()
|
|
|
|
assert second_payload["recent_requests"][0]["model"] == "claude-sonnet"
|
|
assert second_payload["request_logs"][-1]["model"] == "claude-sonnet"
|
|
|
|
|
|
def test_stats_recent_requests_includes_token_incomplete_requests() -> None:
|
|
app = create_app(
|
|
ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
log_requests=False,
|
|
ccr_inject_tool=False,
|
|
ccr_handle_responses=False,
|
|
ccr_context_tracking=False,
|
|
http2=False,
|
|
)
|
|
)
|
|
logger = FakeRequestLogger()
|
|
app.state.proxy.logger = logger
|
|
|
|
logger.logs = [
|
|
FakeLogEntry(
|
|
{
|
|
"request_id": "req-haiku-1",
|
|
"timestamp": "2026-07-09T10:00:00Z",
|
|
"provider": "anthropic",
|
|
"model": "claude-haiku",
|
|
"transforms_applied": [],
|
|
}
|
|
),
|
|
FakeLogEntry(
|
|
{
|
|
"request_id": "req-haiku-2",
|
|
"timestamp": "2026-07-09T10:01:00Z",
|
|
"provider": "anthropic",
|
|
"model": "claude-haiku",
|
|
"input_tokens_original": None,
|
|
"input_tokens_optimized": None,
|
|
"output_tokens": None,
|
|
"tokens_saved": 0,
|
|
"savings_percent": 0.0,
|
|
"transforms_applied": [],
|
|
}
|
|
),
|
|
FakeLogEntry(
|
|
{
|
|
"request_id": "req-sonnet-1",
|
|
"timestamp": "2026-07-09T10:02:00Z",
|
|
"provider": "anthropic",
|
|
"model": "claude-sonnet",
|
|
"input_tokens_original": 200,
|
|
"input_tokens_optimized": 120,
|
|
"output_tokens": 40,
|
|
"tokens_saved": 80,
|
|
"savings_percent": 40.0,
|
|
"transforms_applied": ["smart_crusher"],
|
|
}
|
|
),
|
|
]
|
|
|
|
with TestClient(app, base_url="http://127.0.0.1", client=("127.0.0.1", 12345)) as client:
|
|
response = client.get("/stats")
|
|
|
|
assert response.status_code == 200
|
|
payload = response.json()
|
|
assert [req["model"] for req in payload["recent_requests"]] == [
|
|
"claude-sonnet",
|
|
"claude-haiku",
|
|
"claude-haiku",
|
|
]
|
|
assert payload["recent_requests"][0]["token_accounting_status"] == "complete"
|
|
assert payload["recent_requests"][0]["has_exact_tokens"] is True
|
|
assert payload["recent_requests"][1]["output_tokens"] is None
|
|
assert payload["recent_requests"][1]["token_accounting_status"] == "partial"
|
|
assert payload["recent_requests"][1]["tokens_saved"] == 0
|
|
assert payload["recent_requests"][2]["input_tokens_optimized"] is None
|
|
assert payload["recent_requests"][2]["token_accounting_status"] == "missing"
|
|
assert payload["recent_requests"][2]["has_exact_tokens"] is False
|
|
assert payload["summary"]["uncompressed_requests"]["unknown_token_accounting"] == 2
|
|
assert payload["request_logs"][-1]["model"] == "claude-sonnet"
|
|
|
|
|
|
def test_agent_usage_totals_use_proxy_only_savings(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
monkeypatch.setenv("HEADROOM_REQUIRE_RUST_CORE", "false")
|
|
monkeypatch.setattr(
|
|
server,
|
|
"_get_context_tool_stats",
|
|
lambda: {
|
|
"tool": "rtk",
|
|
"label": "RTK",
|
|
"tokens_saved": 500,
|
|
"session": {},
|
|
"lifetime": {},
|
|
},
|
|
)
|
|
app = create_app(
|
|
ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
log_requests=False,
|
|
ccr_inject_tool=False,
|
|
ccr_handle_responses=False,
|
|
ccr_context_tracking=False,
|
|
http2=False,
|
|
)
|
|
)
|
|
logger = FakeRequestLogger()
|
|
app.state.proxy.logger = logger
|
|
|
|
logger.logs = [
|
|
FakeLogEntry(
|
|
{
|
|
"timestamp": "2026-06-11T10:00:00Z",
|
|
"provider": "openai",
|
|
"model": "gpt-5.2-codex",
|
|
"tags": {"client": "codex"},
|
|
"input_tokens_original": 1000,
|
|
"input_tokens_optimized": 900,
|
|
"output_tokens": 50,
|
|
"tokens_saved": 100,
|
|
"savings_percent": 10.0,
|
|
}
|
|
)
|
|
]
|
|
|
|
with TestClient(app) as client:
|
|
proxy = client.app.state.proxy
|
|
proxy.metrics.tokens_input_total = 900
|
|
proxy.metrics.tokens_saved_total = 100
|
|
proxy.metrics.tokens_output_total = 50
|
|
|
|
response = client.get("/stats")
|
|
|
|
assert response.status_code == 200
|
|
payload = response.json()
|
|
|
|
assert payload["tokens"]["saved"] == 600
|
|
assert payload["agent_usage"]["totals"]["before_tokens"] == 1000
|
|
assert payload["agent_usage"]["totals"]["tokens_saved"] == 100
|
|
assert payload["agent_usage"]["totals"]["savings_percent"] == 10.0
|
|
assert payload["agent_usage"]["agents"][0]["share_of_saved_percent"] == 100.0
|
|
|
|
|
|
def test_stats_preserves_default_smart_crusher_compaction_state() -> None:
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
)
|
|
# Loopback client/Host: the `config` block is served only to loopback callers.
|
|
client = TestClient(
|
|
create_app(config), base_url="http://127.0.0.1", client=("127.0.0.1", 12345)
|
|
)
|
|
|
|
response = client.get("/stats")
|
|
|
|
assert response.status_code == 200
|
|
assert response.json()["config"]["smart_crusher_with_compaction"] is None
|