tracer-cloud--opensre/core/agent_harness/grounding/diagnostics.py

"""Verbose diagnostics for interactive-shell grounding caches."""

from __future__ import annotations

import logging
import os
from collections.abc import Callable, Iterable
from dataclasses import dataclass

from core.agent_harness.grounding.models import CacheStats

_logger = logging.getLogger(__name__)


@dataclass
class GroundingSource:
    """A single grounding cache source exposing typed stats for diagnostics."""

    name: str
    stats_fn: Callable[[], CacheStats]


def log_grounding_cache_diagnostics(sources: Iterable[GroundingSource], reason: str) -> None:
    """Log the provided grounding cache stats when ``TRACER_VERBOSE=1``."""
    if os.environ.get("TRACER_VERBOSE") != "1":
        return
    for source in sources:
        stats = source.stats_fn()
        _logger.debug("grounding cache [%s] %s=%s", reason, source.name, stats)


__all__ = [
    "GroundingSource",
    "log_grounding_cache_diagnostics",
]