トレーシング

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

Note

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

環境変数 OPENAI_AGENTS_DISABLE_TRACING=1 を設定して、トレーシングをグローバルに無効化できます
コード内で set_tracing_disabled(True) を使用して、トレーシングをグローバルに無効化できます
agents.run.RunConfig.tracing_disabled を True に設定して、1 回の実行についてトレーシングを無効化できます

Zero Data Retention（ZDR）ポリシーのもとで OpenAI の API を使用する組織では、トレーシングを利用できません。

トレースとスパン

トレースは、1 つの「ワークフロー」における単一のエンドツーエンド操作を表します。トレースは複数のスパンで構成されます。トレースには次のプロパティがあります。
- 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() が閉じた後で呼び出してください。デフォルトのエクスポート遅延で問題ない場合は、この呼び出しを省略できます。

トレーシングを無効にすると、デフォルトプロバイダーは新しいトレースとスパンを作成しなくなりますが、そのプロセッサーがすでにバッファリングしたデータは破棄されません。set_tracing_disabled(True) または OPENAI_AGENTS_DISABLE_TRACING=1 によってトレーシングが無効化された後も、flush_traces() はそのバッファリング済みデータを引き続きフラッシュします。

上位レベルのトレース

複数回の run() 呼び出しを、1 つのトレースに含めたい場合があります。その場合は、コード全体を 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() でラップされているため、各実行で個別のトレースが作成されるのではなく、両方の実行が 1 つの全体的なトレースに含まれます。

トレースの作成

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

推奨: トレースをコンテキストマネージャーとして、つまり with trace(...) as my_trace の形式で使用します。これにより、適切なタイミングでトレースが自動的に開始および終了します。
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 を使用して、このデータの取得を無効にできます。

承認が必要な関数ツールでは、承認待ちで一時停止するスパンは、SDK の内部実行結果ラッパーをツール出力として保存しません。アプリケーションがカスタムの拒否メッセージを指定して呼び出しを拒否した場合、関数スパンがそのメッセージを出力およびエラーテキストとして保存するのは、trace_include_sensitive_data が True の場合のみです。この設定が False の場合、スパンは出力を省略し、汎用エラーテキスト Tool execution rejected を使用します。

同様に、音声スパンには、デフォルトで入力音声と出力音声の base64 エンコードされた PCM データが含まれます。VoicePipelineConfig.trace_include_sensitive_audio_data を設定することで、この音声データの取得を無効にできます。

デフォルトでは、trace_include_sensitive_data は True です。アプリを実行する前に、環境変数 OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA を true/1 または false/0 に設定してエクスポートすることで、コードを使用せずにデフォルトを設定できます。

trace_include_sensitive_data が False の場合、Responses モデルのスパンでは、リクエスト入力とレスポンス出力が省略されます。OpenAI の公式エンドポイントへの呼び出しでは、相関メタデータとして Responses API の response_id がスパンに引き続き含まれます。カスタムエンドポイントの場合、SDK は編集済みスパンからこの識別子を省略します。

カスタムトレーシングプロセッサー

トレーシングの上位レベルのアーキテクチャは次のとおりです。

初期化時に、トレースの作成を担当するグローバルな TraceProvider を作成します。
TraceProvider に BatchTraceProcessor を設定します。このプロセッサーは、トレースとスパンをバッチで BackendSpanExporter に送信し、そこから OpenAI のバックエンドへスパンとトレースをバッチでエクスポートします。

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

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

エクスポート前の編集

トレースプロセッサーは、互いに独立したオブザーバーです。デフォルトプロバイダーは、プロセッサーのコールバック例外を捕捉し、登録されている他のプロセッサーの呼び出しを続行します。そのため、エクスポーターより前に登録された編集プロセッサーで編集に失敗しても、そのエクスポーターがデータを受信することを防げません。また、add_trace_processor() でプロセッサーを追加しても、デフォルトの OpenAI エクスポーターは登録されたままです。

正常な編集をエクスポートの前提とする場合は、編集と配信を、アプリケーションが所有する同一のエクスポーター内に配置してください。set_trace_processors() を使用して、デフォルトのプロセッサーを、そのエクスポーターを設定した BatchTraceProcessor で置き換えます。エクスポーターは、シリアル化されたペイロードをコピーし、そのコピーを編集して、編集済みの実行結果のみを送信先へ渡す必要があります。シリアル化、コピー、または編集に失敗した場合は、送信先を呼び出す前にバッチを破棄してください。ペイロード、例外テキスト、トレースバックを含まない固定の失敗メッセージをログに記録してください。

トレース編集のコード例では、既存のトレーシング API を使用してこの構成を実装する方法を示しています。このコード例は、イベントのカテゴリーと、トレースおよびスパンの関連付け ID のみをローカルコンソールに出力し、API 呼び出しは行いません。その許可リストには、名前、メタデータ、エラー、スパンデータは含まれません。呼び出し元から渡される ID には機密情報を含めないようにするか、アプリケーションがそれらの ID を安全な値にマッピングする必要があります。この診断出力は、OpenAI のトレーシング取り込みスキーマではありません。バックエンドにデータを送信するアプリケーションは、そのバックエンドと互換性のある編集ポリシーと送信先を指定する必要があります。

編集処理と送信先は、信頼できるアプリケーションコードである必要があります。元のデータを個別にログへ記録したり、送信したりしてはいけません。バッチプロセッサーは、バックグラウンドでのエクスポート、明示的なフラッシュ、またはシャットダウン中にエクスポーターを呼び出す可能性があるため、コールバックはこれらの実行コンテキストから安全に使用できる必要があります。失敗したバッチは破棄されますが、後続のバッチは引き続きエクスポートできます。置き換えは今後のプロセッサーコールバックに影響し、以前に登録されたプロセッサーによってすでにバッファリングされているデータは消去しません。トレースを作成したり、エージェントを実行したりする前に、置き換えを設定してください。

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

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

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

1 回の実行にのみ別のトレーシングキーが必要な場合は、グローバルエクスポーターを変更する代わりに、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 サーフェスをサポートしています。

各統合のメンテナーが、その統合のサポートを提供します。この一覧への掲載は、OpenAI による推奨またはセキュリティ認証を意味するものではありません。新規掲載をリクエストするには、統合掲載基準に従ってください。