跳至主要內容
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-install

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

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 回答下一個問題

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

瀏覽所有查詢範例

按實施系列瀏覽

比較相關整合模式

與此整合配對的範本

更多整合