本文へ移動
Telemetry
統合ガイド

クロード エージェント SDK Telemetry

プロンプトやツールのペイロードを保存せずに、クロード エージェント SDK の実行結果、期間、ツール アクティビティ、ターン、コスト、および承認された製品シグナルを追跡します。

レビュー者 Telemetry 製品チーム . インストルメンテーション契約、プライバシー境界、および実装ガイダンス. 基準と所有権を確認する

役に立つ
  • クロード エージェント実行の可観測性
  • ツールループの信頼性
  • エージェントのコストと結果の分析
実装の証拠

Claude Agent SDK Telemetry: 境界から検証された行まで

制御されたアプリケーション境界で Claude Agent SDK Telemetry を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。

  1. 1

    結果を選択してください

    クロード エージェント実行の可観測性

  2. 2

    契約を定義する

    run_id、ワークフロー、agent_name、model_alias、および prompt_version

  3. 3

    境界を計測する

    パブリック クエリまたはクライアント境界をラップし、SDK ストリームが最終結果に到達した後に 1 つのアプリケーション結果を出力します。文書化されていないメッセージ フィールドには依存しません。

  4. 4

    証拠を検証する

    Exercise a known fixture, then inspect agent_run_completed for one correctly typed terminal row.

始める前に

前提条件と境界

  • 信頼できるサーバーまたはワーカー プロセスで実行されている @anthropic-ai/claude-agent-sdk および telemetry-sh
  • アプリケーションが所有する実行 ID、ワークフロー名、およびターミナル結果の分類
  • 権限、プロンプトコンテンツ、ツール入力、ツール結果、およびファイルパスに関するレビューされたポリシー

配信設定

サーバー側のインストールと初期化

サーバー専用コードで telemetry-sh をインポートし、process.env.TELEMETRY_API_KEY で一度初期化します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。

claude-agent-sdk-インストール

npmのインストール

bash
npm install telemetry-sh
  1. 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
  2. 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
  3. 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。

スニペット

1 つの構造化されたイベントから始める

ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。

claude-agent-sdk

Claude Agent SDK Telemetryイベント

javascript
import { query } from "@anthropic-ai/claude-agent-sdk";

async function runSupportAgent(prompt, runId) {
  const startedAt = performance.now();
  let status = "success";
  let turnCount = 0;
  let toolCallCount = 0;

  try {
    for await (const message of query({
      prompt,
      options: { maxTurns: 8 },
    })) {
      turnCount += message.type === "assistant" ? 1 : 0;
      toolCallCount += countToolCalls(message);
    }
  } catch (error) {
    status = "failed";
    throw error;
  } finally {
    await telemetry.log("agent_run_completed", {
      run_id: runId,
      workflow: "support_resolution",
      agent_name: "support_agent",
      status,
      turn_count: turnCount,
      tool_call_count: toolCallCount,
      duration_ms: Math.round(performance.now() - startedAt),
      release: process.env.APP_RELEASE,
    });
  }
}

イベント契約

run_id、ワークフロー、agent_name、model_alias、および prompt_version

ステータス、duration_ms、turn_count、tool_call_count、および estimated_cost_usd

permission_denial_count、max_turns_reached、reviewer_outcome、リリース、環境

実装のチェックポイント

チェックポイント 1

パブリック クエリまたはクライアント境界をラップし、SDK ストリームが最終結果に到達した後に 1 つのアプリケーション結果を出力します。文書化されていないメッセージ フィールドには依存しません。

チェックポイント 2

Anthropic の SDK の可観測性またはステップレベルの診断のトレースを保持し、承認された集計結果フィールドのみを Telemetry に送信します。

チェックポイント 3

完了率を警告する前に、権限の拒否、ツールの失敗、最大回転数、キャンセル、プロセスのシャットダウン パスを実行します。

検証

イベントが到着したことを証明する

既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。

claude-agent-sdk-検証

Claude Agent SDK Telemetry 検証クエリ

sql
SELECT *
FROM agent_run_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
論理結果ごとに 1 つのターミナル行を、予想されるステータス、識別子、単位、および UTC 時刻とともに確認します。
推論されたスキーマを検査し、再試行によってフィールド タイプが変更されたり、新しい論理イベント ID が生成されたりしないことを確認します。
保存されたフィールドで認証情報、生のペイロード、プロンプト、プライベート コンテンツ、および無制限のエラー メッセージを検索します。
ダッシュボードを完了として扱う前に、プロバイダーのタイムアウト、取り込みの拒否、およびプロセスのシャットダウンを実行します。

実装の参考資料

新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。

生産境界

結果イベントを小さく、回復可能なものに保つ

このパターンが提供するのは、

  • 上流のワークフローの横にある、制限付きの SQL 対応の結果。
  • ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
  • 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。

このパターンでは提供されません

  • OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
  • ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
  • 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。

イベントスキーマの開始点

クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。

関連製品の機能

このワークフローを続行します AIエージェントの監視

レビュー可能な SQL を使用して、エージェントの実行、ツールの使用、モデルのコスト、品質、製品の結果を結び付けます。

関連する SQL レシピ

SQL で次の質問に答えてください

このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。

すべてのレシピを参照する
完全なコレクションAIとLLM SQL構造化イベント SQL

実装ファミリーごとに参照する

関連する統合パターンを比較する

この統合と組み合わせるテンプレート

さらなる統合