Google Cloud Pub/Sub Telemetry: 境界から検証された行まで
制御されたアプリケーション境界で Google Cloud Pub/Sub Telemetry を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。
- 1
結果を選択してください
Pub/Sub 配信の信頼性
- 2
契約を定義する
message_id、message_type、トピック、サブスクリプション、ordering_key_category、およびリリース
- 3
境界を計測する
Pub/Sub はメッセージを再配信できます。プロバイダーのメッセージ ID と配信試行は、最終的なビジネス結果とは別にしてください。
- 4
証拠を検証する
Exercise a known fixture, then inspect pubsub_message_completed for one correctly typed terminal row.
始める前に
前提条件と境界
- 信頼できるパブリッシャーまたはサブスクライバーで初期化された @google-cloud/pubsub および telemetry-sh
- 安定したトピック、サブスクリプション、メッセージ タイプ、および論理結果の定義
- べき等コンシューマと文書化された確認または 1 回限りのポリシー
配信設定
サーバー側のインストールと初期化
サーバー専用コードで telemetry-sh をインポートし、process.env.TELEMETRY_API_KEY で一度初期化します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。
npmのインストール
npm install telemetry-sh- 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
- 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
- 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。
スニペット
1 つの構造化されたイベントから始める
ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。
Google Cloud Pub/Sub Telemetryイベント
await telemetry.log("pubsub_message_completed", {
message_id: message.id,
message_type: "account_export",
topic: "account-exports",
subscription: "account-export-worker",
status: "success",
delivery_attempt: message.deliveryAttempt ?? 1,
wait_ms: Date.now() - Number(message.publishTime.getTime()),
duration_ms: Math.round(performance.now() - startedAt),
acknowledged: true,
dead_lettered: false,
service: "export-worker",
release: process.env.APP_RELEASE,
});イベント契約
message_id、message_type、トピック、サブスクリプション、ordering_key_category、およびリリース
ステータス、delivery_attempt、wait_ms、duration_ms、確認済み、および error_type
dead_lettered、published_at、account_id、サービス、リージョン、および環境
実装のチェックポイント
チェックポイント 1
Pub/Sub はメッセージを再配信できます。プロバイダーのメッセージ ID と配信試行は、最終的なビジネス結果とは別にしてください。
チェックポイント 2
1 回限りの配信にはサブスクリプションと地域の制約があるため、確認応答から推測するのではなく、実際の構成を確認してください。
チェックポイント 3
アプリケーションの結果のほかにプロバイダーのバックログ メトリックを監視し、メッセージ データ、プライベート コンテンツを含む属性、または無制限のエラーをイベントにコピーしないでください。
検証
イベントが到着したことを証明する
既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。
Google Cloud Pub/Sub Telemetry 検証クエリ
SELECT *
FROM pubsub_message_completed
ORDER BY timestamp_utc DESC
LIMIT 20;実装の参考資料
新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。
生産境界
結果イベントを小さく、回復可能なものに保つ
このパターンが提供するのは、
- 上流のワークフローの横にある、制限付きの SQL 対応の結果。
- ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
- 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。
このパターンでは提供されません
- OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
- ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
- 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。
イベントスキーマの開始点
このワークフローのイベント コントラクト
クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。
関連製品の機能
このワークフローを続行します アラート
レビューされた信頼性クエリを、所有するしきい値と応答のワークフローにプロモートします。
関連する SQL レシピ
SQL で次の質問に答えてください
このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。
実装ファミリーごとに参照する
関連する統合パターンを比較する
この統合と組み合わせるテンプレート
さらなる統合