1263 lines
54 KiB
Python
1263 lines
54 KiB
Python
"""langfuse — Hermes plugin for Langfuse observability.
|
||
|
||
Traces Hermes conversations, LLM calls, and tool usage to Langfuse.
|
||
|
||
Activation is handled by the Hermes plugin system (``plugins.enabled``). At
|
||
runtime the plugin also requires the ``langfuse`` SDK and credentials; if
|
||
either is missing the hooks are inert.
|
||
|
||
Required env vars (set via ``hermes tools`` or ~/.hermes/.env):
|
||
HERMES_LANGFUSE_PUBLIC_KEY - Langfuse project public key (pk-lf-...)
|
||
HERMES_LANGFUSE_SECRET_KEY - Langfuse project secret key (sk-lf-...)
|
||
HERMES_LANGFUSE_BASE_URL - Langfuse server URL (default: https://cloud.langfuse.com)
|
||
|
||
Optional env vars:
|
||
HERMES_LANGFUSE_ENV - environment tag (e.g. "production", "local")
|
||
HERMES_LANGFUSE_RELEASE - release/version tag
|
||
HERMES_LANGFUSE_SAMPLE_RATE - sampling rate 0.0–1.0 (default: 1.0)
|
||
HERMES_LANGFUSE_MAX_CHARS - max chars per field (default: 12000)
|
||
HERMES_LANGFUSE_CAPTURE - content capture mode (default: "sanitized")
|
||
metadata - no content: sizes, roles, tool names, IDs, usage, cost only
|
||
sanitized - content with secret-pattern redaction + truncation
|
||
full - raw content (truncated only); explicit opt-in
|
||
HERMES_LANGFUSE_DEBUG - set to "true" for verbose logging
|
||
"""
|
||
from __future__ import annotations
|
||
|
||
import atexit
|
||
import json
|
||
import logging
|
||
import os
|
||
import re
|
||
import threading
|
||
import time
|
||
from dataclasses import dataclass, field
|
||
from typing import Any, Dict, Optional
|
||
|
||
logger = logging.getLogger(__name__)
|
||
|
||
try:
|
||
from langfuse import Langfuse, propagate_attributes
|
||
except Exception: # pragma: no cover - fail-open when optional dep is missing
|
||
Langfuse = None
|
||
propagate_attributes = None
|
||
|
||
|
||
@dataclass
|
||
class TraceState:
|
||
trace_id: str
|
||
root_ctx: Any
|
||
root_span: Any
|
||
generations: Dict[str, Any] = field(default_factory=dict)
|
||
tools: Dict[str, Any] = field(default_factory=dict)
|
||
pending_tools_by_name: Dict[str, list] = field(default_factory=dict)
|
||
turn_tool_calls: list[dict[str, Any]] = field(default_factory=list)
|
||
# Keyed by child_session_id: subagent_stop carries no child_subagent_id.
|
||
subagents: Dict[str, Any] = field(default_factory=dict)
|
||
# Fingerprints of MoA fan-outs already recorded: the client holds its last
|
||
# fan-out until the next one, so tool-loop turns would re-emit advisors.
|
||
moa_emitted: set = field(default_factory=set)
|
||
last_updated_at: float = field(default_factory=time.time)
|
||
|
||
|
||
_STATE_LOCK = threading.Lock()
|
||
_TRACE_STATE: Dict[str, TraceState] = {}
|
||
# Ceiling on live trace state, keyed per turn_id. Turns that never reach
|
||
# _finish_trace (interrupted / tool-only / empty final) would otherwise leak
|
||
# forever; over the cap the least-recently-updated entries are evicted. Far
|
||
# above any real concurrent working set — bounds the leak, not concurrency.
|
||
_MAX_TRACE_STATE = 256
|
||
_LANGFUSE_CLIENT = None
|
||
# Separate from _STATE_LOCK (hot path) so the two never nest; serializes the
|
||
# first client build so racing callers can't each construct a client.
|
||
_LANGFUSE_CLIENT_LOCK = threading.Lock()
|
||
_READ_FILE_LINE_RE = re.compile(r"^\s*(\d+)\|(.*)$")
|
||
_READ_FILE_HEAD_LINES = 25
|
||
_READ_FILE_TAIL_LINES = 15
|
||
|
||
# Langfuse-issued keys always carry these prefixes. Anything else is a leftover
|
||
# template value: the SDK accepts it at construction time but silently drops
|
||
# every trace at flush time (#23823).
|
||
_LANGFUSE_KEY_PREFIXES: Dict[str, str] = {
|
||
"HERMES_LANGFUSE_PUBLIC_KEY": "pk-lf-",
|
||
"HERMES_LANGFUSE_SECRET_KEY": "sk-lf-",
|
||
}
|
||
|
||
# (langfuse usage key, CanonicalUsage attribute / summary-dict key, PricingEntry attribute)
|
||
_USAGE_FIELDS = (
|
||
("input", "input_tokens", "input_cost_per_million"),
|
||
("output", "output_tokens", "output_cost_per_million"),
|
||
("cache_read_input_tokens", "cache_read_tokens", "cache_read_cost_per_million"),
|
||
("cache_creation_input_tokens", "cache_write_tokens", "cache_write_cost_per_million"),
|
||
("reasoning_tokens", "reasoning_tokens", None),
|
||
)
|
||
|
||
|
||
def _env(name: str, default: str = "") -> str:
|
||
return os.environ.get(name, default).strip()
|
||
|
||
|
||
def _debug(message: str) -> None:
|
||
if _env("HERMES_LANGFUSE_DEBUG").lower() in {"1", "true", "yes", "on"}:
|
||
logger.info("Langfuse tracing: %s", message)
|
||
|
||
|
||
# ---------------------------------------------------------------------------
|
||
# Capture modes
|
||
# ---------------------------------------------------------------------------
|
||
|
||
_CAPTURE_MODES = ("metadata", "sanitized", "full")
|
||
_DEFAULT_CAPTURE_MODE = "sanitized"
|
||
_warned_invalid_capture = False
|
||
|
||
|
||
def _capture_mode() -> str:
|
||
"""Resolve ``metadata | sanitized | full``.
|
||
|
||
Read per call so tests and long-lived processes can flip modes without a
|
||
client reset. Invalid values warn once and fall back to the default rather
|
||
than silently capturing more than the operator intended.
|
||
"""
|
||
global _warned_invalid_capture
|
||
value = _env("HERMES_LANGFUSE_CAPTURE").lower()
|
||
if not value:
|
||
return _DEFAULT_CAPTURE_MODE
|
||
if value in _CAPTURE_MODES:
|
||
return value
|
||
if not _warned_invalid_capture:
|
||
_warned_invalid_capture = True
|
||
logger.warning(
|
||
"Langfuse plugin: invalid HERMES_LANGFUSE_CAPTURE=%r, falling back "
|
||
"to %r (valid: %s)",
|
||
value, _DEFAULT_CAPTURE_MODE, ", ".join(_CAPTURE_MODES),
|
||
)
|
||
return _DEFAULT_CAPTURE_MODE
|
||
|
||
|
||
def _redact_secrets(value: str) -> str:
|
||
# force=True: redact even if the user disabled security.redact_secrets —
|
||
# this content is exported to an external service.
|
||
try:
|
||
from agent.redact import redact_sensitive_text
|
||
return redact_sensitive_text(value, force=True)
|
||
except Exception:
|
||
return value
|
||
|
||
|
||
def _describe_content(value: Any) -> Any:
|
||
"""Metadata-mode stand-in for content: shape and size, never payload."""
|
||
if value is None or isinstance(value, bool):
|
||
return value
|
||
if isinstance(value, (int, float)):
|
||
return {"omitted": True, "type": "number"}
|
||
if isinstance(value, bytes):
|
||
return {"omitted": True, "type": "bytes", "length": len(value)}
|
||
if isinstance(value, str):
|
||
return {"omitted": True, "type": "text", "chars": len(value)}
|
||
if isinstance(value, dict):
|
||
return {"omitted": True, "type": "object", "keys": [str(k) for k in list(value.keys())[:20]]}
|
||
if isinstance(value, (list, tuple, set)):
|
||
return {"omitted": True, "type": "array", "items": len(value)}
|
||
return {"omitted": True, "type": type(value).__name__}
|
||
|
||
|
||
def _capture_content(value: Any, *, parse_json_strings: bool = False,
|
||
tool_name: str = "", args: Any = None) -> Any:
|
||
"""Apply the active capture mode to a CONTENT value.
|
||
|
||
Only prompt/response text, tool arguments and tool results are content;
|
||
metadata fields (provider, model, IDs, counts) stay as-is in every mode.
|
||
"""
|
||
if _capture_mode() == "metadata":
|
||
return _describe_content(value)
|
||
if tool_name or args is not None:
|
||
value = _normalize_payload(value, tool_name=tool_name, args=args)
|
||
return _safe_value(value, parse_json_strings=parse_json_strings)
|
||
|
||
|
||
# Sentinel: "_get_langfuse() has tried and failed". Tests reset by reloading
|
||
# the module; runtime callers must restart the process after fixing credentials.
|
||
_INIT_FAILED = object()
|
||
|
||
|
||
def _validate_langfuse_key(env_name: str, value: str) -> Optional[str]:
|
||
"""Return a log-ready error if ``value`` lacks the documented prefix for ``env_name``.
|
||
|
||
The preview shows enough to spot placeholders (``placeholder``, ``test-key``)
|
||
without echoing a real secret pasted into the wrong env var.
|
||
"""
|
||
expected = _LANGFUSE_KEY_PREFIXES.get(env_name, "")
|
||
if not expected or value.startswith(expected):
|
||
return None
|
||
preview = "<empty>" if not value else repr(value) if len(value) <= 12 else repr(value[:6] + "...")
|
||
return f"{env_name}={preview} (expected {expected!r} prefix)"
|
||
|
||
|
||
def _get_langfuse() -> Optional[Langfuse]:
|
||
"""Return a cached Langfuse client, or ``None`` if unavailable.
|
||
|
||
Runtime-availability gate only (SDK installed + credentials present);
|
||
activation is the plugin system's job. The first build is serialized by
|
||
``_LANGFUSE_CLIENT_LOCK`` so racing callers can't each construct a client
|
||
and leak the loser's HTTP connection + flush thread.
|
||
"""
|
||
global _LANGFUSE_CLIENT
|
||
# Fast path — already settled (success or _INIT_FAILED); no lock needed.
|
||
if _LANGFUSE_CLIENT is _INIT_FAILED:
|
||
return None
|
||
if _LANGFUSE_CLIENT is not None:
|
||
return _LANGFUSE_CLIENT
|
||
|
||
with _LANGFUSE_CLIENT_LOCK:
|
||
# Re-check: a racing thread may have finished init while we waited.
|
||
if _LANGFUSE_CLIENT is _INIT_FAILED:
|
||
return None
|
||
if _LANGFUSE_CLIENT is not None:
|
||
return _LANGFUSE_CLIENT
|
||
|
||
if Langfuse is None:
|
||
logger.warning(
|
||
"Langfuse plugin is enabled but the langfuse SDK is unavailable; "
|
||
"tracing is disabled. Run `hermes tools` and configure Langfuse "
|
||
"Observability to reinstall it."
|
||
)
|
||
_LANGFUSE_CLIENT = _INIT_FAILED
|
||
return None
|
||
|
||
public_key = _env("HERMES_LANGFUSE_PUBLIC_KEY") or _env("LANGFUSE_PUBLIC_KEY")
|
||
secret_key = _env("HERMES_LANGFUSE_SECRET_KEY") or _env("LANGFUSE_SECRET_KEY")
|
||
if not (public_key and secret_key):
|
||
_LANGFUSE_CLIENT = _INIT_FAILED
|
||
return None
|
||
|
||
# The SDK does not validate keys at construction; placeholder keys
|
||
# would fail silently at flush time (#23823). Warn once here instead.
|
||
placeholder_issues = list(filter(None, (
|
||
_validate_langfuse_key("HERMES_LANGFUSE_PUBLIC_KEY", public_key),
|
||
_validate_langfuse_key("HERMES_LANGFUSE_SECRET_KEY", secret_key),
|
||
)))
|
||
if placeholder_issues:
|
||
logger.warning(
|
||
"Langfuse plugin: credentials look like placeholders, traces will "
|
||
"NOT be emitted (%s). Set real Langfuse keys (pk-lf-... / sk-lf-...) "
|
||
"or unset HERMES_LANGFUSE_PUBLIC_KEY / HERMES_LANGFUSE_SECRET_KEY to "
|
||
"silence this warning.",
|
||
"; ".join(placeholder_issues),
|
||
)
|
||
_LANGFUSE_CLIENT = _INIT_FAILED
|
||
return None
|
||
|
||
kwargs: Dict[str, Any] = {
|
||
"public_key": public_key,
|
||
"secret_key": secret_key,
|
||
"base_url": _env("HERMES_LANGFUSE_BASE_URL") or _env("LANGFUSE_BASE_URL") or "https://cloud.langfuse.com",
|
||
}
|
||
for key, hermes_name, plain_name in (("environment", "HERMES_LANGFUSE_ENV", "LANGFUSE_ENV"),
|
||
("release", "HERMES_LANGFUSE_RELEASE", "LANGFUSE_RELEASE")):
|
||
value = _env(hermes_name) or _env(plain_name)
|
||
if value:
|
||
kwargs[key] = value
|
||
sample_rate = _env("HERMES_LANGFUSE_SAMPLE_RATE")
|
||
if sample_rate:
|
||
try:
|
||
kwargs["sample_rate"] = float(sample_rate)
|
||
except ValueError:
|
||
logger.warning("Invalid HERMES_LANGFUSE_SAMPLE_RATE=%r", sample_rate)
|
||
|
||
try:
|
||
_LANGFUSE_CLIENT = Langfuse(**kwargs)
|
||
except Exception as exc: # pragma: no cover - fail-open
|
||
logger.warning("Could not initialize Langfuse client: %s", exc)
|
||
_LANGFUSE_CLIENT = _INIT_FAILED
|
||
return None
|
||
|
||
# atexit is LIFO: registering AFTER the SDK's constructor means our
|
||
# finalizer runs first, so root spans ended there still get flushed
|
||
# by the SDK (short-lived processes: kanban workers, chat -q, cron).
|
||
atexit.register(_finalize_all_traces)
|
||
return _LANGFUSE_CLIENT
|
||
|
||
|
||
def _scope_prefix(task_id: str, session_id: str) -> str:
|
||
if task_id:
|
||
return f"task:{task_id}"
|
||
if session_id:
|
||
return f"session:{session_id}"
|
||
return f"thread:{threading.get_ident()}"
|
||
|
||
|
||
def _trace_key(task_id: str, session_id: str, *, turn_id: str = "", api_request_id: str = "") -> str:
|
||
"""Stable in-process trace scope key for one agent turn.
|
||
|
||
``turn_id``/``api_request_id`` scope state so concurrent requests sharing a
|
||
task/session never collide. ``turn_id`` wins over ``api_request_id`` so the
|
||
turn-level post_llm_call hook (no api_request_id) resolves to the same key
|
||
as request-level hooks. Legacy shape: bare ``task_id`` (no ``task:`` prefix),
|
||
kept for keys minted before turn/request scoping existed.
|
||
"""
|
||
if turn_id:
|
||
return f"{_scope_prefix(task_id, session_id)}:turn:{turn_id}"
|
||
if api_request_id:
|
||
return f"{_scope_prefix(task_id, session_id)}:api:{api_request_id}"
|
||
if task_id:
|
||
return task_id
|
||
return _scope_prefix(task_id, session_id)
|
||
|
||
|
||
def _state_for_turn(turn_id: str) -> Optional[str]:
|
||
"""Resolve a live trace key from a turn id alone. Caller must hold ``_STATE_LOCK``.
|
||
|
||
Subagent hooks carry ``parent_turn_id`` but no ``task_id``, and the key
|
||
prefix prefers task_id — so rebuilding the key would miss; match on the
|
||
unique ``:turn:<id>`` suffix instead.
|
||
"""
|
||
if not turn_id:
|
||
return None
|
||
suffix = f":turn:{turn_id}"
|
||
for key in _TRACE_STATE:
|
||
if key.endswith(suffix):
|
||
return key
|
||
return None
|
||
|
||
|
||
def _redact_data_uri(value: str) -> dict[str, Any]:
|
||
header = value.split(",", 1)[0] if "," in value else "data:"
|
||
media_type = header[5:].split(";", 1)[0] if header.startswith("data:") else ""
|
||
return {"type": "data_uri", "media_type": media_type or None, "omitted": True, "length": len(value)}
|
||
|
||
|
||
def _truncate_text(value: str, max_chars: int) -> Any:
|
||
# The SDK decodes data:*;base64 strings as media; a truncated one is
|
||
# invalid base64 and logs noisily, so redact the whole URI instead.
|
||
prefix = value[:200].lower()
|
||
if prefix.startswith("data:") and ";base64," in prefix:
|
||
return _redact_data_uri(value)
|
||
# Redact BEFORE truncating so a secret straddling the cut cannot leak.
|
||
if _capture_mode() == "sanitized":
|
||
value = _redact_secrets(value)
|
||
if len(value) <= max_chars:
|
||
return value
|
||
return value[:max_chars] + f"... [truncated {len(value) - max_chars} chars]"
|
||
|
||
|
||
def _maybe_parse_json_string(value: str) -> Any:
|
||
stripped = value.strip()
|
||
if len(stripped) < 2 or stripped[0] not in "{[":
|
||
return value
|
||
try:
|
||
parsed, idx = json.JSONDecoder().raw_decode(stripped)
|
||
except Exception:
|
||
return value
|
||
if not isinstance(parsed, (dict, list)):
|
||
return value
|
||
|
||
trailing = stripped[idx:].strip()
|
||
if not trailing:
|
||
return parsed
|
||
|
||
hint_key = "_hint" if trailing.startswith("[Hint:") else "_trailing_text"
|
||
if isinstance(parsed, dict):
|
||
merged = dict(parsed)
|
||
merged[hint_key if hint_key not in merged else "_trailing_text"] = trailing
|
||
return merged
|
||
return {"data": parsed, hint_key: trailing}
|
||
|
||
|
||
def _parse_read_file_lines(content: str) -> list[dict[str, Any]]:
|
||
if not isinstance(content, str) or not content:
|
||
return []
|
||
lines = []
|
||
for raw_line in content.splitlines():
|
||
match = _READ_FILE_LINE_RE.match(raw_line)
|
||
if not match:
|
||
return []
|
||
lines.append({"line": int(match.group(1)), "text": match.group(2)})
|
||
return lines
|
||
|
||
|
||
def _normalize_read_file_payload(value: dict[str, Any], *, args: Any = None) -> dict[str, Any]:
|
||
normalized: dict[str, Any] = {}
|
||
if isinstance(args, dict):
|
||
path = args.get("path")
|
||
if isinstance(path, str) and path:
|
||
normalized["path"] = path
|
||
for key in ("offset", "limit"):
|
||
if isinstance(args.get(key), int):
|
||
normalized[key] = args[key]
|
||
|
||
lines = _parse_read_file_lines(value.get("content", ""))
|
||
if lines:
|
||
normalized["returned_lines"] = {"start": lines[0]["line"], "end": lines[-1]["line"], "count": len(lines)}
|
||
head, tail = _READ_FILE_HEAD_LINES, _READ_FILE_TAIL_LINES
|
||
if len(lines) <= head + tail:
|
||
normalized["content_preview"] = {"lines": lines}
|
||
else:
|
||
normalized["content_preview"] = {
|
||
"head": lines[:head],
|
||
"tail": lines[-tail:],
|
||
"omitted_line_count": len(lines) - head - tail,
|
||
}
|
||
elif value.get("content"):
|
||
normalized["content_preview"] = {"text": value.get("content", "")}
|
||
|
||
for key in ("total_lines", "file_size", "truncated", "is_binary", "is_image", "hint",
|
||
"_warning", "mime_type", "dimensions", "similar_files", "error"):
|
||
if key in value:
|
||
normalized[key] = value[key]
|
||
|
||
base64_content = value.get("base64_content")
|
||
if isinstance(base64_content, str) and base64_content:
|
||
normalized["base64_content"] = {"omitted": True, "length": len(base64_content)}
|
||
return normalized
|
||
|
||
|
||
def _normalize_payload(value: Any, *, tool_name: str = "", args: Any = None) -> Any:
|
||
"""Collapse a read_file result (line-numbered content + file metadata) into a compact preview."""
|
||
is_read_file = (
|
||
isinstance(value, dict)
|
||
and isinstance(value.get("content"), str)
|
||
and all(k in value for k in ("total_lines", "file_size", "is_binary", "is_image"))
|
||
and not value.get("error")
|
||
)
|
||
if is_read_file:
|
||
return _normalize_read_file_payload(value, args=args if tool_name == "read_file" else None)
|
||
return value
|
||
|
||
|
||
def _safe_value(value: Any, *, max_chars: Optional[int] = None, depth: int = 0,
|
||
parse_json_strings: bool = False) -> Any:
|
||
max_chars = max_chars if max_chars is not None else int(_env("HERMES_LANGFUSE_MAX_CHARS", "12000") or "12000")
|
||
if depth > 4:
|
||
return "<max-depth>"
|
||
if value is None or isinstance(value, (int, float, bool)):
|
||
return value
|
||
if isinstance(value, bytes):
|
||
return {"type": "bytes", "len": len(value)}
|
||
recurse = lambda v, d: _safe_value(v, max_chars=max_chars, depth=d, parse_json_strings=parse_json_strings) # noqa: E731
|
||
if isinstance(value, str):
|
||
if parse_json_strings:
|
||
parsed = _maybe_parse_json_string(value)
|
||
if parsed is not value:
|
||
return recurse(parsed, depth)
|
||
return _truncate_text(value, max_chars)
|
||
if isinstance(value, dict):
|
||
normalized = _normalize_payload(value)
|
||
if normalized is not value:
|
||
return recurse(normalized, depth)
|
||
return {str(k): recurse(v, depth + 1) for k, v in list(value.items())[:50]}
|
||
if isinstance(value, (list, tuple, set)):
|
||
return [recurse(v, depth + 1) for v in list(value)[:50]]
|
||
if hasattr(value, "__dict__"):
|
||
return recurse(vars(value), depth + 1)
|
||
return _truncate_text(repr(value), max_chars)
|
||
|
||
|
||
def _extract_last_user_message(messages: Any) -> Any:
|
||
if not isinstance(messages, list):
|
||
return None
|
||
for message in reversed(messages):
|
||
if isinstance(message, dict) and message.get("role") == "user":
|
||
return {"role": "user", "content": _capture_content(message.get("content"))}
|
||
return None
|
||
|
||
|
||
def _coerce_request_messages(*, request_messages: Any = None, messages: Any = None,
|
||
conversation_history: Any = None, user_message: Any = None) -> list[dict[str, Any]]:
|
||
for candidate in (request_messages, messages, conversation_history):
|
||
if isinstance(candidate, list):
|
||
return candidate
|
||
if user_message is None:
|
||
return []
|
||
return [{"role": "user", "content": user_message}]
|
||
|
||
|
||
def _serialize_system_prompt(system_prompt: Any) -> Optional[dict[str, Any]]:
|
||
"""Normalize Anthropic/Bedrock ``system`` param or OpenAI-style system content."""
|
||
if isinstance(system_prompt, str):
|
||
text = system_prompt.strip()
|
||
elif isinstance(system_prompt, list):
|
||
parts: list[str] = []
|
||
for block in system_prompt:
|
||
if isinstance(block, dict):
|
||
# Anthropic: {"type": "text", "text": ...}; Bedrock Converse: {"text": ...}.
|
||
block_type = block.get("type")
|
||
if block_type == "text" or (block_type is None and "text" in block):
|
||
piece = block.get("text", "")
|
||
if isinstance(piece, str) and piece:
|
||
parts.append(piece)
|
||
elif isinstance(block, str) and block:
|
||
parts.append(block)
|
||
text = "\n\n".join(parts)
|
||
else:
|
||
return None
|
||
if not text:
|
||
return None
|
||
return {"role": "system", "content": _capture_content(text)}
|
||
|
||
|
||
def _messages_for_langfuse_input(*, request_messages: Any = None, messages: Any = None,
|
||
conversation_history: Any = None, user_message: Any = None,
|
||
system_prompt: Any = None, pre_coerced: Any = None) -> list[dict[str, Any]]:
|
||
"""Generation input, prepending ``system_prompt`` when the provider split it out of messages.
|
||
|
||
``pre_coerced`` lets the caller pass an already-coerced list and skip a
|
||
second ``_coerce_request_messages`` per hook.
|
||
"""
|
||
raw = pre_coerced if pre_coerced is not None else _coerce_request_messages(
|
||
request_messages=request_messages, messages=messages,
|
||
conversation_history=conversation_history, user_message=user_message,
|
||
)
|
||
system_msg = None if raw and raw[0].get("role") == "system" else _serialize_system_prompt(system_prompt)
|
||
serialized = _serialize_messages(raw)
|
||
return serialized if system_msg is None else [system_msg, *serialized]
|
||
|
||
|
||
def _serialize_messages(messages: Any) -> list[dict[str, Any]]:
|
||
if not isinstance(messages, list):
|
||
return []
|
||
serialized = []
|
||
for message in messages[-12:]:
|
||
if not isinstance(message, dict):
|
||
continue
|
||
role = message.get("role")
|
||
item = {"role": role, "content": _capture_content(message.get("content"), parse_json_strings=(role == "tool"))}
|
||
if role == "tool":
|
||
if message.get("tool_call_id"):
|
||
item["tool_call_id"] = message.get("tool_call_id")
|
||
if message.get("name"):
|
||
item["name"] = _safe_value(message.get("name"))
|
||
if message.get("tool_calls"):
|
||
item["tool_calls"] = _capture_content(message.get("tool_calls"), parse_json_strings=True)
|
||
serialized.append(item)
|
||
return serialized
|
||
|
||
|
||
def _serialize_tool_calls(tool_calls: Any) -> list[dict[str, Any]]:
|
||
serialized = []
|
||
for tool_call in tool_calls or ():
|
||
fn = getattr(tool_call, "function", None)
|
||
name = getattr(fn, "name", None) if fn else None
|
||
safe_arguments = _capture_content(getattr(fn, "arguments", None) if fn else None)
|
||
serialized.append({
|
||
"id": getattr(tool_call, "id", None),
|
||
"type": getattr(tool_call, "type", None) or "function",
|
||
"name": name,
|
||
"arguments": safe_arguments,
|
||
"function": {"name": name, "arguments": safe_arguments},
|
||
})
|
||
return serialized
|
||
|
||
|
||
def _serialize_assistant_message(message: Any) -> dict[str, Any]:
|
||
reasoning = None
|
||
for attr in ("reasoning", "reasoning_content", "reasoning_details"):
|
||
value = getattr(message, attr, None)
|
||
if value is not None:
|
||
reasoning = _capture_content(value)
|
||
break
|
||
return {
|
||
"content": _capture_content(getattr(message, "content", None)),
|
||
"reasoning": reasoning,
|
||
"tool_calls": _serialize_tool_calls(getattr(message, "tool_calls", None)),
|
||
}
|
||
|
||
|
||
def _canonical_usage_and_cost(canonical: Any, *, provider: str, model: str,
|
||
base_url: str) -> tuple[dict[str, int], dict[str, float]]:
|
||
"""Translate canonical Hermes usage into Langfuse usage and cost maps."""
|
||
usage_details: Dict[str, int] = {}
|
||
for key, attr, _ in _USAGE_FIELDS:
|
||
tokens = getattr(canonical, attr)
|
||
if tokens or key in ("input", "output"):
|
||
usage_details[key] = tokens
|
||
|
||
cost_details: Dict[str, float] = {}
|
||
try:
|
||
from agent.usage_pricing import estimate_usage_cost, resolve_billing_route
|
||
|
||
# Subscription-included routes: Langfuse treats explicit cost_details
|
||
# (even zeros) as authoritative, so omit them and let it estimate.
|
||
route = resolve_billing_route(model, provider=provider, base_url=base_url)
|
||
if getattr(route, "billing_mode", "") == "subscription_included":
|
||
return usage_details, cost_details
|
||
cost = estimate_usage_cost(model, canonical, provider=provider, base_url=base_url, api_key="")
|
||
except Exception as exc: # pragma: no cover - fail-open
|
||
_debug(f"usage pricing failed: {exc}")
|
||
return usage_details, cost_details
|
||
|
||
# No total (e.g. cache pricing unknown) => export no costs at all, so a
|
||
# partial component subtotal is never mistaken for the request total.
|
||
if cost.amount_usd is None:
|
||
return usage_details, cost_details
|
||
|
||
# Langfuse only derives totals from input/output keys, so cache/custom keys
|
||
# need an explicit total (Hermes estimate also includes request pricing).
|
||
# A zero total is not exported: Langfuse would treat it as authoritative.
|
||
if cost.status != "included" and float(cost.amount_usd) > 0:
|
||
cost_details["total"] = float(cost.amount_usd)
|
||
|
||
# Per-type breakdown for dashboards; keys mirror usage_details.
|
||
try:
|
||
from decimal import Decimal
|
||
|
||
from agent.usage_pricing import get_pricing_entry
|
||
|
||
entry = get_pricing_entry(model, provider=provider, base_url=base_url)
|
||
if entry:
|
||
for key, attr, rate_attr in _USAGE_FIELDS:
|
||
rate = getattr(entry, rate_attr, None) if rate_attr else None
|
||
tokens = getattr(canonical, attr)
|
||
if rate is not None and tokens:
|
||
cost_details[key] = float(Decimal(tokens) * rate / Decimal("1000000"))
|
||
except Exception: # pragma: no cover - canonical total remains usable
|
||
pass
|
||
|
||
return usage_details, cost_details
|
||
|
||
|
||
def _usage_and_cost(response: Any, *, provider: str, api_mode: str, model: str, base_url: str) -> tuple[dict[str, int], dict[str, float]]:
|
||
raw_usage = getattr(response, "usage", None)
|
||
if not raw_usage:
|
||
return {}, {}
|
||
try:
|
||
from agent.usage_pricing import normalize_usage
|
||
|
||
canonical = normalize_usage(raw_usage, provider=provider, api_mode=api_mode)
|
||
return _canonical_usage_and_cost(canonical, provider=provider, model=model, base_url=base_url)
|
||
except Exception as exc: # pragma: no cover - fail-open
|
||
_debug(f"usage normalization failed: {exc}")
|
||
return {}, {}
|
||
|
||
|
||
def _summary_usage_and_cost(usage: dict, *, provider: str, model: str, base_url: str) -> tuple[dict[str, int], dict[str, float]]:
|
||
"""post_api_request path: usage arrives as a pre-built CanonicalUsage summary dict."""
|
||
try:
|
||
from agent.usage_pricing import CanonicalUsage
|
||
|
||
canonical = CanonicalUsage(
|
||
input_tokens=usage.get("input_tokens", 0),
|
||
output_tokens=usage.get("output_tokens", 0) or usage.get("completion_tokens", 0),
|
||
cache_read_tokens=usage.get("cache_read_tokens", 0),
|
||
cache_write_tokens=usage.get("cache_write_tokens", 0),
|
||
reasoning_tokens=usage.get("reasoning_tokens", 0),
|
||
request_count=usage.get("request_count", 1),
|
||
)
|
||
return _canonical_usage_and_cost(canonical, provider=provider, model=model, base_url=base_url)
|
||
except Exception:
|
||
return {}, {}
|
||
|
||
|
||
def _start_root_trace(task_key: str, *, task_id: str, session_id: str, platform: str, provider: str, model: str,
|
||
api_mode: str, messages: Any, client: Langfuse,
|
||
turn_id: str = "", api_request_id: str = "") -> TraceState:
|
||
trace_id = client.create_trace_id(seed=f"{session_id or 'sessionless'}::{task_id or task_key}")
|
||
trace_input = _extract_last_user_message(messages)
|
||
metadata = {
|
||
"source": "hermes", "task_id": task_id, "turn_id": turn_id, "api_request_id": api_request_id,
|
||
"platform": platform, "provider": provider, "model": model, "api_mode": api_mode,
|
||
"capture_mode": _capture_mode(),
|
||
}
|
||
# session_id must be in trace_context for Langfuse session grouping.
|
||
trace_ctx: Dict[str, Any] = {"trace_id": trace_id}
|
||
if session_id:
|
||
trace_ctx["session_id"] = session_id
|
||
|
||
def open_root():
|
||
ctx = client.start_as_current_observation(
|
||
trace_context=trace_ctx, name="Hermes turn", as_type="chain",
|
||
input=trace_input, metadata=metadata, end_on_exit=False,
|
||
)
|
||
return ctx, ctx.__enter__()
|
||
|
||
root_ctx = root_span = None
|
||
if propagate_attributes is not None:
|
||
try:
|
||
with propagate_attributes(session_id=session_id or task_key, trace_name="Hermes turn",
|
||
tags=["hermes", "langfuse"]):
|
||
root_ctx, root_span = open_root()
|
||
except Exception:
|
||
root_ctx = None
|
||
if root_ctx is None:
|
||
root_ctx, root_span = open_root()
|
||
|
||
# SDK v3 uses update_trace(); failures must never block the turn.
|
||
try:
|
||
root_span.update_trace(input=trace_input)
|
||
except Exception as exc:
|
||
_debug(f"update_trace(input) failed: {exc}")
|
||
|
||
_debug(f"started trace {trace_id} for {task_key}")
|
||
return TraceState(trace_id=trace_id, root_ctx=root_ctx, root_span=root_span)
|
||
|
||
|
||
def _start_child_observation(state: TraceState, *, client: Langfuse, name: str, as_type: str,
|
||
input_value: Any, metadata: Optional[dict] = None,
|
||
model: Optional[str] = None, model_parameters: Optional[dict] = None) -> Any:
|
||
return state.root_span.start_observation(
|
||
name=name, as_type=as_type, input=input_value, metadata=metadata or {},
|
||
model=model, model_parameters=model_parameters,
|
||
)
|
||
|
||
|
||
def _end_observation(observation: Any, *, output: Any = None, metadata: Optional[dict] = None,
|
||
usage_details: Optional[dict] = None, cost_details: Optional[dict] = None) -> None:
|
||
if observation is None:
|
||
return
|
||
try:
|
||
update_kwargs: Dict[str, Any] = {}
|
||
if output is not None:
|
||
update_kwargs["output"] = output
|
||
for key, val in (("metadata", metadata), ("usage_details", usage_details), ("cost_details", cost_details)):
|
||
if val:
|
||
update_kwargs[key] = val
|
||
if update_kwargs:
|
||
observation.update(**update_kwargs)
|
||
observation.end()
|
||
except Exception as exc: # pragma: no cover - fail-open
|
||
_debug(f"end observation failed: {exc}")
|
||
|
||
|
||
def _end_children(state: TraceState, *, include_subagents: bool = False) -> None:
|
||
for observation in (*state.generations.values(), *state.tools.values()):
|
||
_end_observation(observation)
|
||
for queue in state.pending_tools_by_name.values():
|
||
for observation in queue:
|
||
_end_observation(observation)
|
||
if include_subagents:
|
||
for observation in state.subagents.values():
|
||
_end_observation(observation)
|
||
|
||
|
||
def _exit_root_ctx(state: TraceState) -> None:
|
||
# Unwind the root context manager now, while opentelemetry.trace.Span is
|
||
# still a real type; GC-driven close at interpreter teardown raises
|
||
# TypeError inside use_span's isinstance check.
|
||
if state.root_ctx is not None:
|
||
try:
|
||
state.root_ctx.__exit__(None, None, None)
|
||
except Exception: # pragma: no cover - fail-open
|
||
pass
|
||
|
||
|
||
def _merge_trace_output(output: Any, state: TraceState) -> Any:
|
||
if not state.turn_tool_calls:
|
||
return output
|
||
merged = dict(output) if isinstance(output, dict) else {"content": output}
|
||
merged["tool_calls"] = list(state.turn_tool_calls)
|
||
return merged
|
||
|
||
|
||
def _evict_stale_locked() -> None:
|
||
"""Evict least-recently-updated state down to ``_MAX_TRACE_STATE - 1``.
|
||
|
||
Caller MUST hold ``_STATE_LOCK`` and insert exactly one entry afterwards.
|
||
Evicted roots are ended so they are not left dangling on the Langfuse side.
|
||
"""
|
||
over = len(_TRACE_STATE) - (_MAX_TRACE_STATE - 1)
|
||
if over <= 0:
|
||
return
|
||
stale = sorted(_TRACE_STATE.items(), key=lambda kv: kv[1].last_updated_at)[:over]
|
||
for key, state in stale:
|
||
_TRACE_STATE.pop(key, None)
|
||
try:
|
||
state.root_span.end()
|
||
_exit_root_ctx(state)
|
||
except Exception as exc: # pragma: no cover - fail-open
|
||
_debug(f"evict stale trace failed: {exc}")
|
||
|
||
|
||
def _finalize_all_traces() -> None:
|
||
"""atexit: end every open root span so short-lived processes export complete traces.
|
||
|
||
Short-lived CLI processes (kanban workers, ``chat -q``, cron) can exit with
|
||
tool calls still queued; children export via the SDK's own flush but the
|
||
un-ended root never arrives, leaving an anonymous trace on the backend.
|
||
Registered after the client is built, so (atexit is LIFO) it runs before
|
||
the SDK's shutdown hook and the ended spans still get flushed.
|
||
"""
|
||
with _STATE_LOCK:
|
||
states = list(_TRACE_STATE.items())
|
||
_TRACE_STATE.clear()
|
||
for _key, state in states:
|
||
try:
|
||
_end_children(state, include_subagents=True)
|
||
state.root_span.end()
|
||
_exit_root_ctx(state)
|
||
except Exception as exc: # pragma: no cover - fail-open
|
||
_debug(f"atexit finalize failed for {_key}: {exc}")
|
||
if states:
|
||
client = _get_langfuse()
|
||
if client is not None:
|
||
try:
|
||
client.flush()
|
||
except Exception:
|
||
pass
|
||
|
||
|
||
def _finish_trace(task_key: str, *, output: Any = None) -> None:
|
||
client = _get_langfuse()
|
||
if client is None:
|
||
return
|
||
|
||
with _STATE_LOCK:
|
||
state = _TRACE_STATE.pop(task_key, None)
|
||
if state is None:
|
||
return
|
||
|
||
try:
|
||
_end_children(state)
|
||
final_output = _merge_trace_output(output, state)
|
||
if final_output is not None:
|
||
# update_trace sets TRACE-level I/O (SDK v3); root I/O via update().
|
||
# Neither may prevent end(), else children export without a root.
|
||
for method, label in (("update_trace", "update_trace(output)"), ("update", "root update(output)")):
|
||
try:
|
||
getattr(state.root_span, method)(output=final_output)
|
||
except Exception as exc:
|
||
_debug(f"{label} failed: {exc}")
|
||
try:
|
||
state.root_span.end()
|
||
except Exception as exc:
|
||
_debug(f"root end() failed: {exc}")
|
||
_exit_root_ctx(state)
|
||
except Exception as exc: # pragma: no cover - fail-open
|
||
_debug(f"finish trace failed: {exc}")
|
||
# Last-chance end so an unexpected error still exports the root.
|
||
try:
|
||
state.root_span.end()
|
||
except Exception:
|
||
pass
|
||
finally:
|
||
try:
|
||
client.flush()
|
||
except Exception:
|
||
pass
|
||
|
||
|
||
def _request_key(api_call_count: Any) -> str:
|
||
return str(api_call_count or 0)
|
||
|
||
|
||
def _pop_generation(task_key: str, api_call_count: Any) -> tuple[Optional[TraceState], Any]:
|
||
"""Detach the open generation for one API call. Returns (state, generation); either may be None."""
|
||
with _STATE_LOCK:
|
||
state = _TRACE_STATE.get(task_key)
|
||
generation = state.generations.pop(_request_key(api_call_count), None) if state else None
|
||
return state, generation
|
||
|
||
|
||
def _get_or_start_state_locked(task_key: str, **root_kwargs: Any) -> TraceState:
|
||
"""Caller must hold ``_STATE_LOCK``. Starts a root trace if the key is new."""
|
||
state = _TRACE_STATE.get(task_key)
|
||
if state is None:
|
||
state = _start_root_trace(task_key, **root_kwargs)
|
||
_evict_stale_locked()
|
||
_TRACE_STATE[task_key] = state
|
||
state.last_updated_at = time.time()
|
||
return state
|
||
|
||
|
||
def on_pre_llm_call(*, task_id: str = "", session_id: str = "", platform: str = "", model: str = "",
|
||
provider: str = "", api_mode: str = "", messages: Any = None,
|
||
turn_id: str = "", api_request_id: str = "", **_: Any) -> None:
|
||
# Only legacy request-shaped calls carry an API ``messages`` list. Current
|
||
# Hermes fires a turn-scoped pre_llm_call for context injection; tracing
|
||
# that would create an orphan root trace before the real request trace.
|
||
if not isinstance(messages, list):
|
||
return
|
||
client = _get_langfuse()
|
||
if client is None:
|
||
return
|
||
|
||
task_key = _trace_key(task_id, session_id, turn_id=turn_id, api_request_id=api_request_id)
|
||
with _STATE_LOCK:
|
||
_get_or_start_state_locked(
|
||
task_key, task_id=task_id, session_id=session_id, platform=platform, provider=provider,
|
||
model=model, api_mode=api_mode, messages=messages, client=client,
|
||
turn_id=turn_id, api_request_id=api_request_id,
|
||
)
|
||
|
||
|
||
def _emit_moa_reference_generations(state: TraceState, *, client: Langfuse, references: Any) -> None:
|
||
"""Record each MoA advisor as its own generation under the turn.
|
||
|
||
MoA returns only the aggregator's response; advisors routinely run on a
|
||
different provider/model, so without this the whole fan-out would collapse
|
||
into one generation priced at the aggregator's rate.
|
||
"""
|
||
if not isinstance(references, list) or not references:
|
||
return
|
||
fingerprint = json.dumps(
|
||
[[r.get("label"), r.get("model"), (r.get("usage") or {}).get("output_tokens")]
|
||
for r in references if isinstance(r, dict)],
|
||
sort_keys=True, default=str,
|
||
)
|
||
with _STATE_LOCK:
|
||
if fingerprint in state.moa_emitted:
|
||
return
|
||
state.moa_emitted.add(fingerprint)
|
||
|
||
for ref in references:
|
||
if not isinstance(ref, dict):
|
||
continue
|
||
usage = ref.get("usage") or {}
|
||
usage_details = {}
|
||
if isinstance(usage, dict):
|
||
for key, attr, _ in _USAGE_FIELDS:
|
||
if usage.get(attr):
|
||
usage_details[key] = usage[attr]
|
||
cost_usd = ref.get("cost_usd")
|
||
cost_details = {"total": float(cost_usd)} if isinstance(cost_usd, (int, float)) else {}
|
||
|
||
label = ref.get("label") or "advisor"
|
||
metadata = {"moa_role": "reference", "label": label}
|
||
for key in ("provider", "cost_status", "cost_source", "temperature"):
|
||
if ref.get(key) is not None:
|
||
metadata[key] = ref[key]
|
||
|
||
observation = _start_child_observation(
|
||
state, client=client, name=f"MoA advisor: {label}", as_type="generation",
|
||
input_value=None, metadata=metadata, model=ref.get("model"),
|
||
)
|
||
_end_observation(
|
||
observation, output=_capture_content(ref.get("output")),
|
||
usage_details=usage_details, cost_details=cost_details, metadata=metadata,
|
||
)
|
||
|
||
|
||
def on_pre_llm_request(*, task_id: str = "", session_id: str = "", platform: str = "", model: str = "",
|
||
provider: str = "", base_url: str = "", api_mode: str = "", api_call_count: int = 0,
|
||
request_messages: Any = None, messages: Any = None, message_count: int = 0,
|
||
approx_input_tokens: int = 0, conversation_history: Any = None,
|
||
user_message: Any = None, turn_id: str = "", api_request_id: str = "",
|
||
request: Any = None, system_prompt: Any = None, **_: Any) -> None:
|
||
client = _get_langfuse()
|
||
if client is None:
|
||
return
|
||
|
||
# The request body carries the model actually dispatched (mid-session
|
||
# switch, fallback, middleware rewrite) — prefer it over the agent attribute.
|
||
if isinstance(request, dict) and isinstance(request.get("body"), dict):
|
||
body_model = request["body"].get("model")
|
||
if isinstance(body_model, str) and body_model:
|
||
model = body_model
|
||
|
||
input_messages = _coerce_request_messages(
|
||
request_messages=request_messages, messages=messages,
|
||
conversation_history=conversation_history, user_message=user_message,
|
||
)
|
||
langfuse_input = _messages_for_langfuse_input(system_prompt=system_prompt, pre_coerced=input_messages)
|
||
system_chars = 0
|
||
if langfuse_input and langfuse_input[0].get("role") == "system":
|
||
system_chars = len(str(langfuse_input[0].get("content") or ""))
|
||
|
||
task_key = _trace_key(task_id, session_id, turn_id=turn_id, api_request_id=api_request_id)
|
||
req_key = _request_key(api_call_count)
|
||
|
||
with _STATE_LOCK:
|
||
state = _get_or_start_state_locked(
|
||
task_key, task_id=task_id, session_id=session_id, platform=platform, provider=provider,
|
||
model=model, api_mode=api_mode, messages=input_messages, client=client,
|
||
turn_id=turn_id, api_request_id=api_request_id,
|
||
)
|
||
previous = state.generations.pop(req_key, None)
|
||
if previous is not None:
|
||
_end_observation(previous)
|
||
gen_metadata = {
|
||
"provider": provider, "platform": platform, "api_mode": api_mode, "base_url": base_url,
|
||
"message_count": message_count, "approx_input_tokens": approx_input_tokens,
|
||
}
|
||
if system_chars:
|
||
gen_metadata["system_prompt_chars"] = system_chars
|
||
state.generations[req_key] = _start_child_observation(
|
||
state, client=client, name=f"LLM call {api_call_count}", as_type="generation",
|
||
input_value=langfuse_input, metadata=gen_metadata, model=model,
|
||
model_parameters={"api_mode": api_mode, "provider": provider},
|
||
)
|
||
|
||
|
||
def on_post_llm_call(*, task_id: str = "", session_id: str = "", provider: str = "", base_url: str = "",
|
||
api_mode: str = "", model: str = "", api_call_count: int = 0, assistant_message: Any = None,
|
||
response: Any = None, api_duration: float = 0.0, finish_reason: str = "", usage: Any = None,
|
||
assistant_content_chars: int = 0, assistant_tool_call_count: int = 0,
|
||
assistant_response: Any = None, turn_id: str = "", api_request_id: str = "",
|
||
response_model: Any = None, moa_references: Any = None, **_: Any) -> None:
|
||
client = _get_langfuse()
|
||
if client is None:
|
||
return
|
||
|
||
# The response echoes the model that actually served the request.
|
||
if isinstance(response_model, str) and response_model:
|
||
model = response_model
|
||
|
||
task_key = _trace_key(task_id, session_id, turn_id=turn_id, api_request_id=api_request_id)
|
||
state, generation = _pop_generation(task_key, api_call_count)
|
||
if state is None or generation is None:
|
||
return
|
||
|
||
if moa_references:
|
||
_emit_moa_reference_generations(state, client=client, references=moa_references)
|
||
|
||
# Two call shapes: post_llm_call passes assistant_message / assistant_response
|
||
# objects; post_api_request passes summary counts + a usage dict.
|
||
if assistant_message is not None:
|
||
output = _serialize_assistant_message(assistant_message)
|
||
elif assistant_response is not None:
|
||
output = {"content": _capture_content(assistant_response), "reasoning": None, "tool_calls": []}
|
||
else:
|
||
output = {
|
||
"content": f"[{assistant_content_chars} chars]" if assistant_content_chars else None,
|
||
"reasoning": None,
|
||
"tool_calls": [{"id": f"tc_{i}"} for i in range(assistant_tool_call_count)] if assistant_tool_call_count else [],
|
||
}
|
||
|
||
if output.get("tool_calls"):
|
||
state.turn_tool_calls.extend(output["tool_calls"])
|
||
|
||
# post_api_request's ``response`` is a sanitized dict with no ``.usage``;
|
||
# gate on the attribute so the usage-dict fallback is actually reached.
|
||
if getattr(response, "usage", None) is not None:
|
||
usage_details, cost_details = _usage_and_cost(
|
||
response, provider=provider, api_mode=api_mode, model=model, base_url=base_url,
|
||
)
|
||
elif isinstance(usage, dict) and usage:
|
||
usage_details, cost_details = _summary_usage_and_cost(
|
||
usage, provider=provider, model=model, base_url=base_url,
|
||
)
|
||
else:
|
||
usage_details, cost_details = {}, {}
|
||
|
||
gen_metadata: Dict[str, Any] = {"tool_call_count": len(output.get("tool_calls", [])) or assistant_tool_call_count}
|
||
if api_duration and api_duration > 0:
|
||
gen_metadata["api_duration_s"] = round(api_duration, 3)
|
||
if finish_reason:
|
||
gen_metadata["finish_reason"] = finish_reason
|
||
_end_observation(generation, output=output, usage_details=usage_details,
|
||
cost_details=cost_details, metadata=gen_metadata)
|
||
|
||
has_tools = bool(getattr(assistant_message, "tool_calls", None)) if assistant_message else assistant_tool_call_count > 0
|
||
if not has_tools and output.get("content"):
|
||
_finish_trace(task_key, output=output)
|
||
|
||
|
||
def on_pre_tool_call(*, tool_name: str = "", args: Any = None, task_id: str = "",
|
||
session_id: str = "", tool_call_id: str = "",
|
||
turn_id: str = "", api_request_id: str = "", **_: Any) -> None:
|
||
client = _get_langfuse()
|
||
if client is None:
|
||
return
|
||
|
||
task_key = _trace_key(task_id, session_id, turn_id=turn_id, api_request_id=api_request_id)
|
||
with _STATE_LOCK:
|
||
state = _TRACE_STATE.get(task_key)
|
||
if state is None:
|
||
return
|
||
observation = _start_child_observation(
|
||
state, client=client, name=f"Tool: {tool_name}", as_type="tool",
|
||
input_value=_capture_content(args),
|
||
metadata={"tool_name": tool_name, "tool_call_id": tool_call_id},
|
||
)
|
||
if tool_call_id:
|
||
state.tools[tool_call_id] = observation
|
||
else:
|
||
state.pending_tools_by_name.setdefault(tool_name, []).append(observation)
|
||
|
||
|
||
def on_post_tool_call(*, tool_name: str = "", args: Any = None, result: Any = None,
|
||
task_id: str = "", session_id: str = "", tool_call_id: str = "",
|
||
turn_id: str = "", api_request_id: str = "", **_: Any) -> None:
|
||
task_key = _trace_key(task_id, session_id, turn_id=turn_id, api_request_id=api_request_id)
|
||
with _STATE_LOCK:
|
||
state = _TRACE_STATE.get(task_key)
|
||
if state is None:
|
||
return
|
||
observation = state.tools.pop(tool_call_id, None) if tool_call_id else None
|
||
if observation is None:
|
||
queue = state.pending_tools_by_name.get(tool_name)
|
||
if queue:
|
||
observation = queue.pop(0)
|
||
if not queue:
|
||
state.pending_tools_by_name.pop(tool_name, None)
|
||
if observation is None:
|
||
return
|
||
|
||
if _capture_mode() == "metadata":
|
||
safe_result_value = _describe_content(result)
|
||
else:
|
||
result_value = _maybe_parse_json_string(result) if isinstance(result, str) else result
|
||
result_value = _normalize_payload(result_value, tool_name=tool_name, args=args)
|
||
safe_result_value = _safe_value(result_value, parse_json_strings=True)
|
||
|
||
# Backfill so the generation's tool_call record carries the result alongside arguments.
|
||
if tool_call_id:
|
||
with _STATE_LOCK:
|
||
state = _TRACE_STATE.get(task_key)
|
||
if state is not None:
|
||
for tool_call in reversed(state.turn_tool_calls):
|
||
if tool_call.get("id") == tool_call_id:
|
||
tool_call["output"] = safe_result_value
|
||
function_payload = tool_call.get("function")
|
||
if isinstance(function_payload, dict):
|
||
function_payload["output"] = safe_result_value
|
||
break
|
||
|
||
_end_observation(
|
||
observation, output=safe_result_value,
|
||
metadata={"tool_name": tool_name, "args": _capture_content(args, parse_json_strings=True)},
|
||
)
|
||
|
||
|
||
def on_api_request_error(*, task_id: str = "", session_id: str = "", api_call_count: int = 0,
|
||
api_duration: float = 0.0, status_code: Any = None, retry_count: Any = None,
|
||
max_retries: Any = None, retryable: Any = None, reason: Any = None, error: Any = None,
|
||
turn_id: str = "", api_request_id: str = "", **_: Any) -> None:
|
||
"""Close the open generation for a failed API request.
|
||
|
||
Without this a failed request leaves its generation open until eviction and
|
||
the turn looks hung in Langfuse. Marks it ERROR; if the request is not
|
||
retryable the turn is finished too, since the agent loop is about to unwind.
|
||
"""
|
||
client = _get_langfuse()
|
||
if client is None:
|
||
return
|
||
|
||
task_key = _trace_key(task_id, session_id, turn_id=turn_id, api_request_id=api_request_id)
|
||
state, generation = _pop_generation(task_key, api_call_count)
|
||
if state is None:
|
||
return
|
||
|
||
error_type = error_message = ""
|
||
if isinstance(error, dict):
|
||
error_type = str(error.get("type") or "")
|
||
error_message = str(error.get("message") or "")
|
||
|
||
# Error messages can embed request fragments (URLs w/ keys, prompt echoes) — capture-pipeline them.
|
||
error_metadata: Dict[str, Any] = {"error": True, "error_type": error_type, "error_message": _capture_content(error_message)}
|
||
for key, val in (("status_code", status_code), ("retry_count", retry_count),
|
||
("max_retries", max_retries), ("retryable", retryable)):
|
||
if val is not None:
|
||
error_metadata[key] = val
|
||
if reason:
|
||
error_metadata["reason"] = str(reason)
|
||
if api_duration and api_duration > 0:
|
||
error_metadata["api_duration_s"] = round(api_duration, 3)
|
||
|
||
if generation is not None:
|
||
try:
|
||
generation.update(level="ERROR", status_message=(error_type or "api_request_error")[:200])
|
||
except Exception as exc: # pragma: no cover - fail-open
|
||
_debug(f"error-level update failed: {exc}")
|
||
_end_observation(generation, metadata=error_metadata)
|
||
|
||
# A retryable failure is followed by another pre_api_request on the same
|
||
# trace; keep the turn open. A terminal failure ends the turn.
|
||
if retryable is False:
|
||
_finish_trace(task_key, output={"error": error_metadata})
|
||
else:
|
||
state.last_updated_at = time.time()
|
||
|
||
|
||
def on_session_finalize(*, session_id: str = "", reason: str = "", **_: Any) -> None:
|
||
"""Session-end boundary: close any traces still open and flush.
|
||
|
||
A turn that ended on a tool-only or empty final response never reaches
|
||
``_finish_trace``; without this its root dangles until eviction and queued
|
||
events can be lost on process exit.
|
||
"""
|
||
# Never lazily initialize a client here — if init never happened there are no traces.
|
||
client = _LANGFUSE_CLIENT
|
||
if client is None or client is _INIT_FAILED or not hasattr(client, "flush"):
|
||
return
|
||
|
||
# Close every trace of this session (or all, when no session_id: process-
|
||
# level finalization). Keys carry the session as "session:<id>" or
|
||
# "task:<id>" (gateway sets task_id == session_id) plus the legacy bare id.
|
||
with _STATE_LOCK:
|
||
if session_id:
|
||
fragments = (f"session:{session_id}", f"task:{session_id}")
|
||
keys = [k for k in _TRACE_STATE if k == session_id or any(f in k for f in fragments)]
|
||
else:
|
||
keys = list(_TRACE_STATE)
|
||
for key in keys:
|
||
_finish_trace(key)
|
||
|
||
try:
|
||
client.flush()
|
||
except Exception as exc: # pragma: no cover - fail-open
|
||
_debug(f"finalize flush failed: {exc}")
|
||
|
||
# Shut down only at a true process-exit boundary (not /new, /reset, session
|
||
# expiry, where the cached client must keep exporting). Doing it here, while
|
||
# all modules are intact, keeps the SDK's own atexit handler from hitting
|
||
# torn-down opentelemetry globals and printing a TypeError on quit.
|
||
if reason == "shutdown":
|
||
shutdown = getattr(client, "shutdown", None)
|
||
if callable(shutdown):
|
||
try:
|
||
shutdown()
|
||
except Exception as exc: # pragma: no cover - fail-open
|
||
_debug(f"langfuse shutdown failed: {exc}")
|
||
|
||
|
||
def on_subagent_start(*, parent_turn_id: str = "", parent_subagent_id: Any = None,
|
||
child_session_id: Any = None, child_subagent_id: Any = None,
|
||
child_role: str = "", child_goal: Any = None, **_: Any) -> None:
|
||
client = _get_langfuse()
|
||
if client is None or not child_session_id:
|
||
return
|
||
|
||
with _STATE_LOCK:
|
||
key = _state_for_turn(parent_turn_id)
|
||
state = _TRACE_STATE.get(key) if key else None
|
||
if state is None:
|
||
return
|
||
metadata = {"child_session_id": child_session_id, "child_subagent_id": child_subagent_id, "child_role": child_role}
|
||
if parent_subagent_id:
|
||
metadata["parent_subagent_id"] = parent_subagent_id
|
||
state.subagents[str(child_session_id)] = _start_child_observation(
|
||
state, client=client, name=f"Subagent: {child_role or 'delegate'}", as_type="span",
|
||
input_value=_capture_content(child_goal), metadata=metadata,
|
||
)
|
||
|
||
|
||
def on_subagent_stop(*, parent_turn_id: str = "", child_session_id: Any = None, child_role: str = "",
|
||
child_summary: Any = None, child_status: Any = None,
|
||
tool_call_history: Any = None, duration_ms: Any = None, **_: Any) -> None:
|
||
if not child_session_id:
|
||
return
|
||
|
||
with _STATE_LOCK:
|
||
key = _state_for_turn(parent_turn_id)
|
||
state = _TRACE_STATE.get(key) if key else None
|
||
if state is None:
|
||
return
|
||
observation = state.subagents.pop(str(child_session_id), None)
|
||
if observation is None:
|
||
return
|
||
|
||
metadata: Dict[str, Any] = {"child_role": child_role}
|
||
if child_status:
|
||
metadata["status"] = child_status
|
||
if duration_ms:
|
||
metadata["duration_ms"] = duration_ms
|
||
if isinstance(tool_call_history, list):
|
||
metadata["tool_call_count"] = len(tool_call_history)
|
||
metadata["tool_calls"] = _capture_content(tool_call_history)
|
||
_end_observation(observation, output=_capture_content(child_summary), metadata=metadata)
|
||
|
||
|
||
def register(ctx) -> None:
|
||
# Both hook-name variants so the plugin works across Hermes versions:
|
||
# *_api_request fire per API call (preferred); *_llm_call once per turn.
|
||
ctx.register_hook("pre_api_request", on_pre_llm_request)
|
||
ctx.register_hook("post_api_request", on_post_llm_call)
|
||
ctx.register_hook("api_request_error", on_api_request_error)
|
||
ctx.register_hook("pre_llm_call", on_pre_llm_call)
|
||
ctx.register_hook("post_llm_call", on_post_llm_call)
|
||
ctx.register_hook("pre_tool_call", on_pre_tool_call)
|
||
ctx.register_hook("post_tool_call", on_post_tool_call)
|
||
ctx.register_hook("on_session_finalize", on_session_finalize)
|
||
ctx.register_hook("on_session_end", on_session_finalize)
|
||
ctx.register_hook("subagent_start", on_subagent_start)
|
||
ctx.register_hook("subagent_stop", on_subagent_stop)
|