本文へ移動
Telemetry
イベント記録のテンプレート

API エラーと遅延モニター

リクエストの量、ステータス コード、ルートの遅延、障害が発生したエンドポイント、および顧客に影響を与える API インシデントを監視します。

レビュー者 Telemetry 製品チーム . イベント名、推奨項目、クエリで答える問い、除外するデータを確認しました. このページのレビュー担当

これにより解き明かされる質問
  • p95 レイテンシで最も遅いルートはどれですか?
  • どの顧客がエラーの増加の影響を受けますか?
  • トラフィックがどこで減少または急増しましたか?
テンプレートの証拠パス

API error and latency monitor: 実装から決定まで

プロンプトを実装の概要として扱います。有用な成果物は、コピーされたコードだけではなく、信頼できる答えを生成するレビューされたイベント コントラクトです。

  1. 1

    境界を設定する

    Instrument the point where api_request_started becomes final.

  2. 2

    契約書を作成する

    Start with api_request_started, api_request_completed, api_request_failed and keep every field typed, bounded, and privacy-reviewed.

  3. 3

    フィクスチャを実行する

    集計結果に依存する前に、既知の成功、失敗、再試行、および空の結果のケースを実行してください。

  4. 4

    質問に答えてください

    p95 レイテンシで最も遅いルートはどれですか?

テンプレートとユースケースの比較

このテンプレートでイベントを追加する

測定目標がすでに明確な場合は、このテンプレートをコピーします。一致するユースケース ガイドを使用して、イベントの境界、成功の定義、および結果の SQL がサポートする必要がある決定を確認します。

読み取り API 信頼性監視

テンプレート

これをコーディングエージェントに貼り付けます

交換する YOUR_API_KEY、フローをローカルで実行し、生成されたイベントとダッシュボードを確認します。

api-error-monitor

API エラーと遅延モニター

text
Telemetry を API リクエスト処理に追加します。

/skill.md とこの Telemetry API キーを使用します: YOUR_API_KEY

重要な各 API リクエストを次のように記録します。
route_template、method、status_code、status、latency_ms、user_id、team_id、request_size_bytes、response_size_bytes、error_type、およびfeature。

リクエスト量、エラー率、p50 レイテンシ、p95 レイテンシ、および上位の障害エンドポイントのグラフを作成します。 5xx スパイク、遅い p95 レイテンシー、およびトラフィックの低下に関するアラートを追加します。

リクエスト本文、Cookie、認証ヘッダー、シークレット、または生のユーザー コンテンツをログに記録しないでください。

キャプチャするイベント

api_request_startedapi_request_completedapi_request_failedapi_rate_limitedapi_timeout

検証チェックリスト

完全なインストルメンテーション パスが後に残すもの

イベント

合成イベントは、安定した名前とフィールド タイプで目的のテーブルに到達します。

クエリ

最初の SQL クエリは、明示的な時間枠を使用して妥当な行を返します。

ビュー

ダッシュボードでは実際のフィールドが使用され、変更を説明するのに十分なコンテキストが含まれています。

安全性

プロンプト、本文、資格情報、署名、およびプライベート コンテンツの編集がチェックされました。

イベントスキーマの例

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

関連製品の機能

このワークフローを続行します アラート

レビューされた信頼性クエリを、所有するしきい値と応答のワークフローにプロモートします。

関連する SQL レシピ

その他のSQL例

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

すべてのレシピを参照する
API の信頼性初心者

ルートごとの API リクエスト スループットの計算

1 分あたり最も多くのリクエストを処理している API ルートはどれですか?

レシピを開く
API の信頼性中級者

API 429 レート制限回復の測定

HTTP 429 を受信したリクエストは、再試行後に正常に回復しますか?

レシピを開く
インフラストラクチャー上級者向け

インシデントの検出と復旧時間を計算する

各サービスがインシデントを検出して回復するまでにどれくらいの時間がかかりますか?

レシピを開く
API の信頼性初心者

ルート別のAPIエラー率の計算

リクエストが 20 件以上ある API ルートのうち、5xx エラー率が最も高いのはどれですか?

レシピを開く
API の信頼性中級者

p50、p95、p99 API レイテンシの計算

テール レイテンシが最も悪いエンドポイントはどれですか?

レシピを開く
API の信頼性初心者

ルートごとの API タイムアウト率の計算

ユーザーに影響を与えるほど頻繁にタイムアウトになる API ルートはどれですか?

レシピを開く
API の信頼性中級者

依存関係の比較 p95 レイテンシー

テール レイテンシーと失敗率が最も悪いダウンストリームの依存関係はどれですか?

レシピを開く
API の信頼性中級者

SLO に対する API の可用性の測定

各サービスは 1 日あたりの可用性目標を達成しましたか?

レシピを開く
API の信頼性中級者

API エラーバジェット燃焼率の計算

API は 99.9% の可用性予算をどれくらいの速さで消費していますか?

レシピを開く
API の信頼性初心者

顧客の影響によるエラーのフィンガープリントのランク付け

最も多くの顧客アカウントに影響を与えるエラー グループはどれですか?

レシピを開く
API の信頼性初心者

機能ロールアウトエラー率の比較

機能フラグのロールアウトは、コントロール コホートよりも信頼性が低いですか?

レシピを開く
API の信頼性中級者

インシデントの顧客への影響を計画ごとに測定する

各計画でインシデントの影響を受けたアカウントの数は何ですか?

レシピを開く

その他のテンプレート