跳转到内容
Telemetry
集成指南

OpenAI 响应 API Telemetry

测量 OpenAI 响应 API 延迟、令牌使用、工具活动、故障和下游结果,而无需收集提示或生成的内容。

审阅者 Telemetry产品团队 . 埋点合约、隐私边界和实施指南. 审查标准和所有权

有用于
  • 响应 API 成本和延迟分析
  • 模型和特征可靠性
  • AI 结果和接受度衡量
实施证据

OpenAI Responses API Telemetry:从边界到验证行

在受控应用程序边界使用 OpenAI Responses API Telemetry,保持事件契约较小,并在构建聚合视图之前验证已知结果。

  1. 1

    选择结果

    响应 API 成本和延迟分析

  2. 2

    定义合同

    operation_id、response_id、功能、工作流程、提供程序、模型和版本

  3. 3

    埋点边界

    包装应用程序拥有的 Responses API 调用,并在了解使用情况和结果后发出一个终端请求事件。

  4. 4

    核实证据

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

开始之前

先决条件和界限

  • 官方 OpenAI JavaScript SDK 和 telemetry-sh 在可信服务器代码中初始化
  • 应用程序拥有的操作 ID 以及稳定的功能、工作流程、模型别名和版本名称
  • 经过审查的提示、响应、工具和标识符数据的策略

交货设置

安装并初始化服务器端

在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。

openai-responses-api-安装

npm安装

bash
npm install telemetry-sh
  1. 1准备一个具有有限网络行为的可重用服务器端交付客户端。
  2. 2在成功、失败、重试或超时边界处添加结果事件。
  3. 3在启用警报之前发送受控装置并检查存储的行。

片段

从一个结构化事件开始

在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。

openai-responses-api

OpenAI Responses API Telemetry事件

javascript
import OpenAI from "openai";
import { Telemetry } from "telemetry-sh";

const openai = new OpenAI();
const telemetry = new Telemetry(process.env.TELEMETRY_API_KEY);

const startedAt = performance.now();
let response;
let status = "success";
let errorType;

try {
  response = await openai.responses.create({
    model: process.env.OPENAI_MODEL ?? "gpt-5.6",
    input: approvedInput,
  });
  return response.output_text;
} catch (error) {
  status = "failed";
  errorType = classifyOpenAIError(error);
  throw error;
} finally {
  await telemetry.log("openai_response_completed", {
    operation_id: operationId,
    response_id: response?.id,
    feature: "support_draft",
    provider: "openai",
    model: response?.model ?? process.env.OPENAI_MODEL ?? "gpt-5.6",
    status,
    error_type: errorType,
    duration_ms: Math.round(performance.now() - startedAt),
    input_tokens: response?.usage?.input_tokens ?? 0,
    output_tokens: response?.usage?.output_tokens ?? 0,
    total_tokens: response?.usage?.total_tokens ?? 0,
    release: process.env.APP_RELEASE,
  });
}

活动合约

operation_id、response_id、功能、工作流程、提供程序、模型和版本

状态、duration_ms、input_tokens、output_tokens、total_tokens、retry_count 和 error_type

tool_call_count,已接受,human_handoff、estimated_cost_usd 和 pricing_version(已批准)

实施检查点

检查站 1

包装应用程序拥有的 Responses API 调用,并在了解使用情况和结果后发出一个终端请求事件。

检查站 2

提供商使用支持代币记账,但成本是应用程序拥有的估计,需要过时的价格来源和单独的对账。

检查站 3

默认情况下,将提示、生成的输出、工具参数、工具结果、API 密钥和不受限制的异常消息保留在事件之外。

验证

证明事件已到达

在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。

openai-responses-api-验证

OpenAI Responses API Telemetry 验证查询

sql
SELECT *
FROM openai_response_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
确认每个逻辑结果的一个终端行,以及预期状态、标识符、单位和 UTC 时间。
检查推断的架构并验证重试不会更改字段类型或生成新的逻辑事件 ID。
在存储的字段中搜索凭据、原始有效负载、提示、私有内容和无限制的错误消息。
在将仪表板视为完整之前,请执行提供程序超时、摄取拒绝和进程关闭。

实施参考

在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。

生产边界

保持结果事件小且可恢复

该模式提供了

  • 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
  • 用于仪表板、警报和跨事件关联的稳定字段。
  • 用于验证成功、失败、重试和超时行为的夹具驱动路径。

该模式不提供

  • OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
  • 仅因为有效负载包含事件 ID,所以仅传送一次。
  • 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。

事件架构起点

在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。

相关产品功能

继续此工作流程 AI代理监控

通过可审查的 SQL 连接智能体运行、工具使用、模型成本、质量和产品结果。

相关 SQL 查询示例

用 SQL 回答下一个问题

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

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成