本文へ移動
Telemetry
統合ガイド

Supabase および Postgres アプリ Telemetry

製品ワークフロー、データベース隣接ジョブ、API ルート、および顧客対応の障害をサーバー コードから追跡します。

レビュー者 Telemetry 製品チーム . 送信するイベント、除外するデータ、コードの追加方法を確認しました. このページのレビュー担当

役に立つ
  • API の信頼性
  • アクティベーションの追跡
  • 動作デバッグ
実装の証拠

Supabase and Postgres app telemetry でイベントを送信して確認する

制御されたアプリケーション境界で Supabase and Postgres app telemetry を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。

  1. 1

    結果を選択してください

    API の信頼性

  2. 2

    契約を定義する

    function_name、route_template、メソッド、status_code、およびリージョン

  3. 3

    結果で発行する

    Telemetry キーと Supabase シークレットまたはサービス ロールの資格情報をサーバー側の関数シークレットに保持します。決してブラウザコードに公開しないでください。

  4. 4

    証拠を検証する

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

始める前に

始める前に

  • Supabase エッジ機能または Telemetry シークレットを持つその他の信頼できるサーバー ランタイム
  • 行レベルのセキュリティとアプリケーション認可は、特権データベース作業の前に適用されます。
  • データベースに直接アクセスするための、プールされた、またはサーバーレスに適した Postgres 接続パス

配信設定

サーバー側のインストールと初期化

サーバー専用コードで telemetry-sh をインポートし、process.env.TELEMETRY_API_KEY で一度初期化します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。

supabase-postgres-インストール

npmのインストール

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

スニペット

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

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

supabase-postgres

Supabase and Postgres app telemetryイベント

javascript
await telemetry.log("api_request_completed", {
  function_name: "sync-project",
  route_template: "/api/projects/:id/sync",
  method: "POST",
  status_code: 200,
  status: "success",
  latency_ms: 266,
  database_operation: "sync_project",
  team_id: team.id,
  region: Deno.env.get("SB_REGION"),
});

イベントスキーマ

function_name、route_template、メソッド、status_code、およびリージョン

ステータス、latency_ms、database_operation、rows_affected、および error_type

request_id、account_id、リリース、環境

設定を確認する

チェックポイント 1

Telemetry キーと Supabase シークレットまたはサービス ロールの資格情報をサーバー側の関数シークレットに保持します。決してブラウザコードに公開しないでください。

チェックポイント 2

SQL テキスト、接続文字列、リクエスト本文、または無制限のデータベース エラーではなく、アプリケーションの結果をログに記録します。

チェックポイント 3

診断のために区別が必要な場合は、関数のレイテンシをデータベース操作のレイテンシから分離します。

検証

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

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

supabase-postgres-検証

Supabase and Postgres app telemetry 検証クエリ

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

実装の参考資料

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

イベントを記録する場所

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

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

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

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

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

イベントスキーマの例

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

関連製品の機能

このワークフローを続行します ダッシュボード

検証された製品または収益のクエリを、焦点を絞った意思決定の表面に変えます。

関連する SQL レシピ

その他のSQL例

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

すべてのレシピを参照する

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

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

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

さらなる統合