追踪

Agents SDK 内置了追踪功能，会在智能体运行期间收集全面的事件记录：LLM 生成、工具调用、交接、护栏，以及自定义事件。通过 Traces dashboard，你可以在开发和生产环境中调试、可视化并监控工作流。

注意

追踪默认启用。可以通过以下两种方式禁用：

1. 通过设置环境变量 OPENAI_AGENTS_DISABLE_TRACING=1 全局禁用追踪
2. 将单次运行的 RunConfig.tracingDisabled 设为 true 来禁用该次追踪

对于使用 OpenAI API 并遵循 Zero Data Retention（ZDR）策略的组织，不支持追踪功能。

导出循环生命周期

在大多数环境中，追踪会按固定间隔自动导出。在浏览器或 Cloudflare Workers 中，此功能默认禁用。当队列中追踪过多时仍会导出，但不会按固定间隔导出。此时应通过 getGlobalTraceProvider().forceFlush() 将导出操作纳入代码生命周期手动执行。

例如，在 Cloudflare Worker 中，应将代码包裹在 try/catch/finally 中，并结合 waitUntil 使用强制刷新，确保在 worker 退出前导出追踪数据。

import { getGlobalTraceProvider } from '@openai/agents';

export default {
  async fetch(request, env, ctx): Promise<Response> {
    try {
      // your agent code here
      return new Response(`success`);
    } catch (error) {
      console.error(error);
      return new Response(String(error), { status: 500 });
    } finally {
      // make sure to flush any remaining traces before exiting
      ctx.waitUntil(getGlobalTraceProvider().forceFlush());
    }
  },
};

Trace 与 Span

• Traces 表示“工作流”一次端到端的操作，由多个 Span 组成。Trace 具有以下属性：
  • workflow_name：逻辑工作流或应用名称。例如“代码生成”或“客户服务”。
  • trace_id：Trace 的唯一 ID。如果未传入会自动生成，格式必须为 trace_<32_alphanumeric>。
  • group_id：可选分组 ID，用于关联同一会话中的多个 Trace。例如可使用聊天线程 ID。
  • disabled：若为 True，则不会记录该 Trace。
  • metadata：Trace 的可选元数据。
• Spans 表示具有开始和结束时间的操作。Span 具有：
  • started_at 与 ended_at 时间戳。
  • trace_id，表示所属的 Trace
  • parent_id，指向该 Span 的父级 Span（如有）
  • span_data，即 Span 的信息。例如，AgentSpanData 包含智能体信息，GenerationSpanData 包含 LLM 生成信息等。

默认追踪

默认情况下，SDK 会追踪以下内容：

• 整个 run() 或 Runner.run() 会被包裹在一个 Trace 中。
• 每次智能体运行会被包裹在 AgentSpan 中
• LLM 生成会被包裹在 GenerationSpan 中
• 每次函数工具调用会被包裹在 FunctionSpan 中
• 护栏会被包裹在 GuardrailSpan 中
• 交接会被包裹在 HandoffSpan 中

默认的 Trace 名称为“Agent workflow”。你可以使用 withTrace 设置此名称，或通过 RunConfig.workflowName 配置名称和其他属性。

此外，你可以设置自定义追踪处理器，将追踪推送到其他目的地（作为替代或附加目的地）。

语音智能体追踪

如果你在使用 RealtimeAgent 和 RealtimeSession 搭配默认的 OpenAI Realtime API，追踪会自动在 Realtime API 侧进行，除非你在 RealtimeSession 上使用 tracingDisabled: true 或设置环境变量 OPENAI_AGENTS_DISABLE_TRACING 来禁用。

详情参见语音智能体概述。

更高层级的追踪

有时，你可能希望多次调用 run() 都属于同一个 Trace。可以将整个代码包裹在 withTrace() 中实现。

import { Agent, run, withTrace } from '@openai/agents';

const agent = new Agent({
  name: 'Joke generator',
  instructions: 'Tell funny jokes.',
});

await withTrace('Joke workflow', async () => {
  const result = await run(agent, 'Tell me a joke');
  const secondResult = await run(
    agent,
    `Rate this joke: ${result.finalOutput}`,
  );
  console.log(`Joke: ${result.finalOutput}`);
  console.log(`Rating: ${secondResult.finalOutput}`);
});

1. 由于两次 run 调用都被 withTrace() 包裹，单次运行将成为整体 Trace 的一部分，而不是创建两个独立的 Trace。

创建追踪

你可以使用 withTrace() 函数来创建 Trace。或者，使用 getGlobalTraceProvider().createTrace() 手动创建一个新 Trace，并传入 withTrace()。

当前 Trace 通过 Node.js AsyncLocalStorage 或相应环境的 polyfill 进行跟踪。这意味着它能自动适配并发场景。

创建 Span

你可以使用各类 create*Span() 方法（如 createGenerationSpan()、createFunctionSpan() 等）来创建 Span。通常你无需手动创建 Span。提供了 createCustomSpan() 函数以跟踪自定义 Span 信息。

Span 会自动加入当前 Trace，并嵌套在最近的当前 Span 之下，当前 Span 通过 Node.js AsyncLocalStorage 或相应环境的 polyfill 进行跟踪。

敏感数据

某些 Span 可能会捕获潜在的敏感数据。

createGenerationSpan() 会存储 LLM 生成的输入/输出，createFunctionSpan() 会存储函数调用的输入/输出。这些内容可能包含敏感数据，因此你可以通过 RunConfig.traceIncludeSensitiveData 禁用对这些数据的捕获。

自定义追踪处理器

追踪的高层架构如下：

• 在初始化时，我们会创建一个全局的 TraceProvider，负责创建 Trace，可通过 getGlobalTraceProvider() 访问。
• 我们为 TraceProvider 配置了一个 BatchTraceProcessor，它会将 Trace/Span 批量发送至 OpenAITracingExporter，后者会将 Span 和 Trace 批量导出到 OpenAI 后端。

若需自定义此默认设置、将追踪发送到其他或额外的后端，或修改导出器行为，你有两种选择：

1. addTraceProcessor() 允许你添加一个“额外”的追踪处理器，用于在 Trace 和 Span 就绪时接收它们。这样你可以在将追踪发送到 OpenAI 后端之外执行自定义处理。
2. setTraceProcessors() 允许你“替换”默认处理器为你自己的追踪处理器。除非你包含一个负责发送到 OpenAI 后端的 TracingProcessor，否则追踪将不会发送到 OpenAI 后端。

外部追踪处理器列表

• AgentOps
• Keywords AI