トレーシング
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}")
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に送信します。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 ダッシュボードで表示できます。