トレーシング
Agents SDK にはトレーシングが標準搭載されており、エージェント実行中のイベントを網羅的に記録します。たとえば LLM の生成、ツール呼び出し、ハンドオフ、ガードレール、さらにはカスタムイベントまで収集します。Traces ダッシュボードを使って、開発時や本番環境でワークフローをデバッグ、可視化、監視できます。
Note
トレーシングはデフォルトで有効です。無効化する方法は 2 つあります:
- 環境変数
OPENAI_AGENTS_DISABLE_TRACING=1を設定して、トレーシングをグローバルに無効化できます - 単一の実行に対しては、
agents.run.RunConfig.tracing_disabledをTrueに設定して無効化できます
OpenAI の API を使用し Zero Data Retention (ZDR) ポリシーで運用している組織では、トレーシングは利用できません。
トレースとスパン
- トレース は「ワークフロー」の単一のエンドツーエンド操作を表します。スパンで構成されます。トレースには次のプロパティがあります:
workflow_name: 論理的なワークフローまたはアプリです。例: "Code generation" や "Customer service"trace_id: トレースの一意の ID。渡さなければ自動生成されます。形式はtrace_<32_alphanumeric>である必要があります。group_id: 任意のグループ ID。同じ会話からの複数のトレースをリンクするために使います。例: チャットスレッド IDdisabled: 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 で名前やその他のプロパティを設定することもできます。
さらに、カスタム トレース プロセッサー を設定して、トレースを他の送信先にプッシュできます（置き換え、または追加の送信先として）。
上位レベルのトレース
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}")
Runner.runへの 2 回の呼び出しが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 を設定して、この音声データの取得を無効化できます。
カスタム トレーシング プロセッサー
トレーシングのハイレベルなアーキテクチャは次のとおりです:
- 初期化時に、トレースの作成を担当するグローバルな
TraceProviderを作成します。 TraceProviderにBatchTraceProcessorを設定し、これはトレース/スパンをバッチでBackendSpanExporterに送信します。エクスポーターはスパンとトレースを OpenAI のバックエンドへバッチ送信します。
このデフォルト設定をカスタマイズして、別の（または追加の）バックエンドへ送信したり、エクスポーターの挙動を変更したりするには、次の 2 つの方法があります:
add_trace_processor()は、トレースやスパンを準備でき次第受け取る、追加のトレース プロセッサーを追加できます。これにより、OpenAI のバックエンドへの送信に加えて独自の処理を実行できます。set_trace_processors()は、デフォルトのプロセッサーを独自のトレース プロセッサーに置き換えられます。この場合、OpenAI のバックエンドにトレースが送信されるのは、送信を行うTracingProcessorを含めた場合に限られます。
OpenAI 以外のモデルでのトレーシング
OpenAI の API キーを OpenAI 以外のモデルと併用することで、トレーシングを無効化することなく、OpenAI Traces ダッシュボードでの無償トレーシングを有効にできます。
import os
from agents import set_tracing_export_api_key, Agent, Runner
from agents.extensions.models.litellm_model import LitellmModel
tracing_api_key = os.environ["OPENAI_API_KEY"]
set_tracing_export_api_key(tracing_api_key)
model = LitellmModel(
model="your-model-name",
api_key="your-api-key",
)
agent = Agent(
name="Assistant",
model=model,
)
メモ
- 無償トレースは OpenAI Traces ダッシュボードで確認できます。