トレーシング

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());
    }
  },
};

トレースとスパン

トレース は「ワークフロー」の単一のエンドツーエンド処理を表します。スパンで構成されます。トレースには以下のプロパティがあります:
- 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 は次をトレースします:

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

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

さらに、カスタムトレーシングプロセッサーを設定して、他の送信先へトレースをプッシュできます（置き換えや追加の送信先として）。

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

RealtimeAgent と RealtimeSession を OpenAI のデフォルト Realtime API と併用している場合、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 を含める必要があります