# バッチ設計書 7-queue:monitor

## 概要

本ドキュメントは、Laravelフレームワークのキューモニタリングコマンド `queue:monitor` の設計仕様を記載したものです。本バッチは指定されたキューのサイズを監視し、閾値を超えた場合にアラートを発生させる機能を提供します。

### 本バッチの処理概要

`queue:monitor` コマンドは、指定された1つ以上のキューのサイズ（ジョブ数）を取得し、設定された最大値を超えている場合にQueueBusyイベントを発火するバッチ処理です。監視結果はコンソールに表示され、JSON形式での出力も可能です。

**業務上の目的・背景**：キューシステムの健全性を維持するためには、キューのバックログ（未処理ジョブ数）を監視することが重要です。ジョブの処理速度が投入速度を下回ると、キューが肥大化し、処理遅延やメモリ問題を引き起こす可能性があります。本コマンドにより、キューサイズが閾値を超えた際にアラートを発生させ、運用チームが迅速に対応できるようにします。定期実行と監視システムとの連携が一般的な使用方法です。

**バッチの実行タイミング**：cron等による定期実行（1分〜5分間隔）、または監視システムからのポーリング。

**主要な処理内容**：
1. 引数からモニタリング対象のキューリストを解析
2. 各キューのサイズを取得（pending, delayed, reserved含む）
3. 閾値（--max）との比較でステータスを判定
4. 結果をコンソールに表示（または JSON出力）
5. 閾値超過キューに対してQueueBusyイベントを発火

**前後の処理との関連**：QueueBusyイベントをリスナーで購読し、Slack通知やメール通知を実装可能。`queue:work` でワーカー数を増やす対応につなげることができます。

**影響範囲**：データベースやキューストレージへの参照のみ。イベント発火により通知システムに影響を与える可能性があります。

## バッチ種別

監視 / ヘルスチェック

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 定期実行（1分〜5分間隔推奨） |
| 実行時刻 | 毎分または5分間隔 |
| 実行曜日 | 毎日 |
| 実行日 | 毎日 |
| トリガー | cron / 監視システム |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| キュー接続設定 | 監視対象のキュー接続が設定されていること |
| イベントシステム | QueueBusyイベントのリスナーが設定されていること（推奨） |

### 実行可否判定

- 特別な実行条件なし
- キュー接続が利用可能であれば実行可能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| queues | string | Yes | - | 監視対象のキュー名（カンマ区切り、connection:queue形式も可） |
| --max | int | No | 1000 | アラート発火の閾値（ジョブ数） |
| --json | bool | No | false | JSON形式で出力 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| jobs テーブル/キュー | DB/Redis等 | キューサイズ情報 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト/JSON | キューサイズとステータス |
| イベント | QueueBusy | 閾値超過時に発火 |

### 出力ファイル仕様

該当なし（ファイル出力は行わない）

## 処理フロー

### 処理シーケンス

```
1. キュー引数解析
   └─ カンマ区切りのキュー文字列をパース
2. 各キューの情報取得
   └─ connection:queue形式を分解し、サイズを取得
3. ステータス判定
   └─ sizeと--max閾値を比較
4. 結果表示
   └─ テーブル形式またはJSON形式で出力
5. イベント発火
   └─ 閾値超過キューに対してQueueBusyイベントをディスパッチ
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[queues引数を解析]
    B --> C[各キューをループ]
    C --> D[キュー接続とキュー名を分解]
    D --> E[キューサイズを取得]
    E --> F[pending/delayed/reserved取得]
    F --> G{size >= max?}
    G -->|Yes| H[ステータス: ALERT]
    G -->|No| I[ステータス: OK]
    H --> J[キュー情報を配列に追加]
    I --> J
    J --> K{残りキューあり?}
    K -->|Yes| C
    K -->|No| L{--json指定?}
    L -->|Yes| M[JSON形式で出力]
    L -->|No| N[テーブル形式で出力]
    M --> O[ALERTキューにイベント発火]
    N --> O
    O --> P[バッチ終了]
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| サイズ取得 | jobs | SELECT COUNT | キューサイズをカウント |

### テーブル別操作詳細

#### jobs（データベースキュー使用時）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT COUNT | - | queue = 指定キュー名 | 参照のみ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | キュー接続失敗 | 指定接続が利用不可 | 接続設定を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

1. 接続エラー時は監視システムでエラーを検知
2. 次回の定期実行で再監視

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（参照のみ） |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 監視対象キュー数分 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 最小限 |

## 排他制御

- 排他制御不要（参照のみ）
- 複数プロセスから同時実行可能
- Isolatableインターフェースは未実装

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | なし | なし |
| 進捗ログ | なし | なし |
| 結果ログ | 処理完了時 | キュー名、サイズ、ステータス |
| エラーログ | エラー発生時 | 接続エラー等 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| キューサイズ | --max オプション値 | QueueBusyイベント |
| 最古のジョブ | oldest_pending（対応ドライバのみ） | 参考情報として表示 |

## 備考

- キュー指定形式: `queue_name` または `connection:queue_name`
- JSON出力モードは監視システムとの連携に有用
- QueueBusyイベントで以下の情報を通知:
  - connection: キュー接続名
  - queue: キュー名
  - size: 現在のジョブ数
- 追加情報（対応ドライバのみ）:
  - pending: 待機中ジョブ数
  - delayed: 遅延ジョブ数
  - reserved: 予約済みジョブ数
  - oldest_pending: 最古の待機ジョブの作成時刻
- イベントリスナーでSlack、メール、PagerDuty等への通知を実装可能
- 定期実行にはcronまたはタスクスケジューラの使用を推奨
