追踪

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

Note

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

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

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

追踪与跨度

• 追踪表示一次“工作流”的端到端操作，由多个跨度组成。追踪具有以下属性：
  • 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() 中
• 相关的音频跨度可以作为子跨度归入 speech_group_span() 中

默认情况下，追踪名为“智能体工作流”。使用 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 进行跟踪。这意味着它能够自动支持并发。如果手动启动或结束追踪，则需要将 mark_as_current 和 reset_current 传递给 start()/finish()，以更新当前追踪。

跨度创建

可以使用各种 *_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]，负责创建追踪。
• 我们为 TraceProvider 配置一个 BatchTraceProcessor，它会将追踪和跨度分批发送到 BackendSpanExporter，后者再将跨度和追踪分批导出到OpenAI后端。

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

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

非OpenAI模型追踪

可以将OpenAI API 密钥与非OpenAI模型搭配使用，从而在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追踪接口。

外部追踪进程列表

• 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