Files
strix/strix/report/usage.py
T
Mads Hvelplund 962d4459d9 Add configurable token / cost usage limits (#576)
* fix: resolve pre-commit check failures

- Change RuntimeError to TypeError for type validation in report/writer.py
- Update pyupgrade to v3.21.2 for Python 3.14 compatibility

* feat(cli): add --max-budget-usd flag

Raises BudgetExceededError in ReportUsageHooks after each LLM call when
accumulated cost reaches the limit, with clean "stopped" status and
child-agent cancellation in non-interactive mode.

* test: add budget enforcement unit tests

7 tests covering no-budget, under-budget, at-limit, over-limit, error
message content, None report state, and exception hierarchy.
Also adds pytest/pytest-asyncio to dev deps and a mypy override for tests.

* fix(budget): validate positive budget and check the live cost ledger

Two hardening fixes for --max-budget-usd enforcement:

- Reject non-positive budgets. ReportUsageHooks now raises ValueError for
  max_budget_usd <= 0, and the CLI validates the flag via a custom argparse
  type so '--max-budget-usd 0' fails fast with a friendly message instead of
  silently killing the scan on the first model response.
- Read the live cost. The budget check now reads ReportState.get_total_llm_cost()
  (the live ledger) instead of the persisted run-record snapshot, so it stays
  accurate even when a usage save fails after a model call.

* fix(budget): stop the entire scan deterministically when the limit is hit

Previously a BudgetExceededError was handled per-agent: it was swallowed in
interactive mode (the loop kept waiting), a child's error escaped its detached
task as an unretrieved-exception warning, the parent was never released from
wait_for_message, and the stop was logged at ERROR with a traceback as if the
agent had failed.

Replace that with a single scan-wide signal on the coordinator:

- AgentCoordinator.trigger_budget_stop() sets a flag and wakes every parked
  agent; wait_for_message returns as soon as the flag is set.
- The run loops check coordinator.budget_stopped and raise to exit cleanly,
  marking themselves 'stopped'. The root's exception reaches run_strix_scan's
  handler, which cancels descendants and tears the scan down once; child
  exceptions are swallowed in their detached task.
- The budget stop is logged at INFO, not as a failure.

This is deterministic regardless of tree depth or which agent first sees the
limit, fixing the interactive/TUI hang where a deep agent's stop never reached
a parked root. Also re-raises BudgetExceededError explicitly in the stream
handler so it can't be mistaken for the LiteLLM 'after shutdown' race.

* fix(budget): treat a budget stop as a clean stop in the TUI

Add an explicit BudgetExceededError handler in the TUI scan thread so that, if
the error ever reaches it, the budget stop is logged as a graceful stop rather
than surfaced as a red scan error by the broad 'except Exception'. The runner
normally absorbs the error and returns cleanly, so this is defensive depth for
a money-spending feature.

* docs(cli): document --max-budget-usd behavior and limitations

Clarify that the budget is cumulative across all agents, checked after each
model response, that the scan stops cleanly (not as a failure), that the value
must be > 0, and that spend can slightly overshoot due to in-flight calls and
best-effort cost estimation.

* Apply suggestions from code review

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

---------

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
2026-06-22 11:17:08 -04:00

263 lines
8.1 KiB
Python

"""SDK-native LLM usage aggregation for scan reports."""
from __future__ import annotations
import logging
from typing import Any
from agents.usage import Usage, deserialize_usage, serialize_usage
logger = logging.getLogger(__name__)
class LLMUsageLedger:
"""Aggregate SDK ``Usage`` objects and attach best-effort cost estimates."""
def __init__(self) -> None:
self._total_usage = Usage()
self._agent_usage: dict[str, Usage] = {}
self._agent_metadata: dict[str, dict[str, str]] = {}
self._total_cost = 0.0
def record(
self,
*,
agent_id: str,
usage: Usage | None,
agent_name: str | None = None,
model: str | None = None,
) -> bool:
if usage is None or not _usage_has_activity(usage):
return False
normalized_agent_id = str(agent_id or "unknown")
self._total_usage.add(usage)
self._agent_usage.setdefault(normalized_agent_id, Usage()).add(usage)
metadata = self._agent_metadata.setdefault(normalized_agent_id, {})
if agent_name:
metadata["agent_name"] = agent_name
if model:
metadata["model"] = model
if not _is_litellm_routed(model):
estimated = _estimate_litellm_cost(usage, model)
if estimated:
self._total_cost += estimated
return True
def record_observed_cost(self, cost: float) -> None:
if isinstance(cost, int | float) and cost > 0:
self._total_cost += float(cost)
@property
def total_cost(self) -> float:
return _round_cost(self._total_cost)
def to_record(self) -> dict[str, Any]:
record = serialize_usage(self._total_usage)
record["cost"] = _round_cost(self._total_cost)
record["agents"] = []
agent_tokens = {aid: _resolve_total_tokens(u) for aid, u in self._agent_usage.items()}
total_tokens = sum(agent_tokens.values())
for agent_id in sorted(self._agent_usage):
usage = self._agent_usage[agent_id]
metadata = self._agent_metadata.get(agent_id, {})
agent_cost = (
self._total_cost * (agent_tokens[agent_id] / total_tokens) if total_tokens else 0.0
)
agent_record = serialize_usage(usage)
agent_record.update(
{
"agent_id": agent_id,
"agent_name": metadata.get("agent_name") or agent_id,
"model": metadata.get("model"),
"cost": _round_cost(agent_cost),
}
)
record["agents"].append(agent_record)
return record
def hydrate(self, raw_usage: Any) -> None:
self._total_usage = Usage()
self._agent_usage.clear()
self._agent_metadata.clear()
self._total_cost = 0.0
if not isinstance(raw_usage, dict):
return
try:
self._total_usage = deserialize_usage(raw_usage)
except Exception:
logger.exception("Failed to hydrate aggregate llm_usage from run.json")
self._total_usage = Usage()
self._total_cost = _float_or_zero(raw_usage.get("cost"))
for raw_agent in raw_usage.get("agents") or []:
if not isinstance(raw_agent, dict):
continue
agent_id = str(raw_agent.get("agent_id") or "").strip()
if not agent_id:
continue
try:
self._agent_usage[agent_id] = deserialize_usage(raw_agent)
except Exception:
logger.exception("Failed to hydrate llm_usage for agent %s", agent_id)
self._agent_usage[agent_id] = Usage()
metadata: dict[str, str] = {}
agent_name = raw_agent.get("agent_name")
model = raw_agent.get("model")
if isinstance(agent_name, str) and agent_name:
metadata["agent_name"] = agent_name
if isinstance(model, str) and model:
metadata["model"] = model
self._agent_metadata[agent_id] = metadata
def _resolve_total_tokens(usage: Usage) -> int:
total = max(0, int(usage.total_tokens or 0))
if total > 0:
return total
prompt = _int_or_zero(getattr(usage, "input_tokens", 0))
completion = _int_or_zero(getattr(usage, "output_tokens", 0))
return prompt + completion
def _is_litellm_routed(model: str | None) -> bool:
if not model:
return False
name = model.strip().lower()
if "/" not in name:
return False
return not name.startswith("openai/")
def _usage_has_activity(usage: Usage) -> bool:
return bool(
usage.requests
or usage.input_tokens
or usage.output_tokens
or usage.total_tokens
or usage.request_usage_entries
)
def _estimate_litellm_cost(usage: Usage, model: str | None) -> float | None:
litellm_model = _litellm_model_name(model)
if not litellm_model:
return None
entries = list(usage.request_usage_entries)
if not entries:
return _estimate_litellm_entry_cost(usage, litellm_model)
total = 0.0
estimated_any = False
for entry in entries:
cost = _estimate_litellm_entry_cost(entry, litellm_model)
if cost is None:
continue
total += cost
estimated_any = True
return total if estimated_any else None
def _estimate_litellm_entry_cost(entry: Any, model: str) -> float | None:
prompt_tokens = _int_or_zero(getattr(entry, "input_tokens", 0))
completion_tokens = _int_or_zero(getattr(entry, "output_tokens", 0))
total_tokens = _int_or_zero(getattr(entry, "total_tokens", 0))
if total_tokens <= 0:
total_tokens = prompt_tokens + completion_tokens
if total_tokens <= 0:
return None
usage_payload: dict[str, Any] = {
"prompt_tokens": prompt_tokens,
"completion_tokens": completion_tokens,
"total_tokens": total_tokens,
}
prompt_details = _details_to_dict(getattr(entry, "input_tokens_details", None))
completion_details = _details_to_dict(getattr(entry, "output_tokens_details", None))
if prompt_details:
usage_payload["prompt_tokens_details"] = prompt_details
if completion_details:
usage_payload["completion_tokens_details"] = completion_details
from litellm import completion_cost
candidates = [model]
if "/" in model:
candidates.append(model.split("/", 1)[-1])
cost: Any = None
for candidate in candidates:
try:
cost = completion_cost(
completion_response={"model": candidate, "usage": usage_payload},
model=model,
)
break
except Exception: # nosec B112 # noqa: BLE001, S112
continue
if cost is None:
logger.debug("LiteLLM cost estimate unavailable for model %s", model)
return None
return cost if isinstance(cost, int | float) and cost >= 0 else None
def _litellm_model_name(model: str | None) -> str | None:
if not model:
return None
normalized = model.strip()
for prefix in ("litellm/", "any-llm/", "openai/"):
if normalized.startswith(prefix):
normalized = normalized.removeprefix(prefix)
break
return normalized or None
def _details_to_dict(details: Any) -> dict[str, Any]:
if details is None:
return {}
if isinstance(details, list):
for item in details:
result = _details_to_dict(item)
if result:
return result
return {}
if hasattr(details, "model_dump"):
return _details_to_dict(details.model_dump())
if not isinstance(details, dict):
return {}
return {str(k): v for k, v in details.items() if v is not None}
def _int_or_zero(value: Any) -> int:
try:
return max(0, int(value or 0))
except (TypeError, ValueError):
return 0
def _float_or_zero(value: Any) -> float:
try:
result = float(value or 0.0)
except (TypeError, ValueError):
return 0.0
return result if result >= 0 else 0.0
def _round_cost(cost: float) -> float:
return round(max(0.0, cost), 10)