追踪

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

Note

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

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

对于使用OpenAI的API且执行零数据保留（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() 中。
• 每次智能体运行时，都会包装在 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. 推荐：将追踪用作上下文管理器，即 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]，它负责创建追踪。
• 我们为 TraceProvider 配置一个 BatchTraceProcessor，它会将追踪/跨度批量发送到 BackendSpanExporter，后者会将跨度和追踪批量导出到OpenAI后端。

要自定义此默认设置，将追踪发送到替代或额外后端，或修改导出器行为，你有两个选项：

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

非OpenAI模型的追踪

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

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,
)

如果你只需要为单次运行使用不同的追踪密钥，请通过 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（自托管/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