跳转到内容
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-安装

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-验证

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 回答下一个问题

针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成