追踪

Agents SDK 内置了追踪功能，可在智能体运行期间收集全面的事件记录：LLM 生成、工具调用、任务转移、安全防护措施，以及自定义事件。使用 Traces 仪表板，你可以在开发和生产环境中对工作流进行调试、可视化和监控。

Note

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

你可以通过设置环境变量 OPENAI_AGENTS_DISABLE_TRACING=1 全局禁用追踪
你可以通过将 agents.run.RunConfig.tracing_disabled 设置为 True 来仅对单次运行禁用追踪

对于在使用 OpenAI API 且遵循 Zero Data Retention (ZDR) 策略的组织，无法使用追踪功能。

追踪与 Span

追踪代表一次“工作流”的端到端操作。它由多个 Span 组成。追踪具备以下属性：
- workflow_name：逻辑上的工作流或应用。例如 “Code generation” 或 “Customer service”。
- trace_id：追踪的唯一 ID。如果未传入将自动生成。必须符合格式 trace_<32_alphanumeric>。
- group_id：可选的分组 ID，用于关联同一会话中的多个追踪。例如你可以使用会话线程 ID。
- disabled：若为 True，则不会记录该追踪。
- metadata：追踪的可选元数据。
Spans 表示具有开始和结束时间的操作。Span 包含：
- started_at 和 ended_at 时间戳。
- trace_id，表示所属的追踪
- parent_id，指向该 Span 的父 Span（如有）
- span_data，关于该 Span 的信息。例如，AgentSpanData 包含关于智能体的信息，GenerationSpanData 包含关于 LLM 生成的信息等。

默认追踪

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

整个 Runner.{run, run_sync, run_streamed}() 被包裹在 trace() 中。
每次智能体运行，都会被包裹在 agent_span() 中
LLM 生成会被包裹在 generation_span() 中
每次 function 工具调用都会被包裹在 function_span() 中
安全防护措施会被包裹在 guardrail_span() 中
任务转移会被包裹在 handoff_span() 中
音频输入（语音转文本）会被包裹在 transcription_span() 中
音频输出（文本转语音）会被包裹在 speech_span() 中
相关音频 Span 可能会被挂载在 speech_group_span() 之下

默认情况下，追踪名称为 “Agent workflow”。如果你使用 trace，可以设置该名称；或者可以通过 RunConfig 配置名称和其他属性。

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

更高层级的追踪

有时，你可能希望多次调用 run() 属于同一个追踪。你可以将整段代码包裹在 trace() 中实现这一点。

from agents import Agent, Runner, trace

async def main():
    agent = Agent(name="Joke generator", instructions="Tell funny jokes.")

    with trace("Joke workflow"): # (1)!
        first_result = await Runner.run(agent, "Tell me a joke")
        second_result = await Runner.run(agent, f"Rate this joke: {first_result.final_output}")
        print(f"Joke: {first_result.final_output}")
        print(f"Rating: {second_result.final_output}")

由于两次对 Runner.run 的调用都包裹在 with trace() 中，单独的运行将属于总体追踪的一部分，而不是创建两个追踪。

创建追踪

你可以使用 trace() 函数创建一个追踪。追踪需要被启动和结束。你有两种方式：

推荐方式：将 trace 作为上下文管理器使用，即 with trace(...) as my_trace。这会在正确的时间自动启动并结束追踪。
你也可以手动调用 trace.start() 和 trace.finish()。

当前追踪通过 Python 的 contextvar 进行跟踪。这意味着它可自动与并发协同工作。如果你手动启动/结束追踪，则需要在 start()/finish() 时传入 mark_as_current 和 reset_current 来更新当前追踪。

创建 Span

你可以使用各种 *_span() 方法来创建 Span。一般情况下，你无需手动创建 Span。可使用 custom_span() 来记录自定义的 Span 信息。

Span 会自动加入当前追踪，并嵌套在最近的当前 Span 之下，其跟踪通过 Python 的 contextvar 实现。

敏感数据

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

generation_span() 会存储 LLM 生成的输入/输出，function_span() 会存储函数调用的输入/输出。这些可能包含敏感数据，因此你可以通过 RunConfig.trace_include_sensitive_data 禁用对这些数据的采集。

同样，音频相关的 Span 默认会包含输入与输出音频的 base64 编码 PCM 数据。你可以通过配置 VoicePipelineConfig.trace_include_sensitive_audio_data 来禁用音频数据的采集。

自定义追踪处理器

追踪的高层架构如下：

初始化时，我们会创建一个全局的 TraceProvider，负责创建追踪。
我们将 TraceProvider 配置为使用 BatchTraceProcessor，它会将追踪/Span 批量发送到 BackendSpanExporter，后者会将 Span 和追踪批量导出到 OpenAI 后端。

若要自定义该默认设置，以将追踪发送到替代或附加的后端，或修改导出器行为，你有两种选择：

add_trace_processor() 允许你添加一个额外的追踪处理器，它会在追踪和 Span 就绪时接收它们。这使你可以在向 OpenAI 后端发送追踪之外，执行你自己的处理。
set_trace_processors() 允许你用你自己的追踪处理器替换默认处理器。这意味着除非你包含一个将追踪发送到 OpenAI 后端的 TracingProcessor，否则追踪将不会被发送到 OpenAI 后端。

使用非 OpenAI 模型进行追踪

你可以将 OpenAI API key 与非 OpenAI 模型一起使用，在无需禁用追踪的情况下，在 OpenAI Traces 仪表板中启用免费的追踪。

import os
from agents import set_tracing_export_api_key, Agent, Runner
from agents.extensions.models.litellm_model import LitellmModel

tracing_api_key = os.environ["OPENAI_API_KEY"]
set_tracing_export_api_key(tracing_api_key)

model = LitellmModel(
    model="your-model-name",
    api_key="your-api-key",
)

agent = Agent(
    name="Assistant",
    model=model,
)

备注

在 OpenAI Traces 仪表板查看免费追踪。

追踪