mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-07-10 11:47:46 +08:00
ccfa079252
Add a built-in telemetry system that records what the agent does — workflows,
model calls, tool calls, errors — to the local machine, powers `/insights`, and
can export to an operator-chosen destination. Default-on locally; nothing leaves
the machine unless the user exports it or opts into the aggregate plane.
Three planes with a hard wall between them:
- local: full-fidelity observability (real model/provider/tool names), on by
default, never leaves the machine.
- aggregate: opt-in metadata, default off. No uploader ships — consent is
recorded via telemetry.consent_state, and `preview` shows what would be
produced, computed locally.
- trajectories: full message content, opt-in, exported only to the operator's
own destination.
Mechanism:
- Bundled `telemetry` plugin registers observational lifecycle hooks
(on_session_start / post_api_request / post_tool_call / on_session_finalize).
No core call sites are edited; hooks already carry the data.
- Fire-and-forget emitter: emit() returns in microseconds, never blocks or
raises into a model/tool call. A daemon thread writes events to an
append-only JSONL log and the tel_* tables in state.db (its own sqlite
connection, separate from SessionDB).
- tel_runs / tel_model_calls / tel_tool_calls live in the declarative
SCHEMA_SQL and are reconciled automatically; SCHEMA_VERSION 16 -> 17.
- metrics derives rollups for /usage and /insights; rollup builds per-run
summaries for `hermes telemetry preview`.
Consent is config, not a parallel command surface. The config file is the root
of trust: set telemetry.consent_state with `hermes config set`, or pin any
telemetry.* key (including allow_aggregate) via managed scope, which overrides
the user's value per key. `hermes telemetry` exposes only what config cannot:
status (report), preview (query), and export.
Export:
- exporter_bulk writes telemetry (and, when the trajectories plane is enabled,
session content) to ndjson/json.
- otlp_exporter streams spans to a configured OpenTelemetry Collector over
OTLP/HTTP. The SDK is an optional extra (hermes-agent[otlp]), lazily
installed via tools.lazy_deps on first use.
- Secrets are always redacted on every export path
(redact_sensitive_text(force=True)); content export is gated by the
trajectories plane, and PII scrubbing follows telemetry.content_redaction.
OTLP auth headers reference environment variable names, never inline values.
No outbound emission to Nous. The aggregate uploader is intentionally not built.
95 lines
3.2 KiB
Python
95 lines
3.2 KiB
Python
"""`hermes telemetry` handler smoke tests (local-only; no upload)."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import sqlite3
|
|
import time
|
|
import types
|
|
|
|
import pytest
|
|
|
|
import hermes_state
|
|
|
|
|
|
@pytest.fixture
|
|
def home(tmp_path, monkeypatch):
|
|
monkeypatch.setenv("HERMES_HOME", str(tmp_path))
|
|
# state.db with tel_* + seeded data
|
|
db = tmp_path / "state.db"
|
|
hermes_state.SessionDB(db_path=db)
|
|
from agent.telemetry.emitter import TelemetryEmitter
|
|
from agent.telemetry.events import RunEvent, ModelCallEvent, ToolCallEvent
|
|
em = TelemetryEmitter(events_path=tmp_path / "telemetry" / "e.jsonl", db_path=db)
|
|
now = time.time_ns()
|
|
em.emit(RunEvent(run_id="r1", trace_id="t1", entrypoint="cli", end_reason="completed",
|
|
start_ns=now - 60_000_000, end_ns=now, model_call_count=1,
|
|
tool_call_count=1, estimated_cost_usd=0.3))
|
|
em.emit(ModelCallEvent(span_id="m1", run_id="r1", provider="anthropic",
|
|
model="claude-opus-4",
|
|
input_tokens=20000, output_tokens=2000))
|
|
em.emit(ToolCallEvent(span_id="w1", run_id="r1", tool_name="web_search",
|
|
result_class="ok"))
|
|
em.flush()
|
|
em.close()
|
|
yield tmp_path
|
|
|
|
|
|
def _run(action, **kw):
|
|
from hermes_cli.main import cmd_telemetry
|
|
args = types.SimpleNamespace(telemetry_action=action, days=30, limit=10, json=False)
|
|
for k, v in kw.items():
|
|
setattr(args, k, v)
|
|
cmd_telemetry(args)
|
|
|
|
|
|
def test_status_runs(home, capsys):
|
|
_run("status")
|
|
out = capsys.readouterr().out
|
|
assert "Telemetry status" in out
|
|
assert "Upload:" in out and "DISABLED" in out
|
|
assert "Local data:" in out
|
|
|
|
|
|
def test_preview_shows_real_values(home, capsys):
|
|
_run("preview")
|
|
out = capsys.readouterr().out
|
|
assert "NOT uploaded" in out
|
|
assert "workflow_completed" in out
|
|
# real model + tool names ARE shown (this is the user's own local data)
|
|
assert "claude-opus-4" in out
|
|
assert "web_search" in out
|
|
|
|
|
|
def test_status_reflects_consent_set_via_config(home, capsys):
|
|
# Opting in is a plain config write now (no `enable` verb). status should
|
|
# reflect consent_state=aggregate as the aggregate plane being on.
|
|
from hermes_cli.config import load_config, save_config
|
|
cfg = load_config()
|
|
cfg.setdefault("telemetry", {})["consent_state"] = "aggregate"
|
|
save_config(cfg)
|
|
_run("status")
|
|
out = capsys.readouterr().out
|
|
assert "consent_state=aggregate" in out
|
|
assert "Aggregate plane: on" in out
|
|
|
|
|
|
def test_status_shows_optin_hint_when_unknown(home, capsys):
|
|
_run("status")
|
|
out = capsys.readouterr().out
|
|
assert "Aggregate plane: off" in out
|
|
assert "config set telemetry.consent_state aggregate" in out
|
|
|
|
|
|
def test_allow_aggregate_false_keeps_plane_off_in_status(home, capsys):
|
|
# Even with consent opted in, a managed allow_aggregate:false wins.
|
|
from hermes_cli.config import load_config, save_config
|
|
cfg = load_config()
|
|
tel = cfg.setdefault("telemetry", {})
|
|
tel["consent_state"] = "aggregate"
|
|
tel["allow_aggregate"] = False
|
|
save_config(cfg)
|
|
_run("status")
|
|
out = capsys.readouterr().out
|
|
assert "Aggregate plane: off" in out
|
|
assert "allow_aggregate is false" in out
|