feat(plugins): add bundled observability/langfuse plugin
Opt-in Langfuse tracing for Hermes conversations — LLM calls, tool usage, usage/cost breakdown per span. Hooks into pre/post_api_request, pre/post_llm_call, pre/post_tool_call. SDK is optional; missing SDK or credentials renders the plugin inert. Salvaged from PR #16845 by @kshitijk4poor, who wrote the plugin (~875 LOC, 6 hooks, Langfuse usage-details/cost-details normalization, read_file payload summarization). Salvage scope (why this isn't PR #16845 as-authored): - Lives at plugins/observability/langfuse/ (standalone kind, opt-in via plugins.enabled) instead of a new parallel optional-plugins/ directory. Standalone bundled plugins are already opt-in — only their plugin.yaml is scanned at startup; the Python module is not imported unless the user enables it. The premise of optional-plugins/ (avoid import cost for users who don't want it) is already solved by the existing plugin system. - Dropped the triple activation gate (plugins.enabled + plugins.langfuse.enabled + HERMES_LANGFUSE_ENABLED). The Hermes plugin system's own enable/disable is authoritative; runtime credentials gate whether the hook actually traces. - Rewrote _is_enabled() → cached _get_langfuse() with an _INIT_FAILED sentinel. The original called hermes_cli.config.load_config() from every hook invocation (full yaml parse + deep merge + env expansion on every pre/post_tool_call, potentially 100+ times per turn). The cached version reads env once and returns the cached client or None on every subsequent call with zero further work. - hermes tools → Langfuse Observability post-setup adds observability/langfuse to plugins.enabled directly (via _save_enabled_set) instead of going through an install-copy flow. Enable: hermes tools # interactive hermes plugins enable observability/langfuse # manual Required env (set by `hermes tools` or in ~/.hermes/.env): HERMES_LANGFUSE_PUBLIC_KEY HERMES_LANGFUSE_SECRET_KEY HERMES_LANGFUSE_BASE_URL # optional Co-authored-by: kshitijk4poor <kshitijk4poor@gmail.com>
This commit is contained in:
parent
4d3e3ff8a2
commit
42cc905c13
6 changed files with 1206 additions and 0 deletions
|
|
@ -67,6 +67,18 @@ _EXTRA_ENV_KEYS = frozenset({
|
||||||
"MATRIX_PASSWORD", "MATRIX_ENCRYPTION", "MATRIX_DEVICE_ID", "MATRIX_HOME_ROOM",
|
"MATRIX_PASSWORD", "MATRIX_ENCRYPTION", "MATRIX_DEVICE_ID", "MATRIX_HOME_ROOM",
|
||||||
"MATRIX_REQUIRE_MENTION", "MATRIX_FREE_RESPONSE_ROOMS", "MATRIX_AUTO_THREAD", "MATRIX_DM_AUTO_THREAD",
|
"MATRIX_REQUIRE_MENTION", "MATRIX_FREE_RESPONSE_ROOMS", "MATRIX_AUTO_THREAD", "MATRIX_DM_AUTO_THREAD",
|
||||||
"MATRIX_RECOVERY_KEY",
|
"MATRIX_RECOVERY_KEY",
|
||||||
|
# Langfuse observability plugin — optional tuning keys + standard SDK vars.
|
||||||
|
# Activation is via plugins.enabled (opt-in through `hermes plugins enable
|
||||||
|
# observability/langfuse` or `hermes tools → Langfuse`); credentials gate
|
||||||
|
# the plugin at runtime.
|
||||||
|
"HERMES_LANGFUSE_ENV",
|
||||||
|
"HERMES_LANGFUSE_RELEASE",
|
||||||
|
"HERMES_LANGFUSE_SAMPLE_RATE",
|
||||||
|
"HERMES_LANGFUSE_MAX_CHARS",
|
||||||
|
"HERMES_LANGFUSE_DEBUG",
|
||||||
|
"LANGFUSE_PUBLIC_KEY",
|
||||||
|
"LANGFUSE_SECRET_KEY",
|
||||||
|
"LANGFUSE_BASE_URL",
|
||||||
})
|
})
|
||||||
import yaml
|
import yaml
|
||||||
|
|
||||||
|
|
@ -1701,6 +1713,30 @@ OPTIONAL_ENV_VARS = {
|
||||||
"category": "tool",
|
"category": "tool",
|
||||||
},
|
},
|
||||||
|
|
||||||
|
# ── Langfuse observability ──
|
||||||
|
"HERMES_LANGFUSE_PUBLIC_KEY": {
|
||||||
|
"description": "Langfuse project public key (pk-lf-...)",
|
||||||
|
"prompt": "Langfuse public key",
|
||||||
|
"url": "https://cloud.langfuse.com",
|
||||||
|
"password": False,
|
||||||
|
"category": "tool",
|
||||||
|
},
|
||||||
|
"HERMES_LANGFUSE_SECRET_KEY": {
|
||||||
|
"description": "Langfuse project secret key (sk-lf-...)",
|
||||||
|
"prompt": "Langfuse secret key",
|
||||||
|
"url": "https://cloud.langfuse.com",
|
||||||
|
"password": True,
|
||||||
|
"category": "tool",
|
||||||
|
},
|
||||||
|
"HERMES_LANGFUSE_BASE_URL": {
|
||||||
|
"description": "Langfuse server URL (default: https://cloud.langfuse.com)",
|
||||||
|
"prompt": "Langfuse server URL (leave empty for cloud.langfuse.com)",
|
||||||
|
"url": None,
|
||||||
|
"password": False,
|
||||||
|
"category": "tool",
|
||||||
|
"advanced": True,
|
||||||
|
},
|
||||||
|
|
||||||
# ── Messaging platforms ──
|
# ── Messaging platforms ──
|
||||||
"TELEGRAM_BOT_TOKEN": {
|
"TELEGRAM_BOT_TOKEN": {
|
||||||
"description": "Telegram bot token from @BotFather",
|
"description": "Telegram bot token from @BotFather",
|
||||||
|
|
|
||||||
|
|
@ -425,6 +425,31 @@ TOOL_CATEGORIES = {
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
"langfuse": {
|
||||||
|
"name": "Langfuse Observability",
|
||||||
|
"icon": "📊",
|
||||||
|
"providers": [
|
||||||
|
{
|
||||||
|
"name": "Langfuse Cloud",
|
||||||
|
"tag": "Hosted Langfuse (cloud.langfuse.com)",
|
||||||
|
"env_vars": [
|
||||||
|
{"key": "HERMES_LANGFUSE_PUBLIC_KEY", "prompt": "Langfuse public key (pk-lf-...)", "url": "https://cloud.langfuse.com"},
|
||||||
|
{"key": "HERMES_LANGFUSE_SECRET_KEY", "prompt": "Langfuse secret key (sk-lf-...)", "url": "https://cloud.langfuse.com"},
|
||||||
|
],
|
||||||
|
"post_setup": "langfuse",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Langfuse Self-Hosted",
|
||||||
|
"tag": "Self-hosted Langfuse instance",
|
||||||
|
"env_vars": [
|
||||||
|
{"key": "HERMES_LANGFUSE_PUBLIC_KEY", "prompt": "Langfuse public key (pk-lf-...)"},
|
||||||
|
{"key": "HERMES_LANGFUSE_SECRET_KEY", "prompt": "Langfuse secret key (sk-lf-...)"},
|
||||||
|
{"key": "HERMES_LANGFUSE_BASE_URL", "prompt": "Langfuse server URL (e.g. http://localhost:3000)", "default": "http://localhost:3000"},
|
||||||
|
],
|
||||||
|
"post_setup": "langfuse",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
# Simple env-var requirements for toolsets NOT in TOOL_CATEGORIES.
|
# Simple env-var requirements for toolsets NOT in TOOL_CATEGORIES.
|
||||||
|
|
@ -567,6 +592,40 @@ def _run_post_setup(post_setup_key: str):
|
||||||
_print_info(" git submodule update --init --recursive")
|
_print_info(" git submodule update --init --recursive")
|
||||||
_print_info(' uv pip install -e "./tinker-atropos"')
|
_print_info(' uv pip install -e "./tinker-atropos"')
|
||||||
|
|
||||||
|
elif post_setup_key == "langfuse":
|
||||||
|
# Install the langfuse SDK.
|
||||||
|
try:
|
||||||
|
__import__("langfuse")
|
||||||
|
_print_success(" langfuse SDK already installed")
|
||||||
|
except ImportError:
|
||||||
|
import subprocess
|
||||||
|
_print_info(" Installing langfuse SDK...")
|
||||||
|
result = subprocess.run(
|
||||||
|
[sys.executable, "-m", "pip", "install", "langfuse", "--quiet"],
|
||||||
|
capture_output=True, text=True, timeout=120,
|
||||||
|
)
|
||||||
|
if result.returncode == 0:
|
||||||
|
_print_success(" langfuse SDK installed")
|
||||||
|
else:
|
||||||
|
_print_warning(" langfuse SDK install failed — run manually: pip install langfuse")
|
||||||
|
# Opt the bundled observability/langfuse plugin into plugins.enabled.
|
||||||
|
# The plugin ships in the repo but doesn't load until the user enables
|
||||||
|
# it (standalone plugins are opt-in).
|
||||||
|
try:
|
||||||
|
from hermes_cli.plugins_cmd import _get_enabled_set, _save_enabled_set
|
||||||
|
enabled = _get_enabled_set()
|
||||||
|
if "observability/langfuse" in enabled or "langfuse" in enabled:
|
||||||
|
_print_success(" Plugin observability/langfuse already enabled")
|
||||||
|
else:
|
||||||
|
enabled.add("observability/langfuse")
|
||||||
|
_save_enabled_set(enabled)
|
||||||
|
_print_success(" Plugin observability/langfuse enabled")
|
||||||
|
except Exception as exc:
|
||||||
|
_print_warning(f" Could not enable plugin automatically: {exc}")
|
||||||
|
_print_info(" Run manually: hermes plugins enable observability/langfuse")
|
||||||
|
_print_info(" Restart Hermes for tracing to take effect.")
|
||||||
|
_print_info(" Verify: hermes plugins list")
|
||||||
|
|
||||||
|
|
||||||
# ─── Platform / Toolset Helpers ───────────────────────────────────────────────
|
# ─── Platform / Toolset Helpers ───────────────────────────────────────────────
|
||||||
|
|
||||||
|
|
|
||||||
53
plugins/observability/langfuse/README.md
Normal file
53
plugins/observability/langfuse/README.md
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
# Langfuse Observability Plugin
|
||||||
|
|
||||||
|
This plugin ships bundled with Hermes but is **opt-in** — it only loads when
|
||||||
|
you explicitly enable it.
|
||||||
|
|
||||||
|
## Enable
|
||||||
|
|
||||||
|
Pick one:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Interactive: walks you through credentials + SDK install + enable
|
||||||
|
hermes tools # → Langfuse Observability
|
||||||
|
|
||||||
|
# Manual
|
||||||
|
pip install langfuse
|
||||||
|
hermes plugins enable observability/langfuse
|
||||||
|
```
|
||||||
|
|
||||||
|
## Required credentials
|
||||||
|
|
||||||
|
Set these in `~/.hermes/.env` (or via `hermes tools`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
HERMES_LANGFUSE_PUBLIC_KEY=pk-lf-...
|
||||||
|
HERMES_LANGFUSE_SECRET_KEY=sk-lf-...
|
||||||
|
HERMES_LANGFUSE_BASE_URL=https://cloud.langfuse.com # or your self-hosted URL
|
||||||
|
```
|
||||||
|
|
||||||
|
Without the SDK or credentials the hooks no-op silently — the plugin fails
|
||||||
|
open.
|
||||||
|
|
||||||
|
## Verify
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hermes plugins list # observability/langfuse should show "enabled"
|
||||||
|
hermes chat -q "hello" # then check Langfuse for a "Hermes turn" trace
|
||||||
|
```
|
||||||
|
|
||||||
|
## Optional tuning
|
||||||
|
|
||||||
|
```bash
|
||||||
|
HERMES_LANGFUSE_ENV=production # environment tag
|
||||||
|
HERMES_LANGFUSE_RELEASE=v1.0.0 # release tag
|
||||||
|
HERMES_LANGFUSE_SAMPLE_RATE=0.5 # sample 50% of traces
|
||||||
|
HERMES_LANGFUSE_MAX_CHARS=12000 # max chars per field (default: 12000)
|
||||||
|
HERMES_LANGFUSE_DEBUG=true # verbose plugin logging
|
||||||
|
```
|
||||||
|
|
||||||
|
## Disable
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hermes plugins disable observability/langfuse
|
||||||
|
```
|
||||||
874
plugins/observability/langfuse/__init__.py
Normal file
874
plugins/observability/langfuse/__init__.py
Normal file
|
|
@ -0,0 +1,874 @@
|
||||||
|
"""langfuse — Hermes plugin for Langfuse observability.
|
||||||
|
|
||||||
|
Traces Hermes conversations, LLM calls, and tool usage to Langfuse.
|
||||||
|
|
||||||
|
Activation is handled by the Hermes plugin system — standalone plugins only
|
||||||
|
load when listed in ``plugins.enabled`` (via ``hermes plugins enable
|
||||||
|
observability/langfuse`` or ``hermes tools → Langfuse Observability``). 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_DEBUG - set to "true" for verbose logging
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
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)
|
||||||
|
turn_tool_calls: list[dict[str, Any]] = field(default_factory=list)
|
||||||
|
last_updated_at: float = field(default_factory=time.time)
|
||||||
|
|
||||||
|
|
||||||
|
_STATE_LOCK = threading.Lock()
|
||||||
|
_TRACE_STATE: Dict[str, TraceState] = {}
|
||||||
|
_LANGFUSE_CLIENT = None
|
||||||
|
_READ_FILE_LINE_RE = re.compile(r"^\s*(\d+)\|(.*)$")
|
||||||
|
_READ_FILE_HEAD_LINES = 25
|
||||||
|
_READ_FILE_TAIL_LINES = 15
|
||||||
|
|
||||||
|
|
||||||
|
def _env(name: str, default: str = "") -> str:
|
||||||
|
return os.environ.get(name, default).strip()
|
||||||
|
|
||||||
|
|
||||||
|
def _env_bool(*names: str) -> bool:
|
||||||
|
for name in names:
|
||||||
|
value = _env(name).lower()
|
||||||
|
if value:
|
||||||
|
return value in {"1", "true", "yes", "on"}
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _debug_enabled() -> bool:
|
||||||
|
return _env_bool("HERMES_LANGFUSE_DEBUG")
|
||||||
|
|
||||||
|
|
||||||
|
def _debug(message: str) -> None:
|
||||||
|
if _debug_enabled():
|
||||||
|
logger.info("Langfuse tracing: %s", message)
|
||||||
|
|
||||||
|
|
||||||
|
# Sentinel: "_get_langfuse() has tried and failed". Lets us short-circuit
|
||||||
|
# every subsequent hook call without re-checking env vars or re-attempting
|
||||||
|
# SDK init. Cleared by reset_cache_for_tests().
|
||||||
|
_INIT_FAILED = object()
|
||||||
|
|
||||||
|
|
||||||
|
def _get_langfuse() -> Optional[Langfuse]:
|
||||||
|
"""Return a cached Langfuse client, or ``None`` if unavailable.
|
||||||
|
|
||||||
|
Activation of this plugin is controlled by the Hermes plugin system —
|
||||||
|
this function only handles the runtime-availability gate (SDK installed
|
||||||
|
+ credentials present). The result is cached: on the first call we try
|
||||||
|
to construct a client, and every subsequent call returns that client
|
||||||
|
(or fast-returns ``None`` if init failed).
|
||||||
|
"""
|
||||||
|
global _LANGFUSE_CLIENT
|
||||||
|
if _LANGFUSE_CLIENT is _INIT_FAILED:
|
||||||
|
return None
|
||||||
|
if _LANGFUSE_CLIENT is not None:
|
||||||
|
return _LANGFUSE_CLIENT
|
||||||
|
|
||||||
|
if Langfuse is None:
|
||||||
|
_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
|
||||||
|
|
||||||
|
base_url = _env("HERMES_LANGFUSE_BASE_URL") or _env("LANGFUSE_BASE_URL") or "https://cloud.langfuse.com"
|
||||||
|
environment = _env("HERMES_LANGFUSE_ENV") or _env("LANGFUSE_ENV")
|
||||||
|
release = _env("HERMES_LANGFUSE_RELEASE") or _env("LANGFUSE_RELEASE")
|
||||||
|
sample_rate = _env("HERMES_LANGFUSE_SAMPLE_RATE")
|
||||||
|
|
||||||
|
kwargs: Dict[str, Any] = {
|
||||||
|
"public_key": public_key,
|
||||||
|
"secret_key": secret_key,
|
||||||
|
"base_url": base_url,
|
||||||
|
}
|
||||||
|
if environment:
|
||||||
|
kwargs["environment"] = environment
|
||||||
|
if release:
|
||||||
|
kwargs["release"] = release
|
||||||
|
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
|
||||||
|
|
||||||
|
return _LANGFUSE_CLIENT
|
||||||
|
|
||||||
|
|
||||||
|
def _trace_key(task_id: str, session_id: str) -> str:
|
||||||
|
if task_id:
|
||||||
|
return task_id
|
||||||
|
if session_id:
|
||||||
|
return f"session:{session_id}"
|
||||||
|
return f"thread:{threading.get_ident()}"
|
||||||
|
|
||||||
|
|
||||||
|
def _truncate_text(value: str, max_chars: int) -> str:
|
||||||
|
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 "{[" or stripped[-1] not in "}]":
|
||||||
|
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)
|
||||||
|
key = hint_key if hint_key not in merged else "_trailing_text"
|
||||||
|
merged[key] = trailing
|
||||||
|
return merged
|
||||||
|
|
||||||
|
return {"data": parsed, hint_key: trailing}
|
||||||
|
|
||||||
|
|
||||||
|
def _looks_like_read_file_payload(value: Any) -> bool:
|
||||||
|
if not isinstance(value, dict):
|
||||||
|
return False
|
||||||
|
content = value.get("content")
|
||||||
|
return (
|
||||||
|
isinstance(content, str)
|
||||||
|
and "total_lines" in value
|
||||||
|
and "file_size" in value
|
||||||
|
and "is_binary" in value
|
||||||
|
and "is_image" in value
|
||||||
|
and not value.get("error")
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
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 _build_read_file_preview(lines: list[dict[str, Any]]) -> dict[str, Any]:
|
||||||
|
if len(lines) <= (_READ_FILE_HEAD_LINES + _READ_FILE_TAIL_LINES):
|
||||||
|
return {"lines": lines}
|
||||||
|
|
||||||
|
return {
|
||||||
|
"head": lines[:_READ_FILE_HEAD_LINES],
|
||||||
|
"tail": lines[-_READ_FILE_TAIL_LINES:],
|
||||||
|
"omitted_line_count": len(lines) - _READ_FILE_HEAD_LINES - _READ_FILE_TAIL_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")
|
||||||
|
offset = args.get("offset")
|
||||||
|
limit = args.get("limit")
|
||||||
|
if isinstance(path, str) and path:
|
||||||
|
normalized["path"] = path
|
||||||
|
if isinstance(offset, int):
|
||||||
|
normalized["offset"] = offset
|
||||||
|
if isinstance(limit, int):
|
||||||
|
normalized["limit"] = limit
|
||||||
|
|
||||||
|
lines = _parse_read_file_lines(value.get("content", ""))
|
||||||
|
if lines:
|
||||||
|
normalized["returned_lines"] = {
|
||||||
|
"start": lines[0]["line"],
|
||||||
|
"end": lines[-1]["line"],
|
||||||
|
"count": len(lines),
|
||||||
|
}
|
||||||
|
normalized["content_preview"] = _build_read_file_preview(lines)
|
||||||
|
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:
|
||||||
|
if _looks_like_read_file_payload(value):
|
||||||
|
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)}
|
||||||
|
if isinstance(value, str):
|
||||||
|
if parse_json_strings:
|
||||||
|
parsed = _maybe_parse_json_string(value)
|
||||||
|
if parsed is not value:
|
||||||
|
return _safe_value(parsed, max_chars=max_chars, depth=depth, parse_json_strings=True)
|
||||||
|
return _truncate_text(value, max_chars)
|
||||||
|
if isinstance(value, dict):
|
||||||
|
normalized = _normalize_payload(value)
|
||||||
|
if normalized is not value:
|
||||||
|
return _safe_value(normalized, max_chars=max_chars, depth=depth, parse_json_strings=parse_json_strings)
|
||||||
|
return {
|
||||||
|
str(k): _safe_value(v, max_chars=max_chars, depth=depth + 1, parse_json_strings=parse_json_strings)
|
||||||
|
for k, v in list(value.items())[:50]
|
||||||
|
}
|
||||||
|
if isinstance(value, (list, tuple, set)):
|
||||||
|
return [
|
||||||
|
_safe_value(v, max_chars=max_chars, depth=depth + 1, parse_json_strings=parse_json_strings)
|
||||||
|
for v in list(value)[:50]
|
||||||
|
]
|
||||||
|
if hasattr(value, "__dict__"):
|
||||||
|
return _safe_value(vars(value), max_chars=max_chars, depth=depth + 1, parse_json_strings=parse_json_strings)
|
||||||
|
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": _safe_value(message.get("content")),
|
||||||
|
}
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
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": _safe_value(
|
||||||
|
message.get("content"),
|
||||||
|
parse_json_strings=(role == "tool"),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
if role == "tool" and message.get("tool_call_id"):
|
||||||
|
item["tool_call_id"] = message.get("tool_call_id")
|
||||||
|
if message.get("tool_calls"):
|
||||||
|
item["tool_calls"] = _safe_value(message.get("tool_calls"), parse_json_strings=True)
|
||||||
|
serialized.append(item)
|
||||||
|
return serialized
|
||||||
|
|
||||||
|
|
||||||
|
def _serialize_tool_calls(tool_calls: Any) -> list[dict[str, Any]]:
|
||||||
|
if not tool_calls:
|
||||||
|
return []
|
||||||
|
serialized = []
|
||||||
|
for tool_call in tool_calls:
|
||||||
|
fn = getattr(tool_call, "function", None)
|
||||||
|
name = getattr(fn, "name", None) if fn else None
|
||||||
|
arguments = getattr(fn, "arguments", None) if fn else None
|
||||||
|
if isinstance(arguments, str):
|
||||||
|
try:
|
||||||
|
arguments = json.loads(arguments)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
serialized.append({
|
||||||
|
"id": getattr(tool_call, "id", None),
|
||||||
|
"name": name,
|
||||||
|
"arguments": _safe_value(arguments, parse_json_strings=True),
|
||||||
|
})
|
||||||
|
return serialized
|
||||||
|
|
||||||
|
|
||||||
|
def _serialize_assistant_message(message: Any) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
"content": _safe_value(getattr(message, "content", None)),
|
||||||
|
"reasoning": _safe_value(getattr(message, "reasoning", None)),
|
||||||
|
"tool_calls": _serialize_tool_calls(getattr(message, "tool_calls", None)),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _usage_and_cost(response: Any, *, provider: str, api_mode: str, model: str, base_url: str) -> tuple[dict[str, int], dict[str, float]]:
|
||||||
|
usage_details: Dict[str, int] = {}
|
||||||
|
cost_details: Dict[str, float] = {}
|
||||||
|
raw_usage = getattr(response, "usage", None)
|
||||||
|
if not raw_usage:
|
||||||
|
return usage_details, cost_details
|
||||||
|
|
||||||
|
try:
|
||||||
|
from agent.usage_pricing import estimate_usage_cost, normalize_usage
|
||||||
|
|
||||||
|
canonical = normalize_usage(raw_usage, provider=provider, api_mode=api_mode)
|
||||||
|
# Langfuse usage_details keys follow a naming convention:
|
||||||
|
# - Dashboard sums all keys containing "input" as input total
|
||||||
|
# - Dashboard sums all keys containing "output" as output total
|
||||||
|
# - If no "total" key, Langfuse derives it from all usage types
|
||||||
|
# Use Anthropic-style key names so cache tokens roll into the
|
||||||
|
# dashboard input total automatically.
|
||||||
|
# Ref: https://langfuse.com/docs/model-usage-and-cost
|
||||||
|
usage_details = {
|
||||||
|
"input": canonical.input_tokens,
|
||||||
|
"output": canonical.output_tokens,
|
||||||
|
}
|
||||||
|
if canonical.cache_read_tokens:
|
||||||
|
usage_details["cache_read_input_tokens"] = canonical.cache_read_tokens
|
||||||
|
if canonical.cache_write_tokens:
|
||||||
|
usage_details["cache_creation_input_tokens"] = canonical.cache_write_tokens
|
||||||
|
if canonical.reasoning_tokens:
|
||||||
|
usage_details["reasoning_tokens"] = canonical.reasoning_tokens
|
||||||
|
cost = estimate_usage_cost(
|
||||||
|
model,
|
||||||
|
canonical,
|
||||||
|
provider=provider,
|
||||||
|
base_url=base_url,
|
||||||
|
api_key="",
|
||||||
|
)
|
||||||
|
if cost.amount_usd is not None:
|
||||||
|
# Langfuse cost_details keys must match usage_details keys.
|
||||||
|
# Provide per-type breakdown so dashboard can show cost by type.
|
||||||
|
try:
|
||||||
|
from agent.usage_pricing import get_pricing_entry
|
||||||
|
from decimal import Decimal
|
||||||
|
_ONE_M = Decimal("1000000")
|
||||||
|
entry = get_pricing_entry(model, provider=provider, base_url=base_url)
|
||||||
|
if entry:
|
||||||
|
if entry.input_cost_per_million is not None and canonical.input_tokens:
|
||||||
|
cost_details["input"] = float(Decimal(canonical.input_tokens) * entry.input_cost_per_million / _ONE_M)
|
||||||
|
if entry.output_cost_per_million is not None and canonical.output_tokens:
|
||||||
|
cost_details["output"] = float(Decimal(canonical.output_tokens) * entry.output_cost_per_million / _ONE_M)
|
||||||
|
if entry.cache_read_cost_per_million is not None and canonical.cache_read_tokens:
|
||||||
|
cost_details["cache_read_input_tokens"] = float(Decimal(canonical.cache_read_tokens) * entry.cache_read_cost_per_million / _ONE_M)
|
||||||
|
if entry.cache_write_cost_per_million is not None and canonical.cache_write_tokens:
|
||||||
|
cost_details["cache_creation_input_tokens"] = float(Decimal(canonical.cache_write_tokens) * entry.cache_write_cost_per_million / _ONE_M)
|
||||||
|
else:
|
||||||
|
cost_details["total"] = float(cost.amount_usd)
|
||||||
|
except Exception:
|
||||||
|
cost_details["total"] = float(cost.amount_usd)
|
||||||
|
except Exception as exc: # pragma: no cover - fail-open
|
||||||
|
_debug(f"usage normalization failed: {exc}")
|
||||||
|
|
||||||
|
return usage_details, cost_details
|
||||||
|
|
||||||
|
|
||||||
|
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) -> 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,
|
||||||
|
"platform": platform,
|
||||||
|
"provider": provider,
|
||||||
|
"model": model,
|
||||||
|
"api_mode": api_mode,
|
||||||
|
}
|
||||||
|
|
||||||
|
# session_id must be passed 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
|
||||||
|
|
||||||
|
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 = client.start_as_current_observation(
|
||||||
|
trace_context=trace_ctx,
|
||||||
|
name="Hermes turn",
|
||||||
|
as_type="chain",
|
||||||
|
input=trace_input,
|
||||||
|
metadata=metadata,
|
||||||
|
end_on_exit=False,
|
||||||
|
)
|
||||||
|
root_span = root_ctx.__enter__()
|
||||||
|
except Exception:
|
||||||
|
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,
|
||||||
|
)
|
||||||
|
root_span = root_ctx.__enter__()
|
||||||
|
else:
|
||||||
|
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,
|
||||||
|
)
|
||||||
|
root_span = root_ctx.__enter__()
|
||||||
|
|
||||||
|
try:
|
||||||
|
root_span.set_trace_io(input=trace_input)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
|
_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
|
||||||
|
if metadata:
|
||||||
|
update_kwargs["metadata"] = metadata
|
||||||
|
if usage_details:
|
||||||
|
update_kwargs["usage_details"] = usage_details
|
||||||
|
if cost_details:
|
||||||
|
update_kwargs["cost_details"] = cost_details
|
||||||
|
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 _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 _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:
|
||||||
|
for observation in state.generations.values():
|
||||||
|
_end_observation(observation)
|
||||||
|
for observation in state.tools.values():
|
||||||
|
_end_observation(observation)
|
||||||
|
final_output = _merge_trace_output(output, state)
|
||||||
|
if final_output is not None:
|
||||||
|
state.root_span.set_trace_io(output=final_output)
|
||||||
|
state.root_span.update(output=final_output)
|
||||||
|
state.root_span.end()
|
||||||
|
except Exception as exc: # pragma: no cover - fail-open
|
||||||
|
_debug(f"finish trace failed: {exc}")
|
||||||
|
finally:
|
||||||
|
try:
|
||||||
|
client.flush()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def _assistant_has_tool_calls(message: Any) -> bool:
|
||||||
|
return bool(getattr(message, "tool_calls", None))
|
||||||
|
|
||||||
|
|
||||||
|
def _request_key(api_call_count: Any) -> str:
|
||||||
|
return str(api_call_count or 0)
|
||||||
|
|
||||||
|
|
||||||
|
def on_pre_llm_call(*, task_id: str = "", session_id: str = "", platform: str = "", model: str = "",
|
||||||
|
provider: str = "", base_url: str = "", api_mode: str = "",
|
||||||
|
api_call_count: int = 0, messages: Any = None, turn_type: str = "user",
|
||||||
|
conversation_history: Any = None, user_message: Any = None, **_: Any) -> None:
|
||||||
|
# Older Hermes branches used pre_llm_call for request-scoped tracing and
|
||||||
|
# passed the actual API messages. Current Hermes also has a turn-scoped
|
||||||
|
# pre_llm_call used for context injection; tracing that hook creates an
|
||||||
|
# extra orphan/root trace before the real request trace. Only trace the
|
||||||
|
# legacy request-shaped call here.
|
||||||
|
if not isinstance(messages, list):
|
||||||
|
return
|
||||||
|
|
||||||
|
client = _get_langfuse()
|
||||||
|
if client is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
# messages is a list only for legacy Hermes branches that fired
|
||||||
|
# pre_llm_call with API messages directly. Current Hermes fires
|
||||||
|
# pre_llm_call for context injection (conversation_history/user_message,
|
||||||
|
# no messages list) — tracing that would create orphan traces.
|
||||||
|
task_key = _trace_key(task_id, session_id)
|
||||||
|
|
||||||
|
with _STATE_LOCK:
|
||||||
|
state = _TRACE_STATE.get(task_key)
|
||||||
|
if state is None:
|
||||||
|
state = _start_root_trace(
|
||||||
|
task_key,
|
||||||
|
task_id=task_id,
|
||||||
|
session_id=session_id,
|
||||||
|
platform=platform,
|
||||||
|
provider=provider,
|
||||||
|
model=model,
|
||||||
|
api_mode=api_mode,
|
||||||
|
messages=messages,
|
||||||
|
client=client,
|
||||||
|
)
|
||||||
|
_TRACE_STATE[task_key] = state
|
||||||
|
state.last_updated_at = time.time()
|
||||||
|
|
||||||
|
|
||||||
|
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,
|
||||||
|
messages: Any = None,
|
||||||
|
turn_type: str = "user",
|
||||||
|
message_count: int = 0,
|
||||||
|
tool_count: int = 0,
|
||||||
|
approx_input_tokens: int = 0,
|
||||||
|
request_char_count: int = 0,
|
||||||
|
max_tokens: Any = None,
|
||||||
|
**_: Any,
|
||||||
|
) -> None:
|
||||||
|
client = _get_langfuse()
|
||||||
|
if client is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
task_key = _trace_key(task_id, session_id)
|
||||||
|
req_key = _request_key(api_call_count)
|
||||||
|
|
||||||
|
with _STATE_LOCK:
|
||||||
|
state = _TRACE_STATE.get(task_key)
|
||||||
|
if state is None:
|
||||||
|
state = _start_root_trace(
|
||||||
|
task_key,
|
||||||
|
task_id=task_id,
|
||||||
|
session_id=session_id,
|
||||||
|
platform=platform,
|
||||||
|
provider=provider,
|
||||||
|
model=model,
|
||||||
|
api_mode=api_mode,
|
||||||
|
messages=messages,
|
||||||
|
client=client,
|
||||||
|
)
|
||||||
|
_TRACE_STATE[task_key] = state
|
||||||
|
state.last_updated_at = time.time()
|
||||||
|
previous = state.generations.pop(req_key, None)
|
||||||
|
if previous is not None:
|
||||||
|
_end_observation(previous)
|
||||||
|
state.generations[req_key] = _start_child_observation(
|
||||||
|
state,
|
||||||
|
client=client,
|
||||||
|
name=f"LLM call {api_call_count}",
|
||||||
|
as_type="generation",
|
||||||
|
input_value=_serialize_messages(messages),
|
||||||
|
metadata={
|
||||||
|
"provider": provider,
|
||||||
|
"platform": platform,
|
||||||
|
"api_mode": api_mode,
|
||||||
|
"base_url": base_url,
|
||||||
|
},
|
||||||
|
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,
|
||||||
|
**_: Any) -> None:
|
||||||
|
client = _get_langfuse()
|
||||||
|
if client is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
task_key = _trace_key(task_id, session_id)
|
||||||
|
req_key = _request_key(api_call_count)
|
||||||
|
|
||||||
|
with _STATE_LOCK:
|
||||||
|
state = _TRACE_STATE.get(task_key)
|
||||||
|
generation = state.generations.pop(req_key, None) if state else None
|
||||||
|
if state is None or generation is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Handle both call patterns:
|
||||||
|
# 1. post_api_request: passes usage (dict), assistant_content_chars, assistant_tool_call_count
|
||||||
|
# 2. post_llm_call: passes assistant_message (object), response (object), assistant_response (str)
|
||||||
|
if assistant_message is not None:
|
||||||
|
output = _serialize_assistant_message(assistant_message)
|
||||||
|
elif assistant_response is not None:
|
||||||
|
# post_llm_call passes assistant_response as a plain string
|
||||||
|
output = {"content": _safe_value(assistant_response), "reasoning": None, "tool_calls": []}
|
||||||
|
else:
|
||||||
|
# post_api_request path — reconstruct from summary kwargs
|
||||||
|
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"])
|
||||||
|
|
||||||
|
# Extract usage: prefer response object, fall back to usage dict from post_api_request
|
||||||
|
if response 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:
|
||||||
|
# post_api_request passes a pre-built CanonicalUsage summary dict.
|
||||||
|
# Use Langfuse-convention key names: "input", "output", and
|
||||||
|
# "cache_read_input_tokens" / "cache_creation_input_tokens" so the
|
||||||
|
# dashboard sums cache tokens into the input total automatically.
|
||||||
|
_input = usage.get("input_tokens", 0)
|
||||||
|
_output = usage.get("output_tokens", 0) or usage.get("completion_tokens", 0)
|
||||||
|
_cache_read = usage.get("cache_read_tokens", 0)
|
||||||
|
_cache_write = usage.get("cache_write_tokens", 0)
|
||||||
|
_reasoning = usage.get("reasoning_tokens", 0)
|
||||||
|
usage_details = {
|
||||||
|
"input": _input,
|
||||||
|
"output": _output,
|
||||||
|
}
|
||||||
|
if _cache_read:
|
||||||
|
usage_details["cache_read_input_tokens"] = _cache_read
|
||||||
|
if _cache_write:
|
||||||
|
usage_details["cache_creation_input_tokens"] = _cache_write
|
||||||
|
if _reasoning:
|
||||||
|
usage_details["reasoning_tokens"] = _reasoning
|
||||||
|
cost_details = {}
|
||||||
|
# Estimate per-type cost from the summary if possible
|
||||||
|
try:
|
||||||
|
from agent.usage_pricing import CanonicalUsage, estimate_usage_cost, get_pricing_entry
|
||||||
|
from decimal import Decimal
|
||||||
|
_ONE_M = Decimal("1000000")
|
||||||
|
_cu = CanonicalUsage(
|
||||||
|
input_tokens=_input,
|
||||||
|
output_tokens=_output,
|
||||||
|
cache_read_tokens=_cache_read,
|
||||||
|
cache_write_tokens=_cache_write,
|
||||||
|
reasoning_tokens=_reasoning,
|
||||||
|
)
|
||||||
|
entry = get_pricing_entry(model, provider=provider, base_url=base_url)
|
||||||
|
if entry:
|
||||||
|
if entry.input_cost_per_million is not None and _input:
|
||||||
|
cost_details["input"] = float(Decimal(_input) * entry.input_cost_per_million / _ONE_M)
|
||||||
|
if entry.output_cost_per_million is not None and _output:
|
||||||
|
cost_details["output"] = float(Decimal(_output) * entry.output_cost_per_million / _ONE_M)
|
||||||
|
if entry.cache_read_cost_per_million is not None and _cache_read:
|
||||||
|
cost_details["cache_read_input_tokens"] = float(Decimal(_cache_read) * entry.cache_read_cost_per_million / _ONE_M)
|
||||||
|
if entry.cache_write_cost_per_million is not None and _cache_write:
|
||||||
|
cost_details["cache_creation_input_tokens"] = float(Decimal(_cache_write) * entry.cache_write_cost_per_million / _ONE_M)
|
||||||
|
else:
|
||||||
|
_cost = estimate_usage_cost(model, _cu, provider=provider, base_url=base_url, api_key="")
|
||||||
|
if _cost.amount_usd is not None:
|
||||||
|
cost_details["total"] = float(_cost.amount_usd)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
usage_details, cost_details = {}, {}
|
||||||
|
|
||||||
|
tool_count = len(output.get("tool_calls", [])) or assistant_tool_call_count
|
||||||
|
gen_metadata: Dict[str, Any] = {"tool_call_count": tool_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 = _assistant_has_tool_calls(assistant_message) if assistant_message else (assistant_tool_call_count > 0)
|
||||||
|
has_content = bool(output.get("content"))
|
||||||
|
if not has_tools and has_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 = "", **_: Any) -> None:
|
||||||
|
client = _get_langfuse()
|
||||||
|
if client is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
task_key = _trace_key(task_id, session_id)
|
||||||
|
tool_key = tool_call_id or f"{tool_name}:{time.time_ns()}"
|
||||||
|
|
||||||
|
with _STATE_LOCK:
|
||||||
|
state = _TRACE_STATE.get(task_key)
|
||||||
|
if state is None:
|
||||||
|
return
|
||||||
|
state.tools[tool_key] = _start_child_observation(
|
||||||
|
state,
|
||||||
|
client=client,
|
||||||
|
name=f"Tool: {tool_name}",
|
||||||
|
as_type="tool",
|
||||||
|
input_value=_safe_value(args),
|
||||||
|
metadata={"tool_name": tool_name, "tool_call_id": tool_call_id},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def on_post_tool_call(*, tool_name: str = "", args: Any = None, result: Any = None,
|
||||||
|
task_id: str = "", session_id: str = "", tool_call_id: str = "", **_: Any) -> None:
|
||||||
|
task_key = _trace_key(task_id, session_id)
|
||||||
|
tool_key = tool_call_id or ""
|
||||||
|
observation = None
|
||||||
|
|
||||||
|
with _STATE_LOCK:
|
||||||
|
state = _TRACE_STATE.get(task_key)
|
||||||
|
if state is None:
|
||||||
|
return
|
||||||
|
if tool_key:
|
||||||
|
observation = state.tools.pop(tool_key, None)
|
||||||
|
elif state.tools:
|
||||||
|
_, observation = state.tools.popitem()
|
||||||
|
|
||||||
|
if observation is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
if isinstance(result, str):
|
||||||
|
result_value = _maybe_parse_json_string(result)
|
||||||
|
else:
|
||||||
|
result_value = result
|
||||||
|
result_value = _normalize_payload(result_value, tool_name=tool_name, args=args)
|
||||||
|
|
||||||
|
_end_observation(
|
||||||
|
observation,
|
||||||
|
output=_safe_value(result_value, parse_json_strings=True),
|
||||||
|
metadata={"tool_name": tool_name, "args": _safe_value(args, parse_json_strings=True)},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def register(ctx) -> None:
|
||||||
|
# Register for both hook name variants so the plugin works across
|
||||||
|
# Hermes versions. pre_api_request / post_api_request fire per API
|
||||||
|
# call (preferred); pre_llm_call / post_llm_call fire 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("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)
|
||||||
14
plugins/observability/langfuse/plugin.yaml
Normal file
14
plugins/observability/langfuse/plugin.yaml
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
name: langfuse
|
||||||
|
version: "1.0.0"
|
||||||
|
description: "Optional Langfuse observability for Hermes — traces conversations, LLM calls, and tool usage. Opt-in via `hermes plugins enable observability/langfuse` or `hermes tools → Langfuse Observability`."
|
||||||
|
author: NousResearch
|
||||||
|
requires_env:
|
||||||
|
- HERMES_LANGFUSE_PUBLIC_KEY
|
||||||
|
- HERMES_LANGFUSE_SECRET_KEY
|
||||||
|
hooks:
|
||||||
|
- pre_api_request
|
||||||
|
- post_api_request
|
||||||
|
- pre_llm_call
|
||||||
|
- post_llm_call
|
||||||
|
- pre_tool_call
|
||||||
|
- post_tool_call
|
||||||
170
tests/plugins/test_langfuse_plugin.py
Normal file
170
tests/plugins/test_langfuse_plugin.py
Normal file
|
|
@ -0,0 +1,170 @@
|
||||||
|
"""Tests for the bundled observability/langfuse plugin."""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import importlib
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
import yaml
|
||||||
|
|
||||||
|
|
||||||
|
REPO_ROOT = Path(__file__).resolve().parents[2]
|
||||||
|
PLUGIN_DIR = REPO_ROOT / "plugins" / "observability" / "langfuse"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Manifest + layout
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class TestManifest:
|
||||||
|
def test_plugin_directory_exists(self):
|
||||||
|
assert PLUGIN_DIR.is_dir()
|
||||||
|
assert (PLUGIN_DIR / "plugin.yaml").exists()
|
||||||
|
assert (PLUGIN_DIR / "__init__.py").exists()
|
||||||
|
|
||||||
|
def test_manifest_fields(self):
|
||||||
|
data = yaml.safe_load((PLUGIN_DIR / "plugin.yaml").read_text())
|
||||||
|
assert data["name"] == "langfuse"
|
||||||
|
assert data["version"]
|
||||||
|
# All six hooks the plugin implements.
|
||||||
|
assert set(data["hooks"]) == {
|
||||||
|
"pre_api_request", "post_api_request",
|
||||||
|
"pre_llm_call", "post_llm_call",
|
||||||
|
"pre_tool_call", "post_tool_call",
|
||||||
|
}
|
||||||
|
# Required env vars are the user-facing HERMES_ prefixed keys.
|
||||||
|
assert "HERMES_LANGFUSE_PUBLIC_KEY" in data["requires_env"]
|
||||||
|
assert "HERMES_LANGFUSE_SECRET_KEY" in data["requires_env"]
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Plugin discovery: langfuse is opt-in (not loaded unless explicitly enabled).
|
||||||
|
# This guards against someone accidentally re-introducing a per-hook
|
||||||
|
# load_config() gate or making the plugin auto-load.
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class TestDiscovery:
|
||||||
|
def test_plugin_is_discovered_as_standalone_opt_in(self, tmp_path, monkeypatch):
|
||||||
|
"""Scanner should find the plugin but NOT load it by default."""
|
||||||
|
from hermes_cli import plugins as plugins_mod
|
||||||
|
|
||||||
|
# Isolated HERMES_HOME so we don't read the developer's config.yaml.
|
||||||
|
home = tmp_path / ".hermes"
|
||||||
|
home.mkdir()
|
||||||
|
monkeypatch.setenv("HERMES_HOME", str(home))
|
||||||
|
monkeypatch.setattr(Path, "home", lambda: tmp_path)
|
||||||
|
|
||||||
|
manager = plugins_mod.PluginManager()
|
||||||
|
manager.discover_and_load()
|
||||||
|
|
||||||
|
# observability/langfuse appears in the plugin registry …
|
||||||
|
loaded = manager._plugins.get("observability/langfuse")
|
||||||
|
assert loaded is not None, "plugin not discovered"
|
||||||
|
# … but is not loaded (opt-in default → no config.yaml means nothing enabled)
|
||||||
|
assert loaded.enabled is False
|
||||||
|
assert "not enabled" in (loaded.error or "").lower()
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Runtime gate: _get_langfuse() returns None and caches _INIT_FAILED when
|
||||||
|
# credentials are missing. Guards against regressing toward the rejected
|
||||||
|
# per-hook load_config() design.
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class TestRuntimeGate:
|
||||||
|
def _fresh_plugin(self):
|
||||||
|
"""Import the plugin module fresh (clears any cached client)."""
|
||||||
|
mod_name = "plugins.observability.langfuse"
|
||||||
|
sys.modules.pop(mod_name, None)
|
||||||
|
return importlib.import_module(mod_name)
|
||||||
|
|
||||||
|
def test_get_langfuse_returns_none_without_credentials(self, monkeypatch):
|
||||||
|
for k in (
|
||||||
|
"HERMES_LANGFUSE_PUBLIC_KEY", "HERMES_LANGFUSE_SECRET_KEY",
|
||||||
|
"LANGFUSE_PUBLIC_KEY", "LANGFUSE_SECRET_KEY",
|
||||||
|
):
|
||||||
|
monkeypatch.delenv(k, raising=False)
|
||||||
|
|
||||||
|
langfuse_plugin = self._fresh_plugin()
|
||||||
|
assert langfuse_plugin._get_langfuse() is None
|
||||||
|
|
||||||
|
def test_get_langfuse_caches_failure_no_config_load(self, monkeypatch):
|
||||||
|
"""A miss must be cached — no per-hook config.yaml reads, no env re-reads."""
|
||||||
|
for k in (
|
||||||
|
"HERMES_LANGFUSE_PUBLIC_KEY", "HERMES_LANGFUSE_SECRET_KEY",
|
||||||
|
"LANGFUSE_PUBLIC_KEY", "LANGFUSE_SECRET_KEY",
|
||||||
|
):
|
||||||
|
monkeypatch.delenv(k, raising=False)
|
||||||
|
|
||||||
|
langfuse_plugin = self._fresh_plugin()
|
||||||
|
|
||||||
|
# Prime the cache with one call.
|
||||||
|
assert langfuse_plugin._get_langfuse() is None
|
||||||
|
|
||||||
|
# Now block os.environ.get — a correctly-cached plugin must not
|
||||||
|
# touch env again.
|
||||||
|
import os
|
||||||
|
called = {"n": 0}
|
||||||
|
real_get = os.environ.get
|
||||||
|
|
||||||
|
def tracking_get(key, default=None):
|
||||||
|
if key.startswith(("HERMES_LANGFUSE_", "LANGFUSE_")):
|
||||||
|
called["n"] += 1
|
||||||
|
return real_get(key, default)
|
||||||
|
|
||||||
|
monkeypatch.setattr(os.environ, "get", tracking_get)
|
||||||
|
|
||||||
|
for _ in range(20):
|
||||||
|
assert langfuse_plugin._get_langfuse() is None
|
||||||
|
|
||||||
|
assert called["n"] == 0, (
|
||||||
|
f"_get_langfuse() re-read env {called['n']} times after cache miss — "
|
||||||
|
"it should short-circuit via _INIT_FAILED"
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_get_langfuse_does_not_import_hermes_config(self, monkeypatch):
|
||||||
|
"""The plugin must not re-read config.yaml per hook."""
|
||||||
|
for k in (
|
||||||
|
"HERMES_LANGFUSE_PUBLIC_KEY", "HERMES_LANGFUSE_SECRET_KEY",
|
||||||
|
"LANGFUSE_PUBLIC_KEY", "LANGFUSE_SECRET_KEY",
|
||||||
|
):
|
||||||
|
monkeypatch.delenv(k, raising=False)
|
||||||
|
|
||||||
|
# Drop any cached import of hermes_cli.config.
|
||||||
|
sys.modules.pop("hermes_cli.config", None)
|
||||||
|
|
||||||
|
langfuse_plugin = self._fresh_plugin()
|
||||||
|
for _ in range(20):
|
||||||
|
langfuse_plugin._get_langfuse()
|
||||||
|
|
||||||
|
assert "hermes_cli.config" not in sys.modules, (
|
||||||
|
"langfuse plugin imported hermes_cli.config — regression toward "
|
||||||
|
"the rejected per-hook load_config() design"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Hooks are inert when the client is unavailable.
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class TestHooksInert:
|
||||||
|
def test_hooks_noop_without_client(self, monkeypatch):
|
||||||
|
"""All 6 hooks must return without raising when _get_langfuse() is None."""
|
||||||
|
for k in (
|
||||||
|
"HERMES_LANGFUSE_PUBLIC_KEY", "HERMES_LANGFUSE_SECRET_KEY",
|
||||||
|
"LANGFUSE_PUBLIC_KEY", "LANGFUSE_SECRET_KEY",
|
||||||
|
):
|
||||||
|
monkeypatch.delenv(k, raising=False)
|
||||||
|
|
||||||
|
sys.modules.pop("plugins.observability.langfuse", None)
|
||||||
|
import importlib
|
||||||
|
mod = importlib.import_module("plugins.observability.langfuse")
|
||||||
|
|
||||||
|
# Each hook should just return; no exceptions.
|
||||||
|
mod.on_pre_llm_call(task_id="t", session_id="s", messages=[{"role": "user", "content": "hi"}])
|
||||||
|
mod.on_pre_llm_request(task_id="t", session_id="s", api_call_count=1, messages=[])
|
||||||
|
mod.on_post_llm_call(task_id="t", session_id="s", api_call_count=1)
|
||||||
|
mod.on_pre_tool_call(tool_name="read_file", args={}, task_id="t", session_id="s")
|
||||||
|
mod.on_post_tool_call(tool_name="read_file", args={}, result="ok", task_id="t", session_id="s")
|
||||||
Loading…
Add table
Add a link
Reference in a new issue