トレーシング

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 は「ワークフロー」の単一のエンドツーエンドの操作を表します。複数の Span で構成されます。トレースには次のプロパティがあります:
- 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 で名前やその他のプロパティを設定できます。

さらに、カスタムトレーシングプロセッサーを設定して、他の送信先にトレースを送ることもできます（置き換えまたは二次送信先として）。

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

デフォルトの 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}`);
});

withTrace() で 2 回の run 呼び出しをラップしているため、個々の実行は 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 を含めない限り）