Skip to content

server.md

Latest commit

 

History

History
163 lines (116 loc) · 5.73 KB

server.md

File metadata and controls

163 lines (116 loc) · 5.73 KB
Raw

Server-side event collector

Run a central collector so agents in containers, CI, and serverless functions can send traces over the network — no local disk required.

See ADR-0012 for design rationale.

Hosted collector

Status: planned. A managed collector.agent-strace.dev endpoint is on the roadmap. When available, it will implement the same API as agent-strace server — no client changes required.

Track design and implementation progress in agent-trace issue #129.

Once live, the only change needed is the endpoint:

# Self-hosted (today)
AGENT_STRACE_ENDPOINT=http://localhost:4317 python my_agent.py

# Hosted (when available — no other changes)
AGENT_STRACE_ENDPOINT=https://collector.agent-strace.dev python my_agent.py
AGENT_STRACE_AUTH_KEY=ast_<your-key>

The hosted endpoint will implement the same API documented below, with API key auth (see Authentication) and a free tier for individual developers.

Quick start

# Start the collector
agent-strace server --port 4317 --storage ./traces

# Agents point to it via environment variable — no code changes required
AGENT_STRACE_ENDPOINT=http://collector:4317 python my_agent.py

The server writes traces in the same .agent-traces/ format as local mode. All existing CLI commands work against its storage directory.

Docker

FROM python:3.12-slim
RUN pip install agent-strace
ENV AGENT_STRACE_STORAGE=/data
VOLUME /data
EXPOSE 4317
CMD ["agent-strace", "server", "--port", "4317"]
docker build -t agent-strace-server .
docker run -p 4317:4317 -v $(pwd)/traces:/data agent-strace-server

API reference

Method Path Description
POST /events Receive a batch of NDJSON events
POST /sessions Create or update session metadata
GET /sessions List all sessions
GET /sessions/<id> Read metadata for a session
GET /sessions/<id>/events Stream events for a session
GET /health Liveness check

Events are accepted as NDJSON (application/x-ndjson), one event per line. GET session IDs are URL-decoded as one containment-safe path component, so legacy IDs containing spaces, Unicode, or more than 128 characters remain readable. POST routes retain the strict 1–128 character ASCII policy for new session IDs.

Multi-agent correlation

When multiple agents send to the same collector, sessions are linked via parent_session_id and parent_event_id in session metadata. Use agent-strace replay --tree or agent-strace a2a-tree to visualise the full call graph.

Authentication

By default the server runs unauthenticated (local use). For any network-accessible deployment, enable API key auth:

# Generate a key
agent-strace server keygen
# → ast_a3f9b2c1d4e5f6a7b8c9d0e1f2a3b4c5

# Start server with key enforcement
agent-strace server --auth-key ast_a3f9b2c1d4e5f6a7b8c9d0e1f2a3b4c5

# Or via environment variable
AGENT_STRACE_AUTH_KEY=ast_a3f9b2c1d4e5f6a7b8c9d0e1f2a3b4c5 agent-strace server

Requests without a matching Authorization: Bearer <key> header receive 401 Unauthorized.

The key authorizes the entire collector instance; it is not scoped to a tenant_id. Treat one collector and storage root as one organization boundary, and run separate authenticated instances for organizations that must not access one another. Tenant filters are customer-level scoping inside that boundary, not an authorization mechanism. Managed multi-organization hosting is tracked separately in issue #129.

Organization reports from a collector

agent-strace org-report --endpoint https://collector.example.com reads the existing GET /sessions and GET /sessions/<id>/events endpoints. It refuses collectors that expose the session list without authentication. Supply the key through AGENT_STRACE_AUTH_KEY or --auth-key-file; there is no literal key flag, and AGENT_STRACE_ENDPOINT is deliberately ignored for this reporting command.

The read client requires HTTPS except for loopback HTTP, rejects redirects and credential-bearing URLs, disables ambient HTTP proxies, and applies bounded response, session, event, line, nesting, and total-byte limits. --ca-file adds a private CA. --allow-insecure-http is an explicit opt-in for a non-loopback test collector and should not be used on untrusted networks.

Collector reports use one metadata request followed by one event request for each session selected after the month/team metadata filters. These N+1 reads are bounded but are not a transactionally consistent snapshot; the generated report records that limitation. See Organization reporting.

Client side — set AGENT_STRACE_AUTH_KEY alongside AGENT_STRACE_ENDPOINT and all outbound requests include the header automatically:

export AGENT_STRACE_ENDPOINT=https://collector.example.com
export AGENT_STRACE_AUTH_KEY=ast_a3f9b2c1d4e5f6a7b8c9d0e1f2a3b4c5
python my_agent.py

The --stream-headers flag on agent-strace watch also works for one-off overrides:

agent-strace watch --stream-to https://collector.example.com \
  --stream-headers "Authorization=Bearer ast_..."

Key format: ast_ prefix + 32 hex characters. Generated with secrets.token_hex(16) — no new dependencies.

Live streaming from watch

Stream events to the collector in real-time during a watched session:

agent-strace watch \
  --stream-to http://collector:4317/events \
  --stream-batch-size 20 \
  --stream-flush-interval 5.0 \
  SESSION_ID

HTTP failures are logged to stderr but never interrupt the watch loop.