コンテンツにスキップ

トレーシング

Agents SDK にはトレーシングが組み込まれており、エージェントの実行中に発生するイベントの包括的な記録（ LLM 生成、ツール呼び出し、ハンドオフ、ガードレール、さらに発生したカスタムイベント）を収集します。 Traces ダッシュボード を使用して、開発中および本番環境でワークフローをデバッグ、可視化、監視できます。

Note

トレーシングはデフォルトで有効です。トレーシングを無効にする方法は 2 つあります:

  1. 環境変数 OPENAI_AGENTS_DISABLE_TRACING=1 を設定して、トレーシングをグローバルに無効化できます
  2. 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}")
  1. Runner.run への 2 回の呼び出しが with trace() でラップされているため、各実行は 2 つのトレースを作成するのではなく、全体のトレースの一部になります。

トレースの作成

trace() 関数を使用してトレースを作成できます。トレースは開始と終了が必要です。次の 2 通りの方法があります:

  1. 推奨: トレースをコンテキストマネージャとして使用します（例: with trace(...) as my_trace）。これにより適切なタイミングで自動的に開始・終了します。
  2. 手動で 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 つの方法があります:

  1. add_trace_processor() は、トレースやスパンが準備できたときに受け取る 追加の トレースプロセッサーを追加できます。これにより、 OpenAI のバックエンドにトレースを送信することに加えて、独自の処理を実行できます。
  2. set_trace_processors() は、デフォルトのプロセッサーを独自のトレースプロセッサーに 置き換え られます。つまり、 OpenAI バックエンドにトレースを送信する TracingProcessor を含めない限り、トレースは OpenAI バックエンドに送信されません。

非 OpenAI モデルでのトレーシング

トレーシングを無効化することなく、 OpenAI の Traces ダッシュボードで無料のトレーシングを有効にするために、非 OpenAI モデルでも OpenAI API キーを使用できます。

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,
)

単一の実行に対してのみ異なるトレーシングキーが必要な場合は、グローバルなエクスポーターを変更する代わりに RunConfig 経由で渡してください。

from agents import Runner, RunConfig

await Runner.run(
    agent,
    input="Hello",
    run_config=RunConfig(tracing={"api_key": "sk-tracing-123"}),
)

注意事項

  • OpenAI Traces ダッシュボードで無料のトレースを表示できます。

外部トレーシングプロセッサー一覧