neatlogs-py-hermes

Use when adding neatlogs observability to a Python project that uses the Hermes agent (NousResearch/hermes-agent) as a LIBRARY — i.e. it imports `run_agent` / constructs `AIAgent(...)` in its own code

SKILL.md

GitHub

Neatlogs Python Setup — Hermes (library mode)

This project uses Hermes (from run_agent import AIAgent) as a library in its own Python code. Neatlogs instruments it with the hermes instrumentation (plus openai), enabled in neatlogs.init(...).

Are they running the standalone hermes CLI instead of writing Python? Then this skill does NOT apply — there's no source to add init() to. Use the observer plugin instead: pip install neatlogs and hermes plugins enable neatlogs (it traces the CLI/gateway with zero code). This skill is only for code that imports run_agent/AIAgent.

Core mechanism — neatlogs.init(instrumentations=["hermes"])

The hermes instrumentor patches AIAgent.run_conversation (an AGENT span) and ToolRegistry.dispatch (a TOOL span per tool call). Hermes' LLM calls go through the openai SDK (pointed at OpenRouter) — and "hermes" auto-loads openai for the LLM spans, so you only list "hermes". Span tree:

AGENT  hermes.run_conversation   (one agentic run)
  ↳ LLM   chat.completions.create  (via openai → OpenRouter)
  ↳ TOOL  hermes.tool.<name>       (each tool dispatch)

wrap() is an optional equivalent (agent = neatlogs.wrap(AIAgent(...))) — it's the same class-level patch, so prefer the instrumentations=[...] form.

Steps

  1. Install → references/1-install.md
  2. Add init() BEFORE importing run_agent → references/2-add-init.md
  3. Set environment variables → references/3-set-env.md
  4. Run the agent (no per-call changes needed) → references/4-run-agent.md
  5. Add @span / trace / log to your orchestration → references/5-spans-trace-log.md
  6. Lifecycle (flush/shutdown) → references/6-flush-shutdown.md

Rules (apply to ALL steps)

  • neatlogs.init(instrumentations=["hermes"]) MUST run BEFORE from run_agent import AIAgent — the instrumentor patches the class at import time, so a later init misses it. load_dotenv() runs before init(). ("hermes" auto-loads openai for the LLM spans — no need to add it yourself.)
  • Hermes isn't on PyPI — it's git-installed (see step 1).
  • Hermes routes LLM calls through OpenRouter by default; if you use a non-OpenAI provider adapter (anthropic / bedrock / gemini), add that provider to the instrumentations list too (e.g. ["hermes", "anthropic"]).
  • The Hermes instrumentor and its selected provider instrumentor own the AGENT, TOOL, and LLM spans. Do NOT add manual LLM/tool decorators or wrap the same provider client again. Manual spans are only for app-owned surrounding orchestration or unsupported calls outside Hermes.
  • Never hardcode API keys — use os.getenv().
  • For EU projects, set endpoint="https://eu.ingest.neatlogs.com" in neatlogs.init(); for other managed projects, omit endpoint and NEATLOGS_ENDPOINT.
  • import neatlogs at module top level.

Safety gate

Before any edit, confirm this service is Python. Identify the active interpreter and package manager from its manifests and lockfiles, then read the declared and installed SDK version. Do not install or change dependencies during this inspection. Run Doctor through the active interpreter so it can use only the installed SDK:

python -m neatlogs doctor --local --json

Do not substitute npx, uvx, pipx run, a Wizard command, or another downloaded Doctor. Local mode must be read-only and network-free. It requires no credential and must not change source or configuration. Require format_version: "neatlogs.doctor/v2", runtime.language: "python", and runtime.schema_version: "2". Treat runtime.sdk_version as evidence of the installed package, not as an exact-version allowlist.

If the command is missing or its result has the wrong format, language, or schema, fail closed. Check the canonical package registry for the latest published stable release. If the project uses an older release, show the exact upgrade command for the detected package manager and obtain explicit user approval before running it. Accept newer compatible releases and never downgrade one. If the installed release is already current but lacks Doctor v2, stop and give safe manual/support remediation. Rerun local Doctor after any approved upgrade. Do not edit while this gate is unresolved.

A local pass proves only that the installed SDK produced and validated its controlled in-process envelope. It does not prove that the application is instrumented, that anything was exported, or that a hosted trace is visible. Preserve every reason_code and remediation_code exactly. Treat a warning, failure, or unknown future code as manual/support remediation unless the code is explicitly safe/fixable here. The only source fixes allowed by this gate are:

  • INSTRUMENTOR_INACTIVE: apply only this skill's documented initialization or wrapper step.
  • ROOT_MISSING: add only the already-requested, documented WORKFLOW boundary at a confirmed entry point.
  • ROOT_NOT_ENDED: add only this skill's documented lifecycle hook.

Do not edit for credential, authentication, transport, backend, ambiguous ownership, or unknown codes. Never reproduce backend PII, routing, mapping, or finalization implementation. Before any build, test, or user-workflow command, show the exact command and obtain explicit user approval. Make reruns idempotent: reread the target first and never duplicate initialization, wrappers, roots, or shutdown hooks. Keep a pre-edit diff. If an approved check fails, use the rollback plan to revert only the edits from this run when they can be isolated safely. Otherwise, stop and give manual recovery instructions that preserve unrelated user work.

After instrumentation, obtain approval for the project checks and one representative real workflow. Obtain separate approval for the authenticated probe. Use only a credential already supplied through the process environment. Never print it, place it in command arguments or files, copy it into output, or put it in agent context.

python -m neatlogs doctor --probe --json

Probe mode sends one controlled four-span trace through POST /v1/traces with x-neatlogs-doctor: v1, then reads that exact trace through GET /api/traces/v3/{trace_id} with the same project credential. Accept a probe pass only when capture and readback trace IDs match, the trace is finalized, exactly four spans contain one meaningful WORKFLOW root with AGENT→LLM and root→TOOL relationships, there are no duplicates, required semantics and I/O are present, and token values remain numeric. Never infer success from installation, local logs, exporter flush, HTTP 2xx, or any uncorrelated trace. Probe success proves the controlled path only. Verify the real user workflow separately through the completion gate below.

Completion gate

After local Doctor passes and the requested instrumentation is in place:

  1. Show the exact project build, test, and real-workflow commands and obtain explicit user approval before running them.
  2. Run only the approved checks. Restart a long-running process so it loads the new initialization and wrappers; keep reruns idempotent.
  3. Exercise one representative real user workflow. End every opened span and use the documented flush/shutdown lifecycle for that process type.
  4. Through the target project's normal product trace view or supported public read path, verify that exact run is finalized, has one meaningful root and the expected semantic hierarchy, and contains no duplicate operation spans.

Keep project credentials in the process environment or client secret storage; never put them in commands, output, files, or agent context. Do not use a legacy marker-discovery protocol. Installation, local logs, exporter flush, HTTP 2xx, a local Doctor pass, and a separate probe pass are not proof that the application's real workflow is correct. If the exact user trace cannot be inspected, report the missing access or observation as a blocker and provide rollback/manual recovery instructions without claiming completion.

Reference

  • Combining the instrumentation with @span/trace/log → references/5-spans-trace-log.md
  • Sessions & end-users (group a conversation's runs, attribute to a customer) → references/sessions-and-end-users.md
  • Span kinds reference → references/span-kinds.md