トレーシング

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

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

ほとんどの環境では、トレースは一定間隔で自動的にエクスポートされます。ブラウザや 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 で名前やその他のプロパティを構成できます。

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

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

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}`);
});

run への 2 回の呼び出しが 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 を含めない限り、トレースは送信されないことを意味します