トレーシング

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

Note

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

環境変数OPENAI_AGENTS_DISABLE_TRACING=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() でラップします。

fromagentsimportAgent,Runner,traceasyncdefmain():agent=Agent(name="Joke generator",instructions="Tell funny jokes.")withtrace("Joke workflow"):# (1)!first_result=awaitRunner.run(agent,"Tell me a joke")second_result=awaitRunner.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 を作成します。
BatchTraceProcessor を使用してTraceProvider を構成し、トレース/スパンをバッチでBackendSpanExporter に送信します。これがスパンとトレースを OpenAI のバックエンドにバッチでエクスポートします。

このデフォルト設定をカスタマイズして、トレースを代替または追加のバックエンドに送信したり、エクスポーターの動作を変更したりするには、次の 2 つの方法があります:

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

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

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

importosfromagentsimportset_tracing_export_api_key,Agent,Runnerfromagents.extensions.models.litellm_modelimportLitellmModeltracing_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 ダッシュボードで表示できます。

Movatterモバイル変換