トレーシング
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() 呼び出しを単一のトレースに含めたいことがあります。これはコード全体を 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に送信します。Exporter はスパンとトレースをバッチで OpenAI のバックエンドにエクスポートします。
このデフォルト設定をカスタマイズし、別のバックエンドへの送信や追加のバックエンドへの送信、あるいは Exporter の動作を変更するには、次の 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 ダッシュボードで表示できます。