トレーシング

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

エクスポートループのライフサイクル

ほとんどの環境では、トレースは定期的に自動エクスポートされます。ブラウザや Cloudflare Workers では、この機能はデフォルトで無効です。キューに溜まりすぎた場合にはトレースはエクスポートされますが、定期的にはエクスポートされません。代わりに、コードのライフサイクルの一部として getGlobalTraceProvider().forceFlush() を使用して手動でトレースをエクスポートしてください。

たとえば Cloudflare Worker では、コードを try/catch/finally ブロックでラップし、waitUntil とあわせて強制フラッシュを使用して、ワーカーが終了する前にトレースがエクスポートされるようにします。

import { getGlobalTraceProvider } from '@openai/agents';

export default {
  async fetch(request, env, ctx): Promise<Response> {
    try {
      // your agent code here
      return new Response(`success`);
    } catch (error) {
      console.error(error);
      return new Response(String(error), { status: 500 });
    } finally {
      // make sure to flush any remaining traces before exiting
      ctx.waitUntil(getGlobalTraceProvider().forceFlush());
    }
  },
};

トレースとスパン

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 は以下をトレースします:

run() または Runner.run() 全体が Trace でラップされる
エージェントが実行されるたびに AgentSpan でラップされる
LLM 生成が GenerationSpan でラップされる
関数ツールの呼び出しはそれぞれ FunctionSpan でラップされる
ガードレールが GuardrailSpan でラップされる
ハンドオフが HandoffSpan でラップされる

デフォルトでは、トレース名は “Agent workflow” です。withTrace を使用する場合はこの名前を設定できますし、RunConfig.workflowName で名前やその他のプロパティを設定できます。

加えて、カスタムトレーシングプロセッサーを設定して、トレースを別の宛先へ送信する（置き換え、または第 2 の宛先として）ことができます。

音声エージェントのトレーシング

デフォルトの OpenAI Realtime API とともに RealtimeAgent と RealtimeSession を使用している場合、RealtimeSession で tracingDisabled: true を設定するか、環境変数 OPENAI_AGENTS_DISABLE_TRACING を使用して無効化しない限り、トレーシングは Realtime API 側で自動的に行われます。

詳細は音声エージェントの概要をご覧ください。

上位のトレース

複数回の run() 呼び出しを 1 つのトレースにまとめたい場合があります。その場合はコード全体を withTrace() でラップします。

import { Agent, run, withTrace } from '@openai/agents';

const agent = new Agent({
  name: 'Joke generator',
  instructions: 'Tell funny jokes.',
});

await withTrace('Joke workflow', async () => {
  const result = await run(agent, 'Tell me a joke');
  const secondResult = await run(
    agent,
    `Rate this joke: ${result.finalOutput}`,
  );
  console.log(`Joke: ${result.finalOutput}`);
  console.log(`Rating: ${secondResult.finalOutput}`);
});

2 回の run 呼び出しが withTrace() でラップされているため、個々の実行は 2 つのトレースを作成するのではなく、全体のトレースの一部になります

トレースの作成

withTrace() 関数を使用してトレースを作成できます。あるいは、getGlobalTraceProvider().createTrace() を使って手動で新しいトレースを作成し、withTrace() に渡すこともできます。

現在のトレースは Node.js の AsyncLocalStorage または該当環境のポリフィルで追跡されます。これにより、並行処理でも自動的に機能します。

スパンの作成

create*Span()（例: createGenerationSpan(), createFunctionSpan() など）の各メソッドを使用してスパンを作成できます。一般的には手動でスパンを作成する必要はありません。カスタムスパン情報を追跡するための createCustomSpan() 関数が利用できます。

スパンは自動的に現在のトレースの一部となり、最も近い現在のスパンの下にネストされます。これは Node.js の AsyncLocalStorage または該当環境のポリフィルで追跡されます。

機微なデータ

一部のスパンは、機微なデータを取得する可能性があります。

createGenerationSpan() は LLM 生成の入出力を保存し、createFunctionSpan() は関数呼び出しの入出力を保存します。これらには機微なデータが含まれる可能性があるため、RunConfig.traceIncludeSensitiveData でそのデータの取得を無効化できます。

カスタムトレーシングプロセッサー

トレーシングの高レベルなアーキテクチャは次のとおりです:

初期化時にグローバルな TraceProvider を作成します。これはトレースの作成を担当し、getGlobalTraceProvider() を通じてアクセスできます
TraceProvider に BatchTraceProcessor を設定し、これがトレース/スパンをバッチで OpenAITracingExporter に送信します。エクスポーターはスパンとトレースを OpenAI のバックエンドにバッチでエクスポートします

このデフォルト構成をカスタマイズして、別のバックエンドへ送信したり、追加のバックエンドへも送信したり、エクスポーターの挙動を変更するには、以下の 2 つの方法があります:

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