追踪

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

Note

默认启用追踪。你可以通过三种常见方式禁用它：

1. 你可以通过设置环境变量 OPENAI_AGENTS_DISABLE_TRACING=1 全局禁用追踪
2. 你可以在代码中通过 set_tracing_disabled(True) 全局禁用追踪
3. 你可以通过将 agents.run.RunConfig.tracing_disabled 设置为 True 来禁用单次运行的追踪

对于在 OpenAI API 上使用零数据保留（ZDR）策略的组织，追踪功能不可用。

追踪与跨度

• Traces 表示“工作流”的单次端到端操作。它们由 Span 组成。Traces 具有以下属性：
  • workflow_name：逻辑工作流或应用。例如“代码生成”或“客户服务”。
  • trace_id：追踪的唯一 ID。如果不传入会自动生成。格式必须为 trace_<32_alphanumeric>。
  • group_id：可选分组 ID，用于关联同一会话中的多个追踪。例如，你可以使用聊天线程 ID。
  • disabled：若为 True，则不会记录该追踪。
  • metadata：追踪的可选元数据。
• Spans 表示具有开始和结束时间的操作。Spans 具有：
  • 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_span() 中
• 安全防护措施会包裹在 guardrail_span() 中
• 任务转移会包裹在 handoff_span() 中
• 音频输入（语音转文本）会包裹在 transcription_span() 中
• 音频输出（文本转语音）会包裹在 speech_span() 中
• 相关音频跨度可能作为 speech_group_span() 的子项

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

此外，你还可以设置自定义追踪进程，将追踪推送到其他目标（作为替代或次要目标）。

长时运行工作进程与即时导出

默认的 BatchTraceProcessor 会在后台每隔几秒导出追踪， 或者当内存队列达到大小触发条件时更早导出， 并且在进程退出时执行最终刷新。在 Celery、 RQ、Dramatiq 或 FastAPI 后台任务等长时运行工作进程中，这意味着追踪通常会自动导出， 无需额外代码，但它们在每个任务 结束后可能不会立即出现在 Traces 仪表盘中。

如果你需要在一个工作单元结束时确保立即投递，请调用 flush_traces()，并在追踪上下文退出后执行。

from agents import Runner, flush_traces, trace


@celery_app.task
def run_agent_task(prompt: str):
    try:
        with trace("celery_task"):
            result = Runner.run_sync(agent, prompt)
        return result.final_output
    finally:
        flush_traces()

from fastapi import BackgroundTasks, FastAPI
from agents import Runner, flush_traces, trace

app = FastAPI()


def process_in_background(prompt: str) -> None:
    try:
        with trace("background_job"):
            Runner.run_sync(agent, prompt)
    finally:
        flush_traces()


@app.post("/run")
async def run(prompt: str, background_tasks: BackgroundTasks):
    background_tasks.add_task(process_in_background, prompt)
    return {"status": "queued"}

flush_traces() 会阻塞，直到当前缓冲的追踪和跨度 被导出，因此请在 trace() 关闭后调用，以避免刷新到部分构建的追踪。若可接受 默认导出延迟，则可跳过此调用。

高层追踪

有时，你可能希望多次调用 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}")

1. 因为两次对 Runner.run 的调用都包裹在 with trace() 中，单次运行将成为整体追踪的一部分，而不是创建两个追踪。

创建追踪

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

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

当前追踪通过 Python 的 contextvar 进行跟踪。这意味着它能自动适配并发场景。如果你手动启动/结束追踪，则需要向 start()/finish() 传入 mark_as_current 和 reset_current 以更新当前追踪。

创建跨度

你可以使用各种 *_span() 方法创建跨度。通常你不需要手动创建跨度。可使用 custom_span() 函数来跟踪自定义跨度信息。

跨度会自动归属于当前追踪，并嵌套在最近的当前跨度之下；这一状态通过 Python 的 contextvar 跟踪。

敏感数据

某些跨度可能会捕获潜在敏感数据。

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

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

默认情况下，trace_include_sensitive_data 为 True。你也可以在不改代码的情况下，通过在应用运行前将 OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA 环境变量设置为 true/1 或 false/0 来设置默认值。

自定义追踪进程

追踪的高层架构如下：

• 初始化时，我们会创建一个全局 [TraceProvider][agents.tracing.setup.TraceProvider]，其负责创建追踪。
• 我们使用 BatchTraceProcessor 配置 TraceProvider，该进程会将追踪/跨度分批发送到 BackendSpanExporter，后者再将跨度和追踪分批导出到 OpenAI 后端。

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

1. add_trace_processor() 允许你添加额外的追踪进程，在追踪和跨度就绪时接收它们。这让你可以在发送到 OpenAI 后端之外执行自己的处理。
2. set_trace_processors() 允许你用自己的追踪进程替换默认进程。这意味着除非你包含一个会执行该操作的 TracingProcessor，否则追踪不会发送到 OpenAI 后端。

使用非 OpenAI 模型进行追踪

你可以将 OpenAI API key 与非 OpenAI 模型一起使用，以在 OpenAI Traces 仪表盘中启用免费追踪，而无需禁用追踪。有关适配器选择与设置注意事项，请参阅 Models 指南中的第三方适配器部分。

import os
from agents import set_tracing_export_api_key, Agent, Runner
from agents.extensions.models.any_llm_model import AnyLLMModel

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

model = AnyLLMModel(
    model="your-provider/your-model-name",
    api_key="your-api-key",
)

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

如果你仅在单次运行中需要不同的追踪 key，请通过 RunConfig 传递，而不是修改全局导出器。

from agents import Runner, RunConfig

await Runner.run(
    agent,
    input="Hello",
    run_config=RunConfig(tracing={"api_key": "sk-tracing-123"}),
)

补充说明

• 在 Openai Traces 仪表盘查看免费追踪。

生态集成

以下社区和供应商集成支持 OpenAI Agents SDK 追踪能力。

外部追踪进程列表

• Weights & Biases
• Arize-Phoenix
• Future AGI
• MLflow（self-hosted/OSS）
• MLflow（Databricks hosted）
• Braintrust
• Pydantic Logfire
• AgentOps
• Scorecard
• Respan
• LangSmith
• Maxim AI
• Comet Opik
• Langfuse
• Langtrace
• Okahu-Monocle
• Galileo
• Portkey AI
• LangDB AI
• Agenta
• PostHog
• Traccia
• PromptLayer
• HoneyHive
• Asqav