本文へ移動
統合ガイド

BullMQ キューの監視

SQL 対応ライフサイクル イベントを使用して、BullMQ キューの待機、実行期間、再試行、失敗、配信不能レターの増加を測定します。

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

役に立つ
  • BullMQ ワーカーの健康状態
  • Redis キューのレイテンシ
  • デッドレターの監視
実装の証拠

BullMQ queue monitoring でイベントを送信して確認する

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

  1. 1

    結果を選択してください

    BullMQ ワーカーの健康状態

  2. 2

    契約を定義する

    job_id、job_name、queue_name、およびステータス

  3. 3

    結果で発行する

    attemptsMade の値をそのまま記録し、使用する BullMQ バージョンでの意味を確認してください。

  4. 4

    証拠を検証する

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

始める前に

始める前に

  • サーバー側 TELEMETRY_API_KEY
  • 安定したジョブ名とキュー名
  • ジョブのタイムスタンプは再試行後も保持される

配信設定

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

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

bullmq-インストール

npmのインストール

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

スニペット

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

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

bullmq

BullMQ queue monitoringイベント

javascript
worker.on("completed", async (job, result) => {
  try {
    await telemetry.log("job_completed", {
      job_id: String(job.id),
      job_name: job.name,
      queue_name: worker.name,
      status: "success",
      attempts_made: job.attemptsMade,
      enqueue_to_last_start_ms: job.processedOn - job.timestamp,
      duration_ms: job.finishedOn - job.processedOn,
      item_count: result?.itemCount,
    });
  } catch {
    // Keep observer delivery failure out of the completed job.
    try {
      console.warn("Telemetry completion-event delivery failed");
    } catch {}
  }
});

イベントスキーマ

job_id、job_name、queue_name、およびステータス

attempts_made、enqueue_to_last_start_ms、duration_ms、error_type

item_count、worker_name、およびリリース

設定を確認する

チェックポイント 1

attemptsMade の値をそのまま記録し、使用する BullMQ バージョンでの意味を確認してください。

チェックポイント 2

登録から最後の開始までの時間には、過去の試行とバックオフの待ち時間も含まれます。キューでの待ち時間だけではありません。

チェックポイント 3

この worker ローカルのフックは成功したジョブのみを観測します。送信エラーを処理し、終了時に保留中の送信を待つ方法を決めてください。

チェックポイント 4

job.data には顧客のペイロードが含まれることが多いため、絶対にログに記録しないでください。

検証

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

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

bullmq-検証

BullMQ queue monitoring 検証クエリ

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

実装の参考資料

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

イベントを記録する場所

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

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

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

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

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

イベントスキーマの例

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

関連製品の機能

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

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

関連する SQL レシピ

その他のSQL例

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

すべてのレシピを参照する
クエリ例のコレクションバックグラウンドジョブ SQL

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

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

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

さらなる統合