Agentic Ledger
Runtime observability for AI agents - see exactly what your agent did, why it did it, and what it cost.
Website: agentic-ledger.dev
The numbers are meant to match your provider bill. If they don't, that's a bug we want.
Works with any agent framework, any LLM provider, any model gateway. Zero code changes required. Point your agent at the proxy and everything is captured automatically.
How it works
Agentic Ledger runs as a transparent proxy between your agent and the LLM provider. It intercepts every request and response, assigns it an action_id, stores it, and returns the upstream response unmodified. Your agent never knows the proxy is there. The full picture, with
diagrams and a module map for contributors, lives in
ARCHITECTURE.md.
Your Agent → Agentic Ledger Proxy → OpenAI / Anthropic / LiteLLM / any LLM
↓
SQLite or Postgres
↓
Live Dashboard + API
Quick Start
Step 1 - Start the proxy
Coming from Helicone or LangSmith? The migration page does the translation in two lines. Running a context compressor like Headroom? They chain.
Two commands, zero config, no terminal held hostage:
uv tool install agentic-ledger # or: pipx install agentic-ledger, or pip install -U agentic-ledger
agenticledger start # runs in the background; terminal freed
A tool-managed install (uv tool / pipx) gets its own isolated
environment and one unambiguous shim on PATH, so shadowing by another
Python's copy becomes rare and doctor-detectable, and agenticledger upgrade always means exactly one thing. Plain pip works too; if a machine ever grows
competing installs, agenticledger doctor --fix untangles them.
agenticledger start prints the dashboard URL and gives your terminal
back - closing the window doesn't stop it. agenticledger status tells
you it's up and healthy, agenticledger logs shows what it's doing,
agenticledger stop shuts it down. Want a config file anyway?
agenticledger init writes a commented one; see
Configuration for what goes in it.
Or with Docker (no Python required):
docker run -p 8000:8000 \
-e AGENTICLEDGER_UPSTREAM_URL=https://api.openai.com \ # optional: omit to route by call format
-v $(pwd)/data:/data \
ghcr.io/shekharbhardwaj/agentic-ledger:latest
The image is multi-arch (amd64/arm64), runs as a non-root user, and every release is signed with Sigstore and ships an SBOM. Hardening a shared deployment (TLS, auth keys, redaction, verification)? See the deployment guide.
Using Anthropic / Claude? Nothing to configure: with no upstream set, the proxy routes each call by its wire format, so Anthropic-style calls go to Anthropic and OpenAI-style calls go to OpenAI, side by side through one proxy. Setting an explicit
upstream_url(a gateway like LiteLLM or OpenRouter, LM Studio, or a pinned provider) switches to the classic one-proxy-one-provider behavior, mismatch hints included.
Or with docker compose (SQLite by default - see docker-compose.yml):
AGENTICLEDGER_UPSTREAM_URL=https://api.openai.com docker compose up
For Postgres, layer the override; it swaps the DSN and adds the database service, and the image ships the driver:
docker compose -f docker-compose.yml -f docker-compose.postgres.yml up
With uv:
uv add agentic-ledger
AGENTICLEDGER_UPSTREAM_URL=https://api.openai.com uv run python -m agenticledger.proxy
With pip:
python -m venv venv && source venv/bin/activate
pip install -U agentic-ledger
AGENTICLEDGER_UPSTREAM_URL=https://api.openai.com ./venv/bin/python -m agenticledger.proxy
Postgres? Install the extra and set
AGENTICLEDGER_DSN:pip install "agentic-ledger[postgres]" AGENTICLEDGER_DSN=postgresql://user:password@localhost/agenticledgerNote: the Docker image uses SQLite only. For Postgres with Docker, install via
pipinstead.
OpenTelemetry? Install the extra and set
AGENTICLEDGER_OTEL_ENDPOINT:pip install "agentic-ledger[otel]" AGENTICLEDGER_OTEL_ENDPOINT=http://localhost:4318
Proxy starts on http://localhost:8000. Traces are saved to ~/.agenticledger/agenticledger.db when started with agenticledger start (one home for the background service, wherever you launched it from), to agenticledger.db in the current folder when run in the foreground (agenticledger serve / python -m agenticledger.proxy), or to /data/agenticledger.db in Docker.
Step 2 - Point your agent at the proxy
For Claude Code, BMAD, or OpenClaw, one command writes the config for you (backed up, merged, Docker-aware):
agenticledger connect claude-code # or: bmad, openclaw
For everything else, two changes: set base_url to the proxy and add a session ID header to group calls into a run. Everything else - your API key, model, messages - stays exactly the same.
OpenAI:
from openai import OpenAI
client = OpenAI(
base_url="http://localhost:8000/v1", # ← proxy
api_key="your-openai-key",
default_headers={"x-agenticledger-session-id": "run-1"},
)
response = client.chat.completions.create(
model="gpt-4o",
messages=[{"role": "user", "content": "Research the top 3 AI trends in 2026"}],
)
Anthropic (no upstream config needed: /v1/messages calls route to Anthropic automatically):
import anthropic
client = anthropic.Anthropic(
base_url="http://localhost:8000", # ← proxy
api_key="your-anthropic-key",
default_headers={"x-agenticledger-session-id": "run-1"},
)
Azure OpenAI: point AzureOpenAI(azure_endpoint="http://localhost:8000") at the ledger with your resource set as the upstream; deployments are priced from the model the response names. See the Azure guide.
AWS Bedrock: install agentic-ledger[bedrock], give the ledger AWS credentials through the standard chain, and point boto3 (endpoint_url) or Claude Code (ANTHROPIC_BEDROCK_BASE_URL) at it; the ledger re-signs each call itself. Both wires are covered: InvokeModel and the modern Converse/ConverseStream APIs. See the Bedrock guide.
LiteLLM / OpenRouter / any gateway:
# Point Agentic Ledger at your gateway
AGENTICLEDGER_UPSTREAM_URL=http://localhost:4000 uv run python -m agenticledger.proxy
# Then point your agent at Agentic Ledger
client = OpenAI(base_url="http://localhost:8000/v1", ...)
Step 3 - Open the dashboard
http://localhost:8000
The web app updates live via WebSocket as calls come in. No refresh needed.
- Website-matched design - the dashboard shares the charcoal surfaces, ice-blue accents, geometric raccoon mark, and typography of agentic-ledger.dev. Session Overview adds recorded cost, calls, token totals, and a per-call cost chart. Loop Lens pairs iteration costs with a "While you were away" timeline. Unknown call prices remain explicit; all charts use captured ledger data. Calls, Flow, Trace, replay, budget controls, and light/dark appearance remain available.
- Loop Lens - every loop run with its observed status (Running / Flagged / Completion declared / Ended / Calls blocked), one open metric strip (recorded spend, the run ceiling with an honest accounting track, model calls), Overview / Activity / Cache views, a recorded-event timeline that jumps straight to the evidence, a Block calls action that refuses a running loop's further calls at the wall (and Allow calls again to lift it; the agent being blocked cannot), per-iteration breakdowns, and plain-English explanations of every flag. Pick any two runs with ⇆ to diff them side by side: an anatomy replay first (the recorded calls played one at a time, the context pile filling to what the model read, the move going out to its tool, the result rejoining the conversation or dropped when the next call starts fresh, both runs from the same start on one scale), then cost, iterations, calls, cache reads, flags, duration with signed deltas, plus a prompt drift diff showing exactly what changed in the system prompt and opening instruction between the runs.
examples/loop-anatomy/records a Ralph loop and a ReAct loop on one task so you can present the two shapes. - Sessions - flat, scannable rows and three views: call rows (time, model, one status, latency, cost) that expand into a four-tab inspector (Response, Tools, Prompt, Raw), a Flow DAG of agent handoffs, and a Trace waterfall with real parent links from the loop engine. Rows say whose they are at a glance: team badge, red for real failures, amber for deliberate refusals, purple for replays, and a run chip linking each session to its loop.
- Replay the whole run - the question that decides a model switch isn't "how did it handle one call?" but "would my loop have survived?" Pick a run or session, pick a destination (a local model is free), and every step re-runs with its original inputs. You get a report card, not homework: "34 / 40 moments matched", the fumbles named ("dropped the tools"), and the cost both ways. Each step is a real captured moment replayed honestly - after step one a different model would have steered a different conversation, so the ledger compares moments, not fairy tales.
- In your pocket -
agenticledger shareopens an https tunnel you own (via cloudflared, no account), prints the pairing link, and draws a QR in the terminal: point your phone's camera and the dashboard is in your hand, kill switch, stop all calls, and ceilings included. for a same-network link, to un-pair every device, or press in the dashboard's ⚿ panel. Local machines never need a key; everyone else meets the auto-generated pairing key. The dashboard fits a phone: one pane at a time, a back button, prev/next arrows to flip between runs.
Configuration
agenticledger init writes agenticledger.toml with every option
commented. Uncomment what you need - a working setup looks like this:
[proxy]
port = 8000
upstream_url = "https://api.anthropic.com"
db = "sqlite:///agenticledger.db"
[keys]
# Prefer *_file: the file's contents are the key, so no secret lives in
# this file or your shell history (chmod 600 the key file).
api_key_file = "~/.agenticledger/api.key" # dashboard/admin access
ingest_key_file = "~/.agenticledger/ingest.key" # closes the open relay
[budgets]
daily = 25.0 # whole-ledger daily ceiling, USD
session = 5.0 # per-session ceiling
[replay]
# Free local replay via LM Studio (any key works there):
openai_url = "http://localhost:1234"
openai_key = "lm-studio"
Three rules:
- The file is found in this order:
AGENTICLEDGER_CONFIG, then./agenticledger.toml(the folder you start from), then~/.agenticledger/config.toml. First match wins; the startup banner names the file in effect. - Anything typed in the command beats the file. Env vars override
per-setting (
AGENTICLEDGER_PORT=9000 agenticledger startuses 9000 for that run without touching the file) - which is also why Docker and CI setups configured by env vars are unaffected. - Changes apply on restart (
agenticledger stopthenstart).
Every setting in the environment-variable reference
below has a config-file home; an [env] section passes any other
AGENTICLEDGER_* variable through verbatim.
Providers, step by step
Every provider below rides the same proxy; the only thing that changes is
which base URL you point at it. Each recipe assumes the proxy is up
(agenticledger start) and ends with the same check: run one call, open
http://localhost:8000, and see it in Sessions.
OpenAI (and any OpenAI-compatible API)
- Point the client at the proxy:
export OPENAI_BASE_URL=http://localhost:8000/v1 - Keep your
OPENAI_API_KEYexactly as it was - the proxy passes your auth header through untouched. - Make a call; it appears in Sessions with an O mark.
Anthropic
- Point the client at the proxy:
export ANTHROPIC_BASE_URL=http://localhost:8000 - Keep your
ANTHROPIC_API_KEYas it was. - Make a call; it appears with an A mark. No upstream config needed - the proxy routes Anthropic-shaped calls to Anthropic by wire format.
AWS Bedrock (direct capture)
- Give the ledger AWS credentials of its own through the standard chain
(env vars,
~/.awsprofile, or an instance role) scoped tobedrock:InvokeModelandbedrock:InvokeModelWithResponseStream, then install the extra and restart:pip install "agentic-ledger[bedrock]" agenticledger stop && agenticledger start - Check the ⚙ Settings panel: the Bedrock row should read "signing as the ledger in ".
- Point the client at the proxy - Claude Code:
boto3:export CLAUDE_CODE_USE_BEDROCK=1 export ANTHROPIC_BEDROCK_BASE_URL=http://localhost:8000boto3.client("bedrock-runtime", endpoint_url="http://localhost:8000"). - Make a call; it appears with an orange B mark. The ledger strips the caller's identity and re-signs with its own credentials. Full guide: docs/integrations/bedrock.md.
AWS Bedrock through a company gateway
Many companies front Bedrock with a gateway that does the authentication itself; Claude Code is then configured with CLAUDE_CODE_SKIP_BEDROCK_AUTH=1 and ANTHROPIC_BEDROCK_BASE_URL pointing at the gateway, usually from a managed settings file. The ledger sits in front of that gateway and forwards each call exactly as the agent sent it, headers included: no signing, no AWS credentials on your side.
- Tell the ledger where the gateway is (the host
ANTHROPIC_BEDROCK_BASE_URLpointed at before):agenticledger config set proxy.bedrock_gateway_url https://bedrock-gateway.company.example agenticledger stop && agenticledger start - Point Claude Code at the ledger instead:
ANTHROPIC_BEDROCK_BASE_URL=http://localhost:8000. If that value lives in the IT-managed settings file (/Library/Application Support/ClaudeCode/managed-settings.json), it overrides everything else and IT has to change it; if it is in~/.claude/settings.json, edit it there. /healthand the ⚙ Settings panel read "forwarding as sent to the gateway at ...". Calls appear with the Bedrock mark and the region-prefixed model id.
Azure OpenAI
- Set the upstream to your resource:
agenticledger config set proxy.upstream_url https://<resource>.openai.azure.com agenticledger stop && agenticledger start - Point the client's Azure endpoint at
http://localhost:8000; keep yourapi-keyheader as it was. - Calls are tagged
azure-openaiand priced by the model the RESPONSE names, so deployment aliases can't hide the real model. Full guide: docs/integrations/azure-openai.md.
Local models (LM Studio, Ollama with the OpenAI API)
- Set the upstream to the local server:
agenticledger config set proxy.upstream_url http://localhost:1234 agenticledger stop && agenticledger start export OPENAI_BASE_URL=http://localhost:8000/v1in the agent.- Calls appear with a purple mark and $0 cost. Full guide: docs/integrations/lm-studio.md.
Gateways (OpenRouter, LiteLLM)
- Set the upstream to the gateway:
agenticledger config set proxy.upstream_url https://openrouter.ai/api agenticledger stop && agenticledger start export OPENAI_BASE_URL=http://localhost:8000/v1; keep the gateway key as it was.- Gateway-prefixed model ids ("anthropic/claude-...") price correctly via substring matching. Guides: openrouter.md, litellm.md.
Framework-specific recipes (CrewAI, LangGraph, AutoGen, Vercel AI SDK, pydantic-ai, and more) live in docs/integrations/.
Coding agents - Claude Code, Ralph loops & friends
Claude Code (and most coding agents) can be pointed at the proxy with a single environment variable - no headers, no code changes:
agenticledger start
export ANTHROPIC_BASE_URL=http://localhost:8000
claude
No upstream config needed: calls route to the provider matching their wire format.
Agentic Ledger fingerprints Claude Code traffic automatically: every call is
tagged framework=claude-code, and instead of one undifferentiated bucket,
each Claude Code session appears under its real session UUID (the same id
claude --resume shows), with prompt-cache reads/writes captured and priced
correctly - cache traffic is where most of a coding agent's real spend lives.
Want a loop filed under a name you chose? Put one word in front of the command you already run:
agenticledger run nightly-digest -- python agent.py
Your command runs exactly as before; its LLM calls land on the run tile
named nightly-digest, and each launch counts as the next iteration, so
tomorrow's run joins the same tile. Nothing in your agent's code changes.
Add --project acme to file the run under a dashboard project as it starts.
Running an overnight loop (Ralph-style while :; do cat PROMPT.md | claude -p; done)?
The same command with loop flags re-executes your command each iteration,
attributes every call to the run (via the base URL, no headers needed), and
stops on a completion promise, a budget ceiling, or the iteration cap:
AGENTICLEDGER_UPSTREAM_URL=https://api.anthropic.com \
AGENTICLEDGER_COMPLETION_PROMISE="ALL TASKS COMPLETE" \
uv run python -m agenticledger.proxy
agenticledger run overnight --max-iterations 50 --budget 25 -- \
claude -p "$(cat PROMPT.md)" --dangerously-skip-permissions
Each iteration shows up as iteration N of the run in /api/runs; when the
agent prints the completion promise in a response, run status flips to
complete and the loop exits with a cost/token summary. The word after
run is the run's name; without one the run is named after the folder and
the minute (myproject-0819-1936). Rerunning the same name continues its
iteration count instead of restarting at 1. Any existing loop
script works too - poll GET /api/runs/{run_id} yourself, or let the proxy's
budgets (AGENTICLEDGER_BUDGET_DAILY=25.00) hard-stop a runaway loop.
Iterating on the prompt? Rerun and use ⇆ compare in the Loop Lens to diff the two runs - cost, iterations, calls, and flags side by side - so "did the new prompt actually help" gets a number instead of a feeling.
The same recipe works for any client with a base-URL override (Codex CLI,
opencode, OpenClaw, LiteLLM-based stacks) - set the OpenAI/Anthropic base URL
to the proxy and traffic is captured; add x-agenticledger-* headers when you
want explicit attribution.
OTel-native tools (Gemini CLI, Codex [otel], AutoGen/AG2, Pydantic AI,
Vercel AI SDK) don't need the proxy at all - point their OTLP exporter at the
ledger and GenAI spans are ingested directly:
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:8000
Both OTLP/HTTP encodings are accepted: JSON always, protobuf when the
[otel] extra is installed (the Docker image includes it). gRPC exporters
should switch to HTTP: OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf.
Framework guides - one per integration in docs/integrations: Claude Code, Codex CLI, opencode, OpenClaw, BMAD-METHOD, LangGraph/LangChain, CrewAI, OpenAI Agents SDK, Gemini CLI, AutoGen/AG2, Pydantic AI, Vercel AI SDK, LiteLLM, OpenRouter, and LM Studio (fully offline: local model, local ledger).
Production deployment - TLS termination, auth keys, redaction, image signature/SBOM verification, enterprise mirrors, and scaling guidance in docs/deployment.md.
The numbers
Measured, not promised. Reproduce them with
python scripts/loadtest.py --calls 2000 --seed 1000000 (Apple M-series
MacBook, SQLite backend; re-measured on 0.10 with the provider adapter
architecture in place - same numbers, 2,580 to 2,800 calls/s on both):
The honest caveats: the session list aggregates every session on every
load, so it grows with total history; the report window uses a timestamp
index, so it grows with the window's traffic, not the table. Your agent's
provider latency (hundreds of ms per call) dwarfs the proxy's overhead by
an order of magnitude. Postgres numbers vary with your server; the same
script measures them with --dsn. Cost math has its own guardrails and
a five-minute parity check against your provider console: see
docs/accuracy.md.
What gets captured
Every LLM call is stored with:
API reference
Examples:
# All calls in a session
curl http://localhost:8000/session/run-1
# Search across all sessions
curl "http://localhost:8000/api/search?q=failed+to+connect"
# Download JSON audit trail (includes an integrity tag; keyed HMAC when configured)
curl http://localhost:8000/export/run-1 -o audit-run-1.json
# Printable HTML report - open in browser, print to PDF
open http://localhost:8000/export/run-1/report
MCP server
Agentic Ledger exposes its captured data as an MCP (Model Context Protocol) tool server at POST /mcp. Point Claude Desktop, Cursor, or any MCP-compatible client at it to query traces directly from your AI assistant.
Tools available:
Configure in claude_desktop_config.json (HTTP, against a running proxy):
{
"mcpServers": {
"agenticledger": {
"url": "http://localhost:8000/mcp"
}
}
}
Or as a stdio subprocess - for clients that launch servers as commands (no running proxy required; reads the same database):
{
"mcpServers": {
"agenticledger": {
"command": "agenticledger",
"args": ["mcp"],
"env": { "AGENTICLEDGER_DSN": "sqlite:////absolute/path/to/agenticledger.db" }
}
}
}
If AGENTICLEDGER_API_KEY is set, pass it as a header:
{
"mcpServers": {
"agenticledger": {
"url": "http://localhost:8000/mcp",
"headers": { "x-agenticledger-api-key": "your-key" }
}
}
}
Once connected, you can ask your assistant things like:
- "What did the SearchAgent do in the last session?"
- "Show me all calls that mentioned rate limit errors"
- "What was the total cost of session run-abc123?"
Configuration reference
Every variable below can also live in agenticledger.toml - see
Configuration for the file, the search order, and the
env-always-wins rule.
Environment variables
Core:
Cost budgets - block calls that exceed a spend limit (returns HTTP 429):
Budgets and run ceilings hold under concurrency. Each admitted call reserves an estimate (its text at four chars per token plus its max_tokens, priced like any call) until its real cost is recorded, so a burst of parallel calls cannot each pass the same remaining room. The single call that crosses the line still goes through, as one caller always did, so overshoot is bounded to one call's cost. A reservation is released the moment the call is recorded, fails, is dropped, or is refused.
Allow and deny lists - refuse a model or provider before any quota is spent (returns HTTP 403 with the rule named, so agents stop rather than retry). Patterns are shell globs, matched case-insensitively. Deny wins over allow; an allow list that exists admits only what it names. Team cards can carry the same four lists (see Team cards); the fleet lists always apply and a card can only narrow them.
Rate limits - block calls that exceed request frequency (returns HTTP 429, sliding 60-second window). Every refusal is recorded as an amber blocked: row with the reason, counted per session and team in Reports and in /metrics (agenticledger_refusals_total{reason=...}), so a retry storm is visible instead of vanishing:
Loop engine - every call is stitched into ReAct threads (thread_id, step_index, prev_action_id) and fresh-context loop iterations are grouped into runs, with stuck-loop detection:
Alerts - POST to your webhook when a threshold is breached (does not block calls - see Alerts):
OpenTelemetry - emit spans to any OTLP-compatible collector (requires pip install "agentic-ledger[otel]" - see OpenTelemetry export):
Pricing overrides - override or extend the built-in per-token pricing table (merged at startup):
Common startup examples
# Local dev - OpenAI (default)
AGENTICLEDGER_UPSTREAM_URL=https://api.openai.com uv run python -m agenticledger.proxy
# Local dev - Anthropic
AGENTICLEDGER_UPSTREAM_URL=https://api.anthropic.com uv run python -m agenticledger.proxy
# Local dev - LiteLLM gateway (any model)
AGENTICLEDGER_UPSTREAM_URL=http://localhost:4000 uv run python -m agenticledger.proxy
# Production - Postgres + auth + budgets + rate limits + alerts
AGENTICLEDGER_UPSTREAM_URL=https://api.openai.com \
AGENTICLEDGER_DSN=postgresql://user:password@localhost/agenticledger \
AGENTICLEDGER_API_KEY=my-secret \
AGENTICLEDGER_BUDGET_DAILY=20.00 \
AGENTICLEDGER_BUDGET_SESSION=2.00 \
AGENTICLEDGER_RATE_LIMIT_SESSION_RPM=20 \
AGENTICLEDGER_RATE_LIMIT_USER_RPM=60 \
AGENTICLEDGER_ALERT_WEBHOOK_URL=https://hooks.slack.com/services/xxx/yyy/zzz \
AGENTICLEDGER_ALERT_COST_PER_CALL=0.50 \
AGENTICLEDGER_ALERT_DAILY_SPEND=15.00 \
uv run python -m agenticledger.proxy
When AGENTICLEDGER_API_KEY is set, pass it in a header to access protected endpoints:
curl -H "x-agenticledger-api-key: my-secret" http://localhost:8000/session/run-1
Keys travel in headers only. A key in a query string (?api_key=, ?token=) is refused with a 401 that says why: URLs end up in access logs, proxy logs, browser history and Referer headers. In a browser, paste the key into the dashboard's ⚿ panel, or open the pairing link from agenticledger share, which carries the key after the # (the URL fragment, which a browser never sends to any server).
Sign in with your identity provider (OpenID Connect)
For people, not scripts: point the ledger at your identity provider and the ⚿ panel gains a Sign in with Okta button (or whatever you name it). The code flow with PKCE, ID tokens verified against the provider's keys (RS256), and your groups decide the role: a person whose groups map to nothing is refused, told why, and recorded. Keys keep working beside it for agents and scripts.
AGENTICLEDGER_OIDC_ISSUER=https://your-org.okta.com
AGENTICLEDGER_OIDC_CLIENT_ID=0oa...
AGENTICLEDGER_OIDC_CLIENT_SECRET_FILE=/run/secrets/oidc # omit for a public client
AGENTICLEDGER_OIDC_ROLE_MAP=ledger-admins=admin,ledger-editors=editor,ledger-viewers=viewer
AGENTICLEDGER_PUBLIC_URL=https://ledger.example.com # the redirect back lands here
Register https://ledger.example.com/auth/callback as the redirect URI with the provider. A sign-in is a server-side row the browser holds a cookie for (httponly, SameSite=Lax, Secure over https): it ends after 12 idle hours or 7 days (AGENTICLEDGER_SESSION_IDLE_HOURS, AGENTICLEDGER_SESSION_MAX_HOURS), on Sign out, or when an admin ends it (POST /api/people/{id}/signout). Mutating requests that ride a cookie must come from the dashboard's own origin. Every audit row names the person by email. GET /api/people lists who has signed in, with their role and groups.
Scoped access. AGENTICLEDGER_OIDC_SCOPE_MAP=team-alpha=alpha,team-alpha=alpha-infra makes anyone in team-alpha see exactly those projects: the lists, single sessions and runs, search, reports, exports, what-if, replay and the MCP tools all answer inside the scope, and anything outside it reads as not found. Work filed under no project is invisible to a scoped person until someone files it. A person in no mapped group is unscoped and sees everything their role allows, as before. Scoped editors can file work only under their own projects.
To try it without a provider: agenticledger idp runs a test provider on loopback with four fake people (alice is an admin, dave has no mapped group), prints the four lines to set, and says on every page that it is not for production.
Scoped API tokens (RBAC)
The master key is convenient but coarse. For team access, mint scoped, revocable tokens with roles instead of sharing the master secret. Tokens are random secrets shown once at creation; only their SHA-256 hash is stored.
Roles are hierarchical, with one exception: ingest sits outside the hierarchy and opens only the proxy path.
# Mint a viewer token (admin only - use the master key to bootstrap)
curl -X POST http://localhost:8000/api/tokens \
-H "x-agenticledger-api-key: my-secret" \
-H "content-type: application/json" \
-d '{"name": "grafana-readonly", "role": "viewer", "expires_in_days": 90}'
# → {"token_id": "...", "token": "agl_…", "role": "viewer", ...} (token shown once)
# Use it (Authorization: Bearer or the x-agenticledger-token header)
curl -H "Authorization: Bearer agl_…" http://localhost:8000/api/sessions
# List and revoke
curl -H "x-agenticledger-api-key: my-secret" http://localhost:8000/api/tokens
curl -X DELETE -H "x-agenticledger-api-key: my-secret" http://localhost:8000/api/tokens/<token_id>
Auth is enforced only when
AGENTICLEDGER_API_KEYis set; the master key is the admin bootstrap for minting tokens. The live/wsfeed accepts a header (Authorization: Bearerorx-agenticledger-token) or a ticket: a browser cannot put a header on a websocket handshake, so the dashboard first callsPOST /api/ws/ticketwith its key in a header and connects with/ws?ticket=..., a random one-minute, single-use ticket that is worthless once used. Unauthenticated connects, and any connect with a key in its URL, are rejected with close code 1008.
Request headers
Pass these from your agent on each LLM call. All optional. They enrich captured data, power the Flow tab, and enable per-dimension budgets and rate limits.
Single agent - fully annotated:
from openai import OpenAI
client = OpenAI(
base_url="http://localhost:8000/v1",
api_key="your-openai-key",
default_headers={
"x-agenticledger-session-id": "run-abc123",
"x-agenticledger-user-id": "user-42",
"x-agenticledger-agent-name": "researcher",
"x-agenticledger-app-id": "my-app",
"x-agenticledger-environment": "production",
},
)
Multi-agent system - tracking handoffs:
from openai import OpenAI
# Orchestrator
orchestrator_client = OpenAI(
base_url="http://localhost:8000/v1",
api_key="your-openai-key",
default_headers={
"x-agenticledger-session-id": "run-abc123",
"x-agenticledger-agent-name": "orchestrator",
},
)
# Researcher (receives handoff from orchestrator)
researcher_client = OpenAI(
base_url="http://localhost:8000/v1",
api_key="your-openai-key",
default_headers={
"x-agenticledger-session-id": "run-abc123",
"x-agenticledger-agent-name": "researcher",
"x-agenticledger-handoff-from": "orchestrator",
"x-agenticledger-handoff-to": "researcher",
},
)
The Flow tab renders orchestrator → researcher as a DAG with cost and latency on each node.
OpenAI Agents SDK (openai-agents) - per-agent clients:
The openai-agents SDK uses its own internal OpenAI client. To pass Agentic Ledger headers you need to create a client per agent using OpenAIResponsesModel and set it as the agent's model.
import uuid
import os
from openai import AsyncOpenAI
from agents import Agent
from agents.models.openai_responses import OpenAIResponsesModel
SESSION_ID = f"run-{uuid.uuid4().hex[:8]}" # one per execution
BASE_URL = os.getenv("OPENAI_BASE_URL") # e.g. http://localhost:8000/v1
def al_model(agent_name: str, model: str = "gpt-4o-mini",
handoff_from: str | None = None, handoff_to: str | None = None):
"""Create a model instance that sends Agentic Ledger metadata headers."""
if not BASE_URL:
return model # proxy not configured - use default client
headers = {
"x-agenticledger-session-id": SESSION_ID,
"x-agenticledger-agent-name": agent_name,
}
if handoff_from:
headers["x-agenticledger-handoff-from"] = handoff_from
if handoff_to:
headers["x-agenticledger-handoff-to"] = handoff_to
client = AsyncOpenAI(base_url=BASE_URL, api_key=os.getenv("OPENAI_API_KEY", ""),
default_headers=headers)
return OpenAIResponsesModel(model=model, openai_client=client)
planner = Agent(name="PlannerAgent", model=al_model("PlannerAgent", handoff_to="SearchAgent"), ...)
searcher = Agent(name="SearchAgent", model=al_model("SearchAgent", handoff_from="PlannerAgent", handoff_to="WriterAgent"), ...)
writer = Agent(name="WriterAgent", model=al_model("WriterAgent", handoff_from="SearchAgent", handoff_to="EmailAgent"), ...)
emailer = Agent(name="EmailAgent", model=al_model("EmailAgent", handoff_from="WriterAgent"), ...)
Each agent's calls are tagged with its name and pipeline position. The Flow tab renders the full PlannerAgent → SearchAgent → WriterAgent → EmailAgent DAG automatically.
Why per-agent clients?
set_default_openai_client()sets a single global client - fine for single-agent apps, but it can't carry differentagent_nameorhandoff_*headers per agent in a multi-agent system. Per-agentOpenAIResponsesModelinstances are the correct approach.
Alerts
Agentic Ledger posts to your webhook URL when a threshold is breached, a loop is flagged, a run hits a wall, or a run ends. Slack incoming webhooks, Discord webhooks and PagerDuty Events v2 are recognised from the URL and get their native shape (override with AGENTICLEDGER_ALERT_FORMAT); anything else gets the plain JSON below.
Reliable by construction. Every notification is tried three times with backoff (1s, 3s, 9s) off the request path, said once per window (a crossed daily budget once a day, a flagged loop once per ten minutes, a run hitting a wall once an hour), and recorded: the Settings page lists what was sent, whether it landed, after how many tries, and why not, with a Send a test notification button so wiring Slack takes one click. GET /api/notifications returns the same history. Set AGENTICLEDGER_PUBLIC_URL and every notification about a run or session carries a link straight to it.
Payload format (plain JSON; the native shapes carry the same facts):
{
"type": "high_cost",
"message": "Single call cost $0.1842 exceeded threshold $0.10",
"value": 0.1842,
"threshold": 0.10,
"action_id": "a1b2c3d4-...",
"session_id": "run-1",
"agent_name": "researcher",
"timestamp": "2026-04-03T12:00:00+00:00"
}
Alert types:
Team cards - one proxy, many teams
Think allowance cards: you keep the one real provider key, and hand each
team a card of its own. Each card opens the proxy, stamps every call with
the team's name, and can carry its own daily budget - when marketing hits
$10, only marketing gets blocked (with an honest Retry-After).
curl -X POST http://localhost:8000/api/tokens \
-H "x-agenticledger-api-key: $ADMIN_KEY" -H 'content-type: application/json' \
-d '{"name": "marketing", "role": "ingest", "budget_daily": 10.00}'
The response shows the card once - the ledger stores only its hash. The
team puts it in x-agenticledger-ingest-key instead of the shared key;
Reports gains a by-team table with errors, blocks, and spend-today against
each card's allowance. Revoke a card with DELETE /api/tokens/{token_id}
and only that team is affected - from that instant the card gets a final
403 ("the answer is no"), which agents accept without retry storms.
Paste a card into the dashboard's ⚿ panel by mistake and it tells you, in
plain words, that cards open the relay, not the dashboard.
A card can also carry its own allow and deny lists for models and
providers, on top of the fleet-wide AGENTICLEDGER_ALLOW_MODELS and
friends. The fleet lists always apply; a card can only narrow them, never
grant a model the fleet denies. Refusals name the rule and the team, and
show up in the by-team table like any other block.
curl -X POST http://localhost:8000/api/tokens \
-H "x-agenticledger-api-key: $ADMIN_KEY" -H 'content-type: application/json' \
-d '{"name": "marketing", "role": "ingest", "budget_daily": 10.00,
"allow_models": ["gpt-4o", "claude-sonnet-*"], "deny_providers": ["bedrock"]}'
Budgets vs alerts:
- Budgets (
AGENTICLEDGER_BUDGET_*) - block the call before it reaches the LLM. Agent gets HTTP 429. - Alerts (
AGENTICLEDGER_ALERT_*) - the call goes through, you get notified after.
What the webhook receives. Every alert is one JSON POST with our own field names: type (see the table below), message, value, threshold, action_id, session_id, agent_name, timestamp. The daily digest (AGENTICLEDGER_DIGEST_HOUR=8) is a separate POST with type: daily_digest, a ready-to-read text block (last-24h spend, cache savings, top models and agents), and totals.
Slack - paste an Incoming Webhook URL (hooks.slack.com): each notification arrives as a titled message with the detail and an "Open in Agentic Ledger" link.
PagerDuty - use the Events API v2 URL (https://events.pagerduty.com/v2/enqueue) and set AGENTICLEDGER_ALERT_PAGERDUTY_KEY to the integration key: notifications trigger incidents with a severity per type (critical for a failed or blocked run, warning for thresholds, info for summaries and digests), a dedup key, and a link to the run.
Discord - a channel webhook URL (discord.com/api/webhooks/...): a titled embed with the detail and the link.
Custom - any HTTP endpoint that accepts a JSON POST.
OpenTelemetry export
Agentic Ledger can emit every intercepted LLM call as an OTel span to any OTLP-compatible collector: Grafana Tempo, Jaeger, Honeycomb, Datadog, Dynatrace, or any vendor that supports OTLP/HTTP.
Install the extra (Docker image includes OTel - no extra step needed when using Docker):
pip install "agentic-ledger[otel]"
# or
uv add "agentic-ledger[otel]"
Configure:
Example - Grafana Tempo:
AGENTICLEDGER_UPSTREAM_URL=https://api.openai.com \
AGENTICLEDGER_OTEL_ENDPOINT=http://localhost:4318 \
AGENTICLEDGER_OTEL_SERVICE_NAME=my-agent \
uv run python -m agenticledger.proxy
Example - Honeycomb:
AGENTICLEDGER_OTEL_ENDPOINT=https://api.honeycomb.io \
AGENTICLEDGER_OTEL_HEADERS=x-honeycomb-team=YOUR_API_KEY,x-honeycomb-dataset=llm-traces \
uv run python -m agenticledger.proxy
Span attributes emitted (GenAI semantic conventions):
Spans are grouped into traces by session_id - all calls in a session appear as one trace in your backend. Parent-child relationships follow x-agenticledger-parent-action-id. Error spans (status_code != 200) are marked with StatusCode.ERROR.
Compliance documents
For a security or privacy review: docs/compliance holds the data-flow diagram, a data-processing description with a DPA annex, the subprocessor statement (none: the software runs where you install it and sends the project nothing), the HIPAA posture, a SOC 2 and ISO 27001 control mapping with evidence for every row, and the support window (the latest minor gets every fix, the previous minor gets security fixes for 90 days). Written to be attached as they are, and honest about what the project does not hold: no SOC 2 report, no ISO certificate, no BAA.
Compliance export
Every session can be exported as an integrity-tagged audit trail - useful for regulated industries, internal audits, or passing traces to external tools.
# Machine-readable JSON with an integrity tag over the calls array
curl http://localhost:8000/export/run-1 -o audit-run-1.json
# Printable HTML - open in browser and print to PDF
open http://localhost:8000/export/run-1/report
The JSON export carries an integrity tag over the calls array. By default this is a sha256 checksum - it catches accidental corruption but is not a signature (anyone who edits the calls can recompute it). Set AGENTICLEDGER_EXPORT_HMAC_KEY to switch to a keyed hmac-sha256 tag, which is tamper-evident: a recipient holding the key can detect any modification, and the tag cannot be forged without the key.
Releasing
Tagging a version triggers the full release pipeline automatically:
git tag v0.2.0
git push origin v0.2.0
This runs three jobs:
- Docker - builds
ghcr.io/shekharbhardwaj/agentic-ledger:{version}and:latestfor linux/amd64 + linux/arm64, pushes with SBOM + provenance attestations, signs the digest with Sigstore cosign (keyless), and mirrors to Docker Hub when theDOCKERHUB_USERNAME/DOCKERHUB_TOKENsecrets are configured - PyPI - builds and publishes
agentic-ledger=={version}to PyPI using trusted publishing (no API token needed), with PEP 740 attestations - GitHub Release - creates a release with auto-generated changelog and attaches the image SBOM (SPDX)
First-time PyPI setup (one time only):
- Go to pypi.org/manage/account/publishing
- Add a new pending publisher:
PyPI project name: agentic-ledger Owner: ShekharBhardwaj Repository: AgenticLedger Workflow name: release.yml Environment name: pypi - Create a
pypienvironment in GitHub: repo → Settings → Environments → New environment → name itpypi - That's it - no secrets needed
Troubleshooting
Start here: agenticledger doctor. One command prints the whole truth
of your machine: every install on PATH and who shadows whom, which Python
owns each one and whether it can actually run (wrong-architecture wheels
and missing dependencies caught by a real import probe), what the
background service is serving, and a fix-it command per finding. Most of
the problems below diagnose themselves with it. Add --fix and it applies the fixes it names: shadow installs evicted with their own interpreter's pip, the PATH prepend offered for cleanup, then a second diagnostic pass.
Old version / commands or env vars named agentledger (no "ic") -
you're running a pre-0.4 release, most likely from a venv that already had
the package installed: plain pip install agentic-ledger says "requirement
already satisfied" and does NOT upgrade. Run agenticledger upgrade - it
uses the Python environment that owns the install, so there's no guessing
which pip is the right one - then restart. The proxy prints its version on the first line at startup, and
curl localhost:8000/health reports it too. Since 0.4.0 everything is named
agenticledger - see the migration notes in the CHANGELOG.
Replay fails with 401 "invalid x-api-key" - AGENTICLEDGER_REPLAY_API_KEY
needs a real provider API key from console.anthropic.com
(or platform.openai.com). A Claude Code subscription login is not an API
key and cannot be used. No key? Replay for free against a local model - see
the LM Studio guide.
incompatible architecture (have 'arm64', need 'x86_64') on macOS - your
terminal is running under Rosetta, so Python picks its x86_64 slice while pip
installed arm64 native wheels. Check with arch (should print arm64 on
Apple Silicon). Quick fix: prefix the command with arch -arm64. Permanent
fix: uncheck "Open using Rosetta" on your terminal app, use an Apple Silicon
build of your editor, and restart any long-lived tmux server.
module 'httpx' has no attribute 'AsyncClient' - fixed in
0.3.0-alpha.2; upgrade with pip install --upgrade agentic-ledger.
Port 8000 already in use - another proxy instance (or app) is running;
stop it or set AGENTICLEDGER_PORT.
401 OAuth access token has expired from Claude Code - the proxy passed
Anthropic's answer through unmodified; re-authenticate with claude →
/login. Errored calls are still captured, so you'll see the 401 in the
dashboard.
/ answers 404 "Web app not built" - you're running from a source
checkout without the web-app build. cd dashboard-app && npm ci && npm run build and restart. PyPI and Docker installs always include the app.
License
MIT
mcp-name: io.github.ShekharBhardwaj/agentic-ledger