トレーシング
Agents SDK にはビルトインのトレーシング機能があり、エージェントの実行中に発生するイベント―― LLM 生成、ツール呼び出し、ハンドオフ、ガードレール、さらにカスタムイベントまで――を網羅的に記録します。開発時と本番環境の両方で Traces dashboard を使用すると、ワークフローをデバッグ・可視化・モニタリングできます。
Note
トレーシングはデフォルトで有効です。無効化する方法は次の 2 つです:
- 環境変数
OPENAI_AGENTS_DISABLE_TRACING=1
を設定してグローバルに無効化する - 単一の実行に対しては
agents.run.RunConfig.tracing_disabled
をTrue
に設定する
OpenAI の API を Zero Data Retention (ZDR) ポリシーで利用している組織では、トレーシングを利用できません。
トレースとスパン
- トレース は 1 度のワークフロー全体を表します。複数のスパンで構成され、次のプロパティを持ちます:
workflow_name
: 論理的なワークフローまたはアプリ名。例: 「Code generation」や「Customer service」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()
でラップ - 音声入力 (speech‑to‑text) を
transcription_span()
でラップ - 音声出力 (text‑to‑speech) を
speech_span()
でラップ - 関連する音声スパンは
speech_group_span()
の下にネストされる場合があります
トレース名はデフォルトで「Agent trace」です。trace
を使用して指定したり、RunConfig
で名前やその他のプロパティを設定できます。
さらに カスタムトレーシングプロセッサー を設定して、トレースを別の送信先に出力(置き換えまたは追加)することも可能です。
上位レベルのトレース
複数回の 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}")
with trace()
で 2 つのRunner.run
呼び出しをラップしているため、それぞれが個別のトレースを作成せず、全体で 1 つのトレースになります。
トレースの作成
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
を設定して音声データの記録を無効化できます。
カスタムトレーシングプロセッサー
トレーシングの高レベル構成は次のとおりです。
- 初期化時にグローバルな
TraceProvider
を作成し、トレースを生成。 TraceProvider
はBatchTraceProcessor
を用いてスパン/トレースをバッチ送信し、BackendSpanExporter
が OpenAI バックエンドへバッチでエクスポートします。
デフォルト設定を変更して別のバックエンドへ送信したり、エクスポーターの挙動を修正するには次の 2 通りがあります。
add_trace_processor()
既定の送信に加え、追加 のトレースプロセッサーを登録できます。これにより OpenAI バックエンドへの送信に加えて独自処理が可能です。set_trace_processors()
既定のプロセッサーを置き換え、独自 のトレースプロセッサーだけを使用します。OpenAI バックエンドへ送信する場合は、その機能を持つTracingProcessor
を含める必要があります。