本文へ移動
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 呼び出しをラップし、使用法と結果がわかった後で 1 つの端末要求イベントを発行します。

  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制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
  2. 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
  3. 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。

スニペット

1 つの構造化されたイベントから始める

ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。

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 呼び出しをラップし、使用法と結果がわかった後で 1 つの端末要求イベントを発行します。

チェックポイント 2

プロバイダーの使用量はトークン アカウンティングをサポートしますが、コストはアプリケーションが所有する見積もりであり、日付の価格ソースと個別の調整が必要です。

チェックポイント 3

デフォルトでは、プロンプト、生成された出力、ツールの引数、ツールの結果、API キー、および無制限の例外メッセージをイベントから除外します。

検証

イベントが到着したことを証明する

既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。

openai-responses-api-検証

OpenAI Responses API Telemetry 検証クエリ

sql
SELECT *
FROM openai_response_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
論理結果ごとに 1 つのターミナル行を、予想されるステータス、識別子、単位、および UTC 時刻とともに確認します。
推論されたスキーマを検査し、再試行によってフィールド タイプが変更されたり、新しい論理イベント ID が生成されたりしないことを確認します。
保存されたフィールドで認証情報、生のペイロード、プロンプト、プライベート コンテンツ、および無制限のエラー メッセージを検索します。
ダッシュボードを完了として扱う前に、プロバイダーのタイムアウト、取り込みの拒否、およびプロセスのシャットダウンを実行します。

実装の参考資料

新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。

生産境界

結果イベントを小さく、回復可能なものに保つ

このパターンが提供するのは、

  • 上流のワークフローの横にある、制限付きの SQL 対応の結果。
  • ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
  • 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。

このパターンでは提供されません

  • OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
  • ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
  • 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。

イベントスキーマの開始点

クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。

関連製品の機能

このワークフローを続行します AIエージェントの監視

レビュー可能な SQL を使用して、エージェントの実行、ツールの使用、モデルのコスト、品質、製品の結果を結び付けます。

関連する SQL レシピ

SQL で次の質問に答えてください

このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。

すべてのレシピを参照する
完全なコレクションAIとLLM SQL

実装ファミリーごとに参照する

関連する統合パターンを比較する

この統合と組み合わせるテンプレート

さらなる統合