トレーシング

Agents SDK にはトレーシングが組み込まれており、エージェントの実行中に発生するイベント（LLM 生成、ツール呼び出し、ハンドオフ、ガードレール、さらにはカスタムイベント）を包括的に記録します。Traces ダッシュボードを使用すると、開発環境および本番環境でワークフローをデバッグ、可視化、監視できます。

Note

トレーシングはデフォルトで有効です。一般的な次の 3 つの方法で無効にできます。

環境変数 OPENAI_AGENTS_DISABLE_TRACING=1 を設定すると、トレーシングをグローバルに無効化できます
コード内で set_tracing_disabled(True) を使用すると、トレーシングをグローバルに無効化できます
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() の配下に配置される場合があります

デフォルトでは、トレース名は「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 のバックグラウンドタスクなどの長時間実行ワーカーでは、通常、追加のコードなしでトレースが自動的にエクスポートされますが、各ジョブの完了直後には 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}")

2 回の Runner.run 呼び出しが with trace() でラップされているため、個別の実行によって 2 つのトレースが作成されるのではなく、全体のトレースに含まれます。

トレースの作成

trace() 関数を使用してトレースを作成できます。トレースは開始して終了する必要があります。これには次の 2 つの方法があります。

推奨: with trace(...) as my_trace のように、トレースをコンテキストマネージャーとして使用します。これにより、適切なタイミングでトレースが自動的に開始および終了します。
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 を作成します。
TraceProvider に BatchTraceProcessor を設定します。このプロセッサーはトレース／スパンをバッチ単位で BackendSpanExporter に送信し、同エクスポーターがスパンとトレースをバッチ単位で OpenAI バックエンドにエクスポートします。

このデフォルト設定をカスタマイズし、トレースを代替または追加のバックエンドに送信したり、エクスポーターの動作を変更したりするには、次の 2 つの方法があります。

add_trace_processor() を使用すると、準備ができたトレースとスパンを受け取る追加のトレースプロセッサーを追加できます。これにより、トレースを OpenAI のバックエンドへ送信する処理に加えて、独自の処理も実行できます。
set_trace_processors() を使用すると、デフォルトのプロセッサーを独自のトレースプロセッサーで置き換えることができます。この場合、OpenAI バックエンドへ送信する TracingProcessor を含めない限り、トレースは OpenAI バックエンドに送信されません。

OpenAI 以外のモデルでのトレーシング

OpenAI 以外のモデルでも OpenAI API キーを使用すれば、トレーシングを無効にすることなく、OpenAI Traces ダッシュボードで無料のトレーシングを有効にできます。アダプターの選択と設定に関する注意事項については、モデルガイドのサードパーティ製アダプターセクションを参照してください。

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 Traces ダッシュボードで無料のトレースを確認できます。

エコシステム統合

以下のコミュニティおよびベンダーの統合は、OpenAI Agents SDK のトレーシングインターフェースをサポートしています。