# 通知設計書 93-実行プラン取得

## 概要

本ドキュメントは、sp_BlitzLockストアドプロシージャにおける「実行プラン取得」通知メッセージの設計を定義する。この通知は、デッドロックに関連する実行プラン情報の収集処理の進行状況を示す情報メッセージである。

### 本通知の処理概要

**業務上の目的・背景**：sp_BlitzLockはデッドロックの根本原因分析を支援するツールである。デッドロックが発生したクエリの実行プランを取得することで、インデックス不足やクエリの最適化ポイントを特定できる。この通知は、プランキャッシュから関連する実行プラン情報を収集する処理の開始を通知し、分析の進行状況を可視化する。

**通知の送信タイミング**：デッドロック結果をクライアントに出力する際（出力先データベースが指定されていない場合）、デッドロックに関連する実行プランの収集処理開始時に送信される。

**通知の受信者**：SQLクライアント（SSMS、sqlcmd、アプリケーション）を通じてストアドプロシージャを実行している管理者またはオペレータ。RAISERROR WITH NOWAITにより即座にメッセージが出力される。

**通知内容の概要**：実行プラン取得処理の開始を示すメッセージ。現在のタイムスタンプとともに「Getting available execution plans for deadlocks」という形式で出力される。

**期待されるアクション**：基本的に確認のみ。取得できる実行プランがない場合は、プランキャッシュがクリアされている可能性を考慮する。

## 通知種別

RAISERROR情報メッセージ（SQLクライアント出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（WITH NOWAIT） |
| 優先度 | 低（Severity 0） |
| リトライ | なし |

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

RAISERROR WITH NOWAITによりSQL Serverクライアントへ即座にメッセージを送信。接続中のすべてのクライアントセッションで受信可能。

## 通知テンプレート

### メッセージ出力の場合

| 項目 | 内容 |
|-----|------|
| 出力形式 | RAISERRORメッセージ |
| 重大度 | 0（情報） |
| 状態 | 1 |

### 本文テンプレート

```
Getting available execution plans for deadlocks {タイムスタンプ}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| @d | 現在日時（タイムスタンプ） | CONVERT(varchar(40), GETDATE(), 109) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | 実行プラン取得処理開始 | 出力先データベース未指定時（クライアント出力時） | プランキャッシュからの実行プラン収集を通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 出力先データベース指定時 | データベースへの出力時はこの通知は送信されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[デッドロック分析完了] --> B{出力先DB指定?}
    B -->|Yes| C[データベースへ出力]
    B -->|No| D[RAISERROR: Results to client]
    D --> E[デッドロック結果出力]
    E --> F[RAISERROR: Getting available execution plans]
    F --> G[#available_plansテーブル作成]
    G --> H[dm_exec_query_statsから統計取得]
    H --> I[実行プラン情報出力]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| #deadlock_stack | デッドロックのコールスタック情報 | sql_handle取得元 |
| #deadlock_owner_waiter | オーナー/ウェイター情報 | database_id, object_name取得元 |
| #deadlock_results | デッドロック結果 | query_xml取得元 |
| sys.dm_exec_query_stats | 実行統計情報 | プランキャッシュから取得 |

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

#### #deadlock_stack

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | プロセスID | 結合条件 |
| event_date | イベント日時 | 結合条件 |
| proc_name | プロシージャ名 | 出力カラム |
| sql_handle | SQLハンドル | 実行プラン特定用 |

#### sys.dm_exec_query_stats

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| sql_handle | SQLハンドル | #available_plansとの結合 |
| plan_handle | プランハンドル | 実行プラン取得用 |
| execution_count | 実行回数 | 統計情報 |
| total_worker_time | 総ワーカー時間 | CPU使用量分析 |
| total_elapsed_time | 総経過時間 | 実行時間分析 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| #available_plans | INSERT/SELECT INTO | 取得可能な実行プラン一覧 |
| #dm_exec_query_stats | INSERT/SELECT INTO | クエリ統計情報 |

#### #available_plansテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT | available_plans | 'available_plans' | 固定値 |
| INSERT | proc_name | プロシージャ名 | #deadlock_stackから |
| INSERT | sql_handle | SQLハンドル | varbinary(64)に変換 |
| INSERT | database_name | データベース名 | #deadlock_owner_waiterから |
| INSERT | object_name | オブジェクト名 | #deadlock_owner_waiterから |
| INSERT | query_xml | クエリXML | #deadlock_resultsから |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 実行プラン未取得 | プランキャッシュがクリアされている | 過去のデッドロック分析では実行プランが取得できない場合がある |
| 権限エラー | VIEW SERVER STATE権限不足 | 必要な権限を付与 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（ストアドプロシージャ実行時に即座に送信）

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

- 実行プランには実行SQLが含まれるため、アクセス制御に注意
- VIEW SERVER STATE権限が必要
- RAISERRORメッセージ自体には機密情報は含まれない

## 備考

- 実行プランはプランキャッシュに残っている場合のみ取得可能
- 過去のデッドロックの実行プランは取得できない可能性がある
- デッドロック発生後すぐに分析することで、実行プラン取得の成功率が上がる

---

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

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

### 推奨読解順序

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

実行プラン取得に使用される一時テーブルの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | #deadlock_stack, #deadlock_owner_waiter, #deadlock_resultsの定義を確認 |

**読解のコツ**: これらのテーブルはXMLパース処理で作成され、実行プラン取得で参照される。

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

実行プラン取得処理の開始点を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | クライアント出力時の処理フローを確認 |

**主要処理フロー**:
1. **行4162-4165**: クライアント出力モードの判定とRAISERRORメッセージ
2. **行4180-4181**: 実行プラン取得開始のRAISERRORメッセージ
3. **行4183-4202**: #available_plansへのSELECT処理
4. **行4204-4259**: dm_exec_query_statsからの統計取得

#### Step 3: DMVからの実行プラン取得を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | sys.dm_exec_query_statsからの情報取得を確認 |

**主要処理フロー**:
- **行4205-4208**: sql_handle, plan_handleの取得
- **行4209-4211**: execution_count, creation_time等の取得
- **行4212-4258**: CPU時間、経過時間、メモリグラント等の統計取得

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

```
sp_BlitzLock
    |
    +-- [デッドロック分析処理]
    |      |
    |      +-- XMLパース → #deadlock_stack, #deadlock_owner_waiter, #deadlock_results作成
    |
    +-- [結果出力判定]
    |      |
    |      +-- 出力先DB指定あり → データベースへ出力
    |      +-- 出力先DB指定なし → クライアント出力
    |
    +-- [クライアント出力処理]
           |
           +-- RAISERROR 'Results to client'
           +-- デッドロック結果実行
           +-- RAISERROR 'Getting available execution plans for deadlocks'  <-- 本通知
           +-- SELECT INTO #available_plans
           |      +-- #deadlock_stack JOIN
           |      +-- #deadlock_owner_waiter JOIN
           |      +-- #deadlock_results JOIN
           +-- SELECT INTO #dm_exec_query_stats
                  +-- sys.dm_exec_query_stats参照
```

### データフロー図

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

#deadlock_stack ────────┐
                        │
#deadlock_owner_waiter ─┼──▶ SELECT INTO #available_plans ──▶ 実行プラン一覧
                        │
#deadlock_results ──────┘
                                    |
sys.dm_exec_query_stats ──────▶ SELECT INTO #dm_exec_query_stats ──▶ 統計情報
                                    |
                                    ▼
                              RAISERROR出力 ─────────────────────▶ SQLクライアント
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzLock.sql | `sp_BlitzLock.sql` | ソース | デッドロック分析の本体プロシージャ。実行プラン取得処理を含む |
