跳至主要內容
Telemetry
整合指南

克勞德代理SDK Telemetry

追蹤 Claude Agent SDK 執行結果、持續時間、工具活動、週轉、成本和批准的產品訊號,無需儲存提示或工具負載。

審閱者 Telemetry產品團隊 . 埋點合約、隱私邊界和實施指南. 審查標準和所有權

有用於
  • Claude 代理執行可觀測性
  • 工具環可靠性
  • 代理成本和結果分析
實施證據

Claude Agent SDK Telemetry:從邊界到驗證行

在受控應用程式邊界使用 Claude Agent SDK Telemetry,保持事件契約較小,並在建置聚合檢視之前驗證已知結果。

  1. 1

    選擇結果

    Claude 代理執行可觀測性

  2. 2

    定義合約

    run_id、工作流程、agent_name、model_alias 和 prompt_version

  3. 3

    埋點邊界

    包裝公共查詢或客戶端邊界,並在 SDK 流到達最終結果後發出一個應用程式結果;不依賴於未記錄的訊息欄位。

  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-install

npm安裝

bash
npm install telemetry-sh
  1. 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
  2. 2在成功、失敗、重試或超時邊界處新增結果事件。
  3. 3在啟用警示之前傳送受控裝置並檢查儲存的行。

片段

從一個結構化事件開始

在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。

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 流到達最終結果後發出一個應用程式結果;不依賴於未記錄的訊息欄位。

檢查站 2

保留 Anthropic 的 SDK 可觀測性或追蹤以進行步驟級診斷,並僅將批准的聚合結果欄位傳送到 Telemetry。

檢查站 3

在發出完成率警示之前,執行權限拒絕、工具故障、最大週轉、取消和流程關閉路徑。

驗證

證明事件已到達

在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同,請替換後備資料表名稱。

claude-agent-sdk-verification

Claude Agent SDK Telemetry 驗證查詢

sql
SELECT *
FROM agent_run_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
確認每個邏輯結果的一個終端行,以及預期狀態、識別符號、單位和 UTC 時間。
檢查推斷的架構並驗證重試不會更改欄位型別或生成新的邏輯事件 ID。
在儲存的欄位中搜尋憑據、原始有效負載、提示、私有內容和無限制的錯誤訊息。
在將儀表板視為完整之前,請執行提供程式超時、攝取拒絕和處理程序關閉。

實施參考

在啟用新的生產路徑之前,請檢查事件合約、資料安全指南和上游主要文件。

生產邊界

保持結果事件小且可恢復

該模式提供了

  • 除了上游工作流程之外,還有一個有界的、SQL 就緒的結果。
  • 用於儀表板、警示和跨事件關聯的穩定欄位。
  • 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。

該模式不提供

  • OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
  • 僅因為有效負載包含事件 ID,所以僅傳送一次。
  • 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。

事件架構起點

在將查詢或程式碼片段適應生產之前,請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。

相關產品功能

繼續此工作流程 AI代理監控

透過可審查的 SQL 連線代理執行、工具使用、模型成本、品質和產品結果。

相關 SQL 查詢範例

用 SQL 回答下一個問題

針對此工作流程中的結構化欄位執行查詢,檢查範例結果,並將有用的答案轉換為儀表板或警示。

瀏覽所有查詢範例

按實施系列瀏覽

比較相關整合模式

與此整合配對的範本

更多整合