跳转到内容
Telemetry
集成指南

Azure OpenAI 响应 Telemetry

通过可编辑的 SQL 就绪事件跟踪 Azure OpenAI 部署使用情况、令牌成本、延迟、故障和产品结果。

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

有用于
  • Azure 部署成本归因
  • 区域模型可靠性
  • 响应 API 工作流程监控
实施证据

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

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

  1. 1

    选择结果

    Azure 部署成本归因

  2. 2

    定义合同

    提供商、部署、型号、区域、功能和状态

  3. 3

    埋点边界

    将 Azure 部署名称与返回的模型标识符分开。

  4. 4

    核实证据

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

开始之前

先决条件和界限

  • 服务器端 Azure OpenAI 凭据和 TELEMETRY_API_KEY
  • 稳定的部署、区域、功能和提示版本合约
  • 已部署模型的版本化价格查找

交货设置

安装并初始化服务器端

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

azure-openai-安装

npm安装

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

片段

从一个结构化事件开始

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

azure-openai

Azure OpenAI Responses Telemetry事件

javascript
import OpenAI from "openai";
import telemetry from "telemetry-sh";

const azure = new OpenAI({
  apiKey: process.env.AZURE_OPENAI_API_KEY,
  baseURL: process.env.AZURE_OPENAI_BASE_URL,
});
const startedAt = performance.now();

try {
  const response = await azure.responses.create({
    model: process.env.AZURE_OPENAI_DEPLOYMENT,
    input: userInput,
  });

  await telemetry.log("llm_request_completed", {
    provider: "azure_openai",
    deployment: process.env.AZURE_OPENAI_DEPLOYMENT,
    model: response.model,
    region: process.env.AZURE_REGION,
    feature: "document_summary",
    status: "success",
    latency_ms: Math.round(performance.now() - startedAt),
    input_tokens: response.usage?.input_tokens,
    output_tokens: response.usage?.output_tokens,
    total_tokens: response.usage?.total_tokens,
    prompt_version: "summary-v3",
  });

  return response;
} catch (error) {
  await telemetry.log("llm_request_completed", {
    provider: "azure_openai",
    deployment: process.env.AZURE_OPENAI_DEPLOYMENT,
    feature: "document_summary",
    status: "failed",
    latency_ms: Math.round(performance.now() - startedAt),
    error_type: classifyProviderError(error),
  });
  throw error;
}

活动合约

提供商、部署、型号、区域、功能和状态

input_tokens、output_tokens、total_tokens、latency_ms 和 estimated_cost_usd

response_id、prompt_version、error_type 和接受的结果

实施检查点

检查站 1

将 Azure 部署名称与返回的模型标识符分开。

检查站 2

从响应中读取使用情况并应用与部署关联的价格版本。

检查站 3

未经明确批准,请勿记录提示、输出、API 凭证、最终用户标识符或原始提供程序错误主体。

验证

证明事件已到达

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

azure-openai-验证

Azure OpenAI Responses Telemetry 验证查询

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

实施参考

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

生产边界

保持结果事件小且可恢复

该模式提供了

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

该模式不提供

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

事件架构起点

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

相关产品功能

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

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

相关 SQL 查询示例

用 SQL 回答下一个问题

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

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成