@agent-inspect/openai-agents
v6.31.7
Published
OpenAI Agents JS processor integration for AgentInspect local traces and TraceContract checks
Maintainers
Readme
@agent-inspect/openai-agents
OpenAI Agents JS tracing processor → local AgentInspect traces.
Support level: Supported — see SUPPORT-LEVELS.md.
When to use
- You run agents with
@openai/agents - You want local-only traces (no default OpenAI trace export)
When not to use
- Replacing OpenAI's hosted tracing when you still need their dashboard
- Non–OpenAI Agents frameworks
Install
npm install agent-inspect @agent-inspect/openai-agents @openai/agentsPeer: @openai/agents@^0.12.0
Example
import { Agent, run, setTraceProcessors } from "@openai/agents";
import { agentInspectOpenAiAgents } from "@agent-inspect/openai-agents";
setTraceProcessors([
agentInspectOpenAiAgents({ traceDir: ".agent-inspect" }),
]);
const agent = new Agent({ name: "demo", tools: [] });
await run(agent, "hello");Use setTraceProcessors replacement for local-only mode. Avoid addTraceProcessor() if you need to disable default exporters.
Privacy
- Local JSONL files only
- AgentInspect does not upload traces to OpenAI
- Metadata-only by default
capture: "preview"is opt-in and persists boundedinputPreview/outputPreviewspan attributes, redacted before they reach disk and truncated atmaxPreviewChars; there is no full-content mode- Redaction is key-based, so a preview can still contain sensitive free text — run
agent-inspect redactbefore sharing
API
| Export | Purpose |
| ------ | ------- |
| agentInspectOpenAiAgents(options) | TracingProcessor for local persistence |
| getDiagnostics() | Warnings for misconfiguration plus resolved capture mode and preview counters |
CLI
npx agent-inspect list · sessions · report
Docs
Troubleshooting
- Duplicate export: Using
addTraceProcessorkeeps SDK default exporter — use replacement mode for local-only - Handoffs/sessions: Mapped to run metadata; see docs for session IDs
- Empty previews in preview mode: the span type carries no payload field (handoff, guardrail, agent), or the SDK omitted it. Payload-bearing spans report
AI_CAPTURE_FIELD_UNAVAILABLEthroughonDiagnosticandgetDiagnostics().capture - Previews look cut off: they are bounded by
maxPreviewChars, which theshareandstrictredaction profiles cap further
Version
Part of the fixed AgentInspect release line. See the npm badge / package manifest for the current version.
License
MIT
