# 通知設計書 78-実行プラン収集

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzCacheプロシージャにおいて、実行プラン情報の収集を開始した際に出力される情報通知「実行プラン収集」について定義する。

### 本通知の処理概要

本通知は、sp_BlitzCacheストアドプロシージャ内で、プランキャッシュから実行プラン情報を収集するフェーズが開始されたことをユーザーに通知するための情報メッセージである。

**業務上の目的・背景**：sp_BlitzCacheは、SQL Serverのプランキャッシュを分析し、パフォーマンス問題を引き起こしているクエリを特定するプロシージャである。実行プラン情報の収集は分析の核心部分であり、sys.dm_exec_query_statsなどのDMVから統計情報とプランを取得する。この通知は、データ収集フェーズが開始されたことを管理者に知らせる。

**通知の送信タイミング**：sp_BlitzCacheプロシージャのデータ収集フェーズにおいて、@Reanalyze = 0の場合に、動的SQLを実行して実行プラン情報を収集する直前に送信される。具体的にはsp_BlitzCache.sqlの行2865で出力される。

**通知の受信者**：SQL Server Management Studio（SSMS）やその他のクライアントツールでsp_BlitzCacheを実行している管理者・DBA。メッセージタブに情報として表示される。

**通知内容の概要**：「Collecting execution plan information.」という固定メッセージが出力される。これにより、プランキャッシュからの情報収集が開始されたことが明確に示される。

**期待されるアクション**：この通知は情報提供目的であり、特別なアクションは不要。大規模なプランキャッシュを持つサーバーでは、このフェーズに時間がかかる可能性があるため、管理者は処理が進行中であることを確認できる。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（WITH NOWAIT指定により即時出力） |
| 優先度 | 低（情報レベル：severity 0） |
| リトライ | 無し |

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

実行中のセッションのクライアント（SSMSのメッセージタブ等）に対して直接出力される。@Reanalyze = 0の条件を満たす場合のみ出力。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | クライアントのメッセージストリーム |
| メッセージレベル | 0（情報） |
| 状態 | 1 |

### 本文テンプレート

```
Collecting execution plan information.
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ内部処理 | 実行プラン収集開始 | @Reanalyze = 0 | 新規分析時にプランキャッシュから情報を収集する場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @Reanalyze = 1 | 再分析モードの場合、既存データを使用するため収集処理は行われない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzCache開始] --> B[パラメータ検証]
    B --> C[動的SQL構築]
    C --> D{@Reanalyze = 0?}
    D -->|Yes| E["RAISERROR('Collecting execution plan information.',0,1) WITH NOWAIT"]
    D -->|No| F[既存データ使用]
    E --> G[EXEC sp_executesql @sql]
    G --> H[##BlitzCacheProcsにデータ格納]
    H --> I[分析処理へ]
    F --> I
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.dm_exec_query_stats | クエリ統計情報の取得 | 実行回数、CPU時間、読み取り数など |
| sys.dm_exec_sql_text | SQLテキストの取得 | sql_handle経由 |
| sys.dm_exec_query_plan | 実行プランXMLの取得 | plan_handle経由 |
| sys.dm_exec_plan_attributes | プラン属性の取得 | データベースIDなど |

### テーブル別参照項目詳細

#### sys.dm_exec_query_stats
| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| execution_count | 実行回数 | - |
| total_worker_time | 総CPU時間 | - |
| total_elapsed_time | 総経過時間 | - |
| total_logical_reads | 総論理読み取り数 | - |
| total_logical_writes | 総論理書き込み数 | - |
| plan_handle | プランハンドル | - |
| sql_handle | SQLハンドル | - |
| query_hash | クエリハッシュ | - |
| query_plan_hash | クエリプランハッシュ | - |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ##BlitzCacheProcs | INSERT | 収集した実行プラン情報を格納 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | 本通知は情報出力のみでエラーは発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（sp_BlitzCache実行時、@Reanalyze = 0時に出力）

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

- 本通知は固定の情報メッセージであり、機密情報を含まない
- VIEW SERVER STATE権限を持つユーザーのみがsp_BlitzCacheを実行可能

## 備考

- WITH NOWAIT指定により、バッファリングされずに即時クライアントに送信される
- ##BlitzCacheProcsはグローバル一時テーブルとして作成され、複数セッションで共有可能
- @Reanalyze = 1の場合、前回収集したデータを再分析するため、収集処理はスキップされる
- 収集後には「Attempting to aggregate stored proc info from separate statements」などの後続処理通知が出力される

---

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

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

### 推奨読解順序

#### Step 1: データ構造を理解する

##BlitzCacheProcsテーブルの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | ##BlitzCacheProcsテーブル作成部分を確認 |

**読解のコツ**: グローバル一時テーブルの各カラムが、どのDMVから取得されるかを確認する。

#### Step 2: 動的SQLの構築を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | @sql変数への動的SQL構築部分 |

**主要処理フロー**:
1. 動的SQLでsys.dm_exec_query_statsからデータを取得
2. sys.dm_exec_sql_textとsys.dm_exec_query_planを結合
3. ソート順と上位N件の条件を動的に構築

#### Step 3: 実行プラン収集処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行2863-2868の収集処理 |

**主要処理フロー**:
- **行2863**: `IF @Reanalyze = 0`
- **行2865**: `RAISERROR('Collecting execution plan information.', 0, 1) WITH NOWAIT;`
- **行2867**: `EXEC sp_executesql @sql, N'@Top INT, @min_duration INT, @min_back INT, @SortOrder NVARCHAR(20)', @Top, @DurationFilter_i, @MinutesBack, @SortOrder;`

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

```
sp_BlitzCache（エントリーポイント）
    │
    ├─ パラメータ検証
    │
    ├─ 動的SQL構築（@sql）
    │
    ├─ @Reanalyze = 0 判定
    │      │
    │      ├─ Yes: RAISERROR('Collecting execution plan information.') ← 本通知
    │      │        │
    │      │        └─ EXEC sp_executesql @sql
    │      │               └─ sys.dm_exec_query_stats
    │      │               └─ sys.dm_exec_sql_text
    │      │               └─ sys.dm_exec_query_plan
    │      │
    │      └─ No: 既存データ使用（収集スキップ）
    │
    └─ 分析処理
           ├─ ストアドプロシージャ情報集約
           ├─ XMLノード処理
           └─ クエリレベルチェック
```

### データフロー図

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

@Reanalyze = 0               ───▶ プラン収集処理           ───▶ クライアントメッセージ
                                      │                                 「Collecting execution plan information.」
                                      │
sys.dm_exec_query_stats      ───▶ sp_executesql実行        ───▶ ##BlitzCacheProcs
sys.dm_exec_sql_text               │
sys.dm_exec_query_plan             │
                                      └─ グローバル一時テーブルにINSERT
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | メインプロシージャ。実行プラン収集通知を出力（行2865） |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | インストール | 全スクリプトを含むインストールファイル（行16017） |
| Install-Azure.sql | `Install-Azure.sql` | インストール | Azure向けインストールファイル（行3752） |
