トレーシング
Agents SDK には組み込みのトレーシングが含まれており、エージェント実行中に発生するイベントの包括的な記録（ LLM の生成、ツール呼び出し、ハンドオフ、ガードレール、さらにはカスタムイベント）を収集します。 Traces ダッシュボード を使って、開発時および本番環境でワークフローをデバッグ、可視化、監視できます。
Note
トレーシングはデフォルトで有効です。トレーシングを無効にする方法は 2 通りあります:
- 環境変数
OPENAI_AGENTS_DISABLE_TRACING=1を設定して、トレーシングをグローバルに無効化できます - 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。たとえばチャットスレッド 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 で名前やその他のプロパティを構成することもできます。
さらに、カスタムトレースプロセッサー を設定して、トレースを別の宛先に送信（置き換え、またはセカンダリの宛先として）できます。
上位レベルのトレース
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()でラップされているため、個々の実行は 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を、スパン/トレースをバッチでBackendSpanExporterに送信するBatchTraceProcessorで構成します。BackendSpanExporterはスパンとトレースを OpenAI バックエンドにバッチでエクスポートします。
このデフォルト構成をカスタマイズして、別のバックエンドへの送信、追加のバックエンドへの複製、またはエクスポーターの動作変更を行うには、次の 2 通りの方法があります:
add_trace_processor()は、スパン/トレースが準備でき次第受け取る、追加の トレースプロセッサーを追加できます。これにより、 OpenAI のバックエンドへの送信に加えて、独自の処理を実行できます。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.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 ダッシュボードで確認できます。