# 通知設計書 66-秒数パラメータ待機

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzFirstストアドプロシージャにおける「秒数パラメータ待機」通知（RAISERROR）の設計を定義する。

### 本通知の処理概要

この通知は、sp_BlitzFirstの実行時に@Secondsパラメータで指定された秒数に達するまで待機処理を行うことを示す進捗情報メッセージである。

**業務上の目的・背景**：sp_BlitzFirstは「前後比較」方式でパフォーマンス診断を行う。第1パスのデータ収集後、調査クエリを実行し、その後@Seconds秒が経過するまで待機してから第2パスのデータを収集する。この待機時間は、サンプリング期間を確保するために必要である。デフォルトでは@Seconds = 5（5秒）が設定されている。この通知により、DBAは診断処理が待機フェーズに入ったことを確認できる。

**通知の送信タイミング**：sp_BlitzFirstの行2706で、調査クエリ完了後、現在時刻が@FinishSampleTimeより1秒以上前の場合にRAISERRORが発行される。つまり、まだ待機が必要な場合にのみ出力される。

**通知の受信者**：SSMSやその他のSQLクライアントツールを使用してストアドプロシージャを実行しているDBAまたはシステム管理者。

**通知内容の概要**：「Waiting to match @Seconds parameter」というメッセージが出力され、指定秒数に達するまでの待機開始を示す。

**期待されるアクション**：DBAはこのメッセージを確認することで、処理が待機フェーズに入ったことを把握できる。待機時間は@Secondsパラメータと調査クエリの実行時間に依存する。調査クエリが@Seconds秒以上かかった場合、この通知は出力されない。

## 通知種別

コンソール出力（RAISERROR WITH NOWAIT）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（WITH NOWAITによる即時出力） |
| 優先度 | 低（情報レベル - Severity 10） |
| リトライ | なし |

### 送信先決定ロジック

SSMSのメッセージペインまたはSQLクライアントツールの標準出力に対して自動的に送信される。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| メッセージレベル | 10（情報） |
| ステート | 1 |
| 形式 | テキスト |

### 本文テンプレート

```
Waiting to match @Seconds parameter
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | sp_BlitzFirst実行 | DATEADD(SECOND,1,SYSDATETIMEOFFSET()) < @FinishSampleTime | 残り待機時間が1秒以上ある場合のみ |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 調査クエリの実行時間 >= @Seconds秒 | 調査クエリが長時間かかった場合、待機は不要となりこの通知は出力されない |
| @Seconds = 0 | サーバー起動以降モードでは待機なし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[調査クエリ完了] --> B{現在時刻 < @FinishSampleTime - 1秒?}
    B -->|Yes| C[RAISERROR 'Waiting to match @Seconds parameter']
    B -->|No| F[待機スキップ]
    C --> D[WAITFOR TIME @FinishSampleTimeWaitFor]
    D --> E[第2パスキャプチャへ]
    F --> E
```

## データベース参照・更新仕様

### 参照テーブル一覧

この通知時点では参照は行われない。

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | - |

### 更新テーブル一覧

この通知時点では更新は行われない。

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | - |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | RAISERRORは情報レベルのため、エラーは発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし

## セキュリティ考慮事項

- この通知自体には機密情報は含まれない
- 待機時間中もサーバーリソースは消費されない（WAITFOR TIMEによる効率的な待機）

## 備考

- @Secondsのデフォルト値は5（秒）
- @Seconds = 0の場合、サーバー起動以降のデータを分析するモードとなり、待機は行われない
- 待機時間はWAITFOR TIME文で実装されており、CPU負荷なく効率的に待機する

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: パラメータ定義を理解する

@Secondsパラメータの定義と関連変数を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行11 - @Secondsパラメータ定義（デフォルト5） |
| 1-2 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | @FinishSampleTime, @FinishSampleTimeWaitFor変数 |

**読解のコツ**: @FinishSampleTimeは開始時刻に@Secondsを加算した値。

#### Step 2: エントリーポイントを理解する

通知が発行される箇所と条件を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行2703-2708の待機処理ブロック |

**主要処理フロー**:
1. **行2703**: コメント「End of checks. If we haven't waited @Seconds seconds, wait.」
2. **行2704**: IF DATEADD(SECOND,1,SYSDATETIMEOFFSET()) < @FinishSampleTime - 条件判定
3. **行2706**: RAISERROR - 待機開始通知
4. **行2707**: WAITFOR TIME @FinishSampleTimeWaitFor - 実際の待機

#### Step 3: 後続処理を理解する

待機後の処理フローを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行2710-2718（CPU使用率取得、第2パスキャプチャ準備） |

**主要処理フロー**:
- **行2710-2716**: @total_cpu_usage処理
- **行2718**: RAISERROR('Capturing second pass...')

### プログラム呼び出し階層図

```
sp_BlitzFirst
    |
    +-- 調査クエリ完了（行2700）
    |
    +-- IF DATEADD(SECOND,1,SYSDATETIMEOFFSET()) < @FinishSampleTime
            |
            +-- RAISERROR 'Waiting to match @Seconds parameter'（行2706）
            |
            +-- WAITFOR TIME @FinishSampleTimeWaitFor（行2707）
    |
    +-- 第2パスキャプチャ（行2718〜）
```

### データフロー図

```
[入力]                           [処理]                          [出力]

@Seconds (パラメータ) --------> 時間計算 ---------------> @FinishSampleTime
                                   |
@StartSampleTime                   v
                              IF 条件判定
                                   |
                         残り時間あり？
                                   |
                    +------Yes-----+-----No------+
                    |                            |
                    v                            v
               RAISERROR                    スキップ
               WAITFOR TIME
                    |
                    v
              第2パスキャプチャ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | ソース | メインストアドプロシージャ（行2703-2708） |
