AWS SQS Queue Observability: 境界から検証された行まで
制御されたアプリケーション境界で AWS SQS Queue Observability を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。
- 1
結果を選択してください
SQS 消費者監視
- 2
契約を定義する
queue_name、message_id、receive_count、およびステータス
- 3
境界を計測する
メッセージのメタデータと許可リストに登録された属性を使用します。メッセージ本文は決して送信しないでください。
- 4
証拠を検証する
Exercise a known fixture, then inspect queue_message_completed for one correctly typed terminal row.
始める前に
前提条件と境界
- サーバー側 TELEMETRY_API_KEY
- 安全な相関のための SQS メッセージ属性
- 文書化された部分バッチ障害ポリシー
配信設定
サーバー側のインストールと初期化
サーバー専用コードで telemetry-sh をインポートし、process.env.TELEMETRY_API_KEY で一度初期化します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。
npmのインストール
npm install telemetry-sh- 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
- 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
- 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。
スニペット
1 つの構造化されたイベントから始める
ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。
AWS SQS Queue Observabilityイベント
await telemetry.log("queue_message_completed", {
queue_name: process.env.QUEUE_NAME,
message_id: record.messageId,
receive_count: Number(record.attributes.ApproximateReceiveCount),
message_age_ms: Date.now() - Number(record.attributes.SentTimestamp),
status: "success",
duration_ms: performance.now() - startedAt,
consumer: context.functionName,
});イベント契約
queue_name、message_id、receive_count、およびステータス
message_age_ms、duration_ms、batch_size、および error_type
消費者、地域、環境、リリース
実装のチェックポイント
チェックポイント 1
メッセージのメタデータと許可リストに登録された属性を使用します。メッセージ本文は決して送信しないでください。
チェックポイント 2
部分的なバッチ応答を使用する場合は、メッセージごとに 1 つの結果を記録します。
チェックポイント 3
処理エラーをデッドレターキューへの意図的なリドライブから分離します。
検証
イベントが到着したことを証明する
既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。
AWS SQS Queue Observability 検証クエリ
SELECT *
FROM queue_message_completed
ORDER BY timestamp_utc DESC
LIMIT 20;実装の参考資料
新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。
生産境界
結果イベントを小さく、回復可能なものに保つ
このパターンが提供するのは、
- 上流のワークフローの横にある、制限付きの SQL 対応の結果。
- ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
- 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。
このパターンでは提供されません
- OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
- ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
- 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。
イベントスキーマの開始点
このワークフローのイベント コントラクト
クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。
関連製品の機能
このワークフローを続行します アラート
レビューされた信頼性クエリを、所有するしきい値と応答のワークフローにプロモートします。
関連する SQL レシピ
SQL で次の質問に答えてください
このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。
ジョブごとのキュー待ち時間の測定
ワーカーが開始するまでに最も長く待機するジョブはどれですか?
レシピを開くSQL で停止したバックグラウンド ジョブを見つける
開始されたが、最終イベントを生成しなかったジョブはどれですか?
レシピを開く配信不能キューの増加を測定する
デッドレター ジョブを解決するよりも早く追加しているキューはどれですか?
レシピを開く実装ファミリーごとに参照する
関連する統合パターンを比較する
この統合と組み合わせるテンプレート
さらなる統合
Sidekiq ジョブ Telemetry
ジョブ引数をコピーせずに、Sidekiq の実行結果、試行、キュー待機、エラー、サーバー ミドルウェアからのリリースを追跡します。
オープンガイドIngest and Trigger.dev ジョブ Telemetry
SQL 対応ログを使用して、非同期ワーカー、スケジュールされたジョブ、再試行、失敗、配信不能イベントを計測します。
オープンガイドワークフローの一時的な可観測性
ワークフロー ペイロードを記録することなく、一時的なワークフローの結果、アクティビティの再試行、スケジュールから開始までの待ち時間、ビジネス マイルストーンを追跡します。
オープンガイド