# 通知設計書 62-プランキャッシュキャプチャ

## 概要

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

### 本通知の処理概要

この通知は、sp_BlitzFirstの実行時にプランキャッシュの第1パス（最初のスナップショット）をキャプチャするフェーズの開始を示す進捗情報メッセージである。

**業務上の目的・背景**：sp_BlitzFirstは、SQL Serverのパフォーマンス診断を行う際に、指定された秒数（@Seconds）の間に実行されたクエリを特定するため、プランキャッシュの「前後比較」を行う。最初のスナップショットを取得し、指定時間経過後に2回目のスナップショットを取得して比較することで、その期間中に最も頻繁に実行されたクエリや、最もリソースを消費したクエリを特定できる。この通知により、DBAはプランキャッシュのキャプチャ処理が開始されたことを確認できる。

**通知の送信タイミング**：sp_BlitzFirstの行1185で、@CheckProcedureCache = 1の場合のみ、プランキャッシュからsys.dm_exec_query_statsの情報を取得する直前にRAISERRORが発行される。

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

**通知内容の概要**：「@CheckProcedureCache = 1, capturing first pass of plan cache」というメッセージが出力され、プランキャッシュキャプチャ処理の開始と条件を示す。

**期待されるアクション**：DBAはこのメッセージを確認することで、プランキャッシュ分析が有効化されており、正常に処理が進行していることを把握できる。このメッセージが出力されない場合は、@CheckProcedureCacheパラメータが0に設定されていることを意味する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
@CheckProcedureCache = 1, capturing first pass of plan cache
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | sp_BlitzFirst実行 | @CheckProcedureCache = 1 | プランキャッシュ分析が有効な場合のみ出力 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @CheckProcedureCache = 0 | デフォルト値。プランキャッシュ分析が無効の場合は出力されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzFirst開始] --> B{@CheckProcedureCache = 1?}
    B -->|Yes| C[RAISERROR 'capturing first pass of plan cache']
    B -->|No| G[プランキャッシュ処理スキップ]
    C --> D{SQL Server 2005?}
    D -->|Yes| E[2005用クエリ実行]
    D -->|No| F[2008以降用クエリ実行]
    E --> H[#QueryStatsテーブルにINSERT]
    F --> H
    H --> I[後続処理へ]
    G --> I
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.dm_exec_query_stats | プランキャッシュのクエリ統計取得 | 過去10秒以内に実行されたクエリを抽出 |
| sys.dm_exec_plan_attributes | プラン属性の取得 | @FilterPlansByDatabase指定時のみ使用 |

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

#### sys.dm_exec_query_stats

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| sql_handle | SQLハンドル | last_execution_time >= DATEADD(ss, -10, SYSDATETIMEOFFSET()) |
| statement_start_offset | ステートメント開始オフセット | 同上 |
| statement_end_offset | ステートメント終了オフセット | 同上 |
| plan_handle | プランハンドル | 同上 |
| execution_count | 実行回数 | 同上 |
| total_worker_time | 合計CPU時間 | 同上 |
| total_physical_reads | 合計物理読み取り | 同上 |
| total_logical_writes | 合計論理書き込み | 同上 |
| total_logical_reads | 合計論理読み取り | 同上 |
| total_elapsed_time | 合計経過時間 | 同上 |
| query_hash | クエリハッシュ | SQL Server 2008以降のみ |
| query_plan_hash | クエリプランハッシュ | SQL Server 2008以降のみ |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| #QueryStats | INSERT | プランキャッシュのスナップショットを一時テーブルに格納 |

#### #QueryStats

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT | Pass | 1 | 第1パスを示す |
| INSERT | SampleTime | SYSDATETIMEOFFSET() | サンプリング時刻 |
| INSERT | execution_count | dm_exec_query_statsから取得 | 実行回数 |
| INSERT | total_worker_time | dm_exec_query_statsから取得 | CPU時間 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- VIEW SERVER STATE権限が必要
- プランキャッシュ情報にはクエリテキストが含まれる可能性があるが、この通知自体には機密情報は含まれない

## 備考

- デフォルトでは@CheckProcedureCache = 0のため、この通知は出力されない
- @FilterPlansByDatabaseを指定すると、特定のデータベースのクエリのみを対象にできる

---

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

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

### 推奨読解順序

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

プランキャッシュ情報を格納する一時テーブルの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | #QueryStatsテーブルの定義 |

**読解のコツ**: #QueryStatsはPass列で第1パス/第2パスを区別し、後で比較に使用する。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行1183-1185のIF条件とRAISERROR文 |

**主要処理フロー**:
1. **行1183**: IF @CheckProcedureCache = 1 - 条件判定
2. **行1185**: RAISERROR - プランキャッシュキャプチャ開始通知
3. **行1186-1226**: バージョン別のINSERT文構築
4. **行1226**: EXEC(@StringToExecute) - 動的SQL実行

#### Step 3: バージョン別処理を理解する

SQL Serverバージョンによる処理の違いを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行1186-1205（SQL Server 2005用） |
| 3-2 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行1206-1225（SQL Server 2008以降用） |

**主要処理フロー**:
- **行1186**: SQL Server 2005ではquery_hash, query_plan_hashがNULL
- **行1206**: SQL Server 2008以降ではquery_hash, query_plan_hashを取得

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

```
sp_BlitzFirst
    |
    +-- IF @CheckProcedureCache = 1
            |
            +-- RAISERROR 'capturing first pass of plan cache'
            |
            +-- IF @@VERSION LIKE '2005%'
            |       |
            |       +-- 2005用INSERT文構築
            |
            +-- ELSE
            |       |
            |       +-- 2008以降用INSERT文構築
            |
            +-- EXEC(@StringToExecute)
                    |
                    +-- sys.dm_exec_query_stats
                    +-- sys.dm_exec_plan_attributes（オプション）
```

### データフロー図

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

@CheckProcedureCache -----> IF条件判定 ----------------> RAISERROR
                                |                         (通知)
                                v
sys.dm_exec_query_stats --> #QueryStats ---------------> 後続の
                            テーブル                     比較処理へ
```

### 関連ファイル一覧

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