本番環境の計装チェックリスト
このチェックリストは、合成イベント、クエリ、ダッシュボード、およびアラートがエンドツーエンドで動作した後に使用します。目標は、イベントを最大限にカバーすることではなく、所有者とフォールバックを伴う制限付きの実稼働ロールアウトです。
イベント契約
- イベント名は、1 つの永続的なワークフローの結果を表します。
- ビジネスの粒度（リクエスト、ジョブ、アカウント、エージェントの実行、Webhook、または別の安定した単位）が文書化されます。
- 必須フィールドとオプションのフィールドがタイプと単位とともにリストされます。
- ステータス、エラー、機能、リリース、および環境の値は、制限された語彙を使用します。
- 安定した識別子は、秘密を暴露することなく、関連するイベントを接続します。
- 再試行と繰り返しの試行は、最終的な結果とは区別できます。
レビュー イベントスキーマの設計, 正規のワイドイベント、そして 相関ID.
機密データの境界
- パスワード、API キー、認証ヘッダー、Cookie、およびセッション トークンは禁止されています。
- 未加工のリクエスト本文、Webhook ペイロード、プロンプト、完了、およびジョブ ペイロードは、個別にレビューしない限り表示されません。
- ルート テンプレートは、識別子を含む URL を置き換えます。
- 可能な場合、エラー カテゴリは生のプライベート コンテンツを置き換えます。
- 個人用フィールドまたは規制対象フィールドには、承認された目的、アクセス境界、および保存期間があります。
使用する 機密データの編集 そして セキュリティとデータの処理 レビュー中の概要。
資格情報と環境
- 本番環境の取り込みでは、名前付きの書き込みスコープのキーが使用されます。
- レポートの自動化では、読み取りスコープの別のキーが使用されます。
- キーはシークレット マネージャーまたは保護されたランタイム構成内に存在します。
- ステージングと実稼働では、別のキーと明示的なキーを使用します。
environmentフィールド。 - ローテーションと取り消しの所有権が記録されます。
デプロイされたすべての環境を確認するか、互換性のあるフォールバックを提供することなく、必須の環境変数を決して導入しないでください。
配信と失敗の動作
- Telemetry 配信には制限付きタイムアウトがあります。
- テレメトリの失敗によってアプリケーションの主要な結果が損なわれることはありません。
- 再試行は制限されており、監視可能です。
- シャットダウンまたはフラッシュの動作は、選択した SDK に対してテストされます。
- 大容量ループは、承認された理由がない限り、内部ステップごとにイベントを発行しません。
Telemetry エンドポイントが利用できないか遅い状態で、制御されたテストを実行します。アプリケーションは文書化されたフォールバックに従う必要があります。
スキーマとデータのライフサイクル
- 合成行は最終テーブルで検査されています。
- フィールド タイプは、既存のプロデューサーおよび保存されたクエリとの互換性を維持します。
- パーティションの選択には、実際のクエリ フィルターが反映されます。
- 保持は運用およびプライバシーの目的と一致します。
- 行とテーブルの削除責任を理解しています。
参照 スキーマの進化, パーティション列の選択、そして データの保持と削除.
分析と対応
- 最初に保存された SQL の結果は、既知のフィクスチャと一致します。
- 分母、除外、時間枠、およびアイデンティティ ルールが文書化されています。
- ダッシュボード ウィジェットは、検査可能な SQL または行に戻ります。
- すべてのアラートには、テスト済みのしきい値、受信者、および応答アクションがあります。
- コマーシャル、セキュリティ、または顧客のディメンションには、適切なアクセス境界があります。
を使用します。 SQL テスト方法 そして関連する SQL レシピ 結果を生産証拠として扱う前に。
徐々に展開していきます
1 つのサービス、ワーカー、またはルートから始めます。拡張する前に、イベントの量、スキーマの動作、クエリのコスト、配信の失敗、およびアラート ノイズを観察します。
記録:
- 所有者とレビュー日。
- 導入されたサービスとリリース。
- 予想される毎日のイベント量。
- 保存されたクエリとダッシュボードのリンク。
- アラート受信者と対応文書。
- 既知のギャップと次のレビューのトリガー。
ワークフローがこのチェックリストに合格した場合は、証拠に基づいて展開します。そうでない場合は、境界が明確になるまでイベントの開発またはステージングを続けてください。