追踪

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

Note

追踪功能默认启用。你可以通过以下三种常见方式将其禁用：

1. 设置环境变量 OPENAI_AGENTS_DISABLE_TRACING=1，在全局范围内禁用追踪
2. 在代码中使用 set_tracing_disabled(True)，在全局范围内禁用追踪
3. 将 agents.run.RunConfig.tracing_disabled 设置为 True，为单次运行禁用追踪

对于依据零数据保留（Zero Data Retention，ZDR）政策使用OpenAI API 的组织，追踪功能不可用。

追踪记录与跨度

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

默认追踪

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

• 整个 Runner.{run, run_sync, run_streamed}() 都封装在一个 trace() 中。
• 每次运行器调用都封装在一个 task_span() 中。
• 每轮模型交互都封装在一个 turn_span() 中。
• 每次智能体运行时，都会封装在 agent_span() 中
• LLM 生成封装在 generation_span() 中
• 每次函数工具调用都封装在 function_span() 中
• 安全防护措施封装在 guardrail_span() 中
• 任务转移封装在 handoff_span() 中
• 音频输入（语音转文本）封装在一个 transcription_span() 中
• 音频输出（文本转语音）封装在一个 speech_span() 中
• SDK 可能会将相关的音频跨度置于一个 speech_group_span() 之下

默认情况下，追踪名称为字面字符串 Agent workflow。使用 trace 时可以设置此名称，也可以通过 RunConfig 配置名称及其他属性。

如果需要更紧凑的层级结构，可以为一次运行禁用自动任务跨度和交互轮次跨度。智能体、生成、函数、安全防护措施、任务转移和自定义跨度仍会被记录。

from agents import RunConfig, Runner

result = await Runner.run(
    agent,
    "Hello",
    run_config=RunConfig(tracing={"include_task_and_turn_spans": False}),
)

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

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

默认的 BatchTraceProcessor 每隔几秒在后台导出追踪记录；当内存队列达到其大小触发阈值时，也会提前导出；进程退出时还会执行最终刷新。对于 Celery、RQ、Dramatiq 或 FastAPI 后台任务等长期运行的工作进程，这意味着追踪记录通常无需任何额外代码即可自动导出，但每项作业结束后，它们可能不会立即显示在追踪仪表板中。

如果需要保证在一个工作单元结束时立即交付，请在退出追踪上下文后调用 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. 推荐：将追踪记录用作上下文管理器，即 with trace(...) as my_trace。这样会在正确的时间自动启动和结束追踪。
2. 也可以手动调用 trace.start() 和 trace.finish()。

当前追踪记录通过 Python 的 contextvar 进行跟踪。这意味着它可以自动处理并发。如果手动启动和结束追踪记录，请向 start() 传入 mark_as_current，并向 finish() 传入 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，负责创建追踪记录。
• 我们为 TraceProvider 配置一个 BatchTraceProcessor，它会将追踪记录和跨度分批发送到 BackendSpanExporter，后者会将跨度和追踪记录分批导出到OpenAI后端。

若要自定义此默认设置，将追踪记录发送到其他或额外的后端，或者修改导出器的行为，可以采用以下两种方式：

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

非OpenAI模型的追踪

使用非OpenAI模型时，你可以向追踪导出器提供 OpenAI API 密钥，从而在不禁用追踪的情况下，在OpenAI追踪仪表板中启用免费追踪功能。有关适配器选择和设置注意事项，请参阅模型指南中的第三方适配器部分。

import os
from agents import set_tracing_export_api_key, Agent
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,
)

如果仅需为单次运行使用不同的追踪密钥，请通过 RunConfig 传入该密钥，而不要更改全局导出器。

from agents import Runner, RunConfig

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

附加说明

• 在OpenAI追踪仪表板中查看免费追踪记录。

生态系统集成

以下社区和供应商集成支持 OpenAI Agents SDK的追踪 API 接口。

外部追踪处理器列表

• Weights & Biases
• Arize Phoenix
• Future AGI
• MLflow（自托管/OSS）
• MLflow（Databricks 托管）
• 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
• Datadog
• Latitude
• DProvenanceKit
• Tuning Engines