トレーシング
Agents SDK にはトレーシングが組み込まれており、エージェントの実行中に発生するイベントの包括的な記録（ LLM の生成、ツール呼び出し、ハンドオフ、ガードレール、カスタムイベントまで）を収集します。 Traces ダッシュボードを使用すると、開発中や本番環境でワークフローをデバッグ、可視化、監視できます。
Note
トレーシングはデフォルトで有効です。トレーシングを無効にする方法は 2 つあります。
- 環境変数
OPENAI_AGENTS_DISABLE_TRACING=1を設定してグローバルに無効化できます - 単一の実行に対しては、
agents.run.RunConfig.tracing_disabledをTrueに設定して無効化できます
OpenAI の API を使用し Zero Data Retention (ZDR) ポリシーで運用する組織では、トレーシングは利用できません。
トレースとスパン
- Traces（トレース） は「ワークフロー」の単一のエンドツーエンド操作を表します。スパンから構成されます。トレースには次のプロパティがあります:
workflow_name: 論理的なワークフローまたはアプリです。例: "Code generation" や "Customer service"trace_id: トレースの一意の ID。指定しない場合は自動生成されます。形式はtrace_<32_alphanumeric>である必要があります。group_id: 同一の会話からの複数のトレースを関連付けるためのオプションのグループ ID。たとえばチャットスレッドの ID を使用できます。disabled: True の場合、このトレースは記録されません。metadata: トレースの任意のメタデータ。
- Spans（スパン） は開始時刻と終了時刻を持つ操作を表します。スパンには次のものがあります:
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には、トレース/スパンをバッチでBackendSpanExporterに送信するBatchTraceProcessorを設定します。BackendSpanExporterは OpenAI のバックエンドにスパンとトレースをバッチでエクスポートします。
既定のセットアップをカスタマイズして、別のバックエンドへの送信や追加のバックエンドへの送信、エクスポータの動作変更を行うには、次の 2 つの方法があります。
add_trace_processor()は、トレースやスパンが準備でき次第受け取る、追加の トレースプロセッサーを追加できます。これにより、OpenAI のバックエンドへの送信に加えて独自の処理を行えます。set_trace_processors()は、既定のプロセッサーを独自のトレースプロセッサーで置き換えできます。OpenAI のバックエンドにトレースを送信するには、その役割を担うTracingProcessorを含める必要があります。
非 OpenAI モデルでのトレーシング
OpenAI 以外のモデルでも OpenAI API キーを使用して、トレーシングを無効化することなく 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 ダッシュボードで無料のトレースを表示します。