# 通知設計書 92-XMLパース

## 概要

本ドキュメントは、sp_BlitzLockストアドプロシージャにおける「XMLパース」通知メッセージの設計を定義する。この通知は、デッドロックXMLデータの解析処理の進行状況を示す情報メッセージである。

### 本通知の処理概要

**業務上の目的・背景**：sp_BlitzLockはSQL Serverの拡張イベントまたはシステムヘルスセッションからデッドロック情報を取得し分析するストアドプロシージャである。デッドロック情報はXML形式で格納されており、分析のためにはこのXMLをパースして必要なデータを抽出する必要がある。この通知は、XMLパース処理の開始を管理者に通知し、処理の進行状況を可視化することで、パフォーマンス監視やトラブルシューティングを支援する。

**通知の送信タイミング**：デッドロックXMLデータの取得後、XMLからプロセス情報や入力バッファ情報を抽出する処理の開始時に送信される。「Initial Parse」と「Final Parse」の2段階で通知が行われる。

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

**通知内容の概要**：XMLパース処理の開始を示すメッセージ。現在のタイムスタンプとともに「Initial Parse process and input buffer xml」または「Final Parse process and input buffer xml」という形式で出力される。

**期待されるアクション**：基本的に確認のみ。パース処理に時間がかかる場合は、デッドロックイベントの件数を確認し、@StartDate/@EndDateパラメータで対象期間を絞り込むことを検討する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
Initial Parse process and input buffer xml {タイムスタンプ}
Final Parse process and input buffer xml {タイムスタンプ}
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | XMLパース処理開始 | デッドロックXMLデータ取得後 | 初期パースおよび最終パース処理の開始を通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | XMLパース処理は必須のため常に実行される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[デッドロックXMLデータ取得] --> B[RAISERROR: Initial Parse process]
    B --> C[#deadlock_dataからイベント情報抽出]
    C --> D[victim_id, is_parallel等を取得]
    D --> E[#ddテーブルに挿入]
    E --> F[RAISERROR: Finished]
    F --> G[RAISERROR: Final Parse process]
    G --> H[プロセス詳細情報抽出]
    H --> I[クライアントオプション展開]
    I --> J[#deadlock_processテーブルに挿入]
    J --> K[RAISERROR: Finished]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| #deadlock_data | デッドロックXMLデータのソース | 一時テーブル |
| #t | 統計情報用ダミーテーブル | WITH ROWCOUNTで最適化 |

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

#### #deadlock_data

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| deadlock_xml | デッドロックXMLデータ | XQuery式で各要素を抽出 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| #dd | INSERT/SELECT INTO | 初期パース結果を格納 |
| #deadlock_process | INSERT/SELECT INTO | 最終パース結果を格納 |

#### #ddテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT | deadlock_xml | XMLデータ | 元データ保持 |
| INSERT | event_date | タイムスタンプ | XQuery抽出 |
| INSERT | victim_id | 被害者プロセスID | XQuery抽出 |
| INSERT | is_parallel | 並列デッドロックフラグ | XQuery抽出 |
| INSERT | deadlock_graph | デッドロックグラフ | XQuery抽出 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| XMLパースエラー | 不正なXML形式 | デッドロックXMLデータの整合性を確認 |
| メモリ不足 | 大量のデッドロックイベント | 対象期間を絞り込んで再実行 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- デッドロックXMLには実行SQLが含まれる可能性があるため、出力先のアクセス制御に注意
- RAISERRORメッセージ自体には機密情報は含まれない

## 備考

- XMLパースは2段階（Initial/Final）で行われる
- Initial Parseではイベント基本情報を抽出
- Final Parseではプロセス詳細情報とクライアントオプションを展開
- 大量のデッドロックイベントがある場合はパース処理に時間がかかる

---

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

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

### 推奨読解順序

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

XMLパース処理のデータフローを理解するため、一時テーブルの構造を確認。

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

**読解のコツ**: CREATE TABLE文を検索し、各一時テーブルのカラム構造を把握する。

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

XMLパース処理の開始点を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | Initial Parse処理の開始部分を確認 |

**主要処理フロー**:
1. **行1451-1453**: XMLパース処理の開始とRAISERRORメッセージ
2. **行1455-1482**: SELECT INTO #ddでの初期パース
3. **行1488**: Final Parse処理の開始とRAISERRORメッセージ
4. **行1490-1565**: SELECT INTO #deadlock_processでの最終パース

#### Step 3: XQuery式を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | XQuery式によるXML要素抽出を確認 |

**主要処理フロー**:
- **行1457**: event/@timestamp の抽出
- **行1458**: victim-list/victimProcess/@id の抽出
- **行1459-1460**: exchangeEvent/SyncPointの存在確認（並列デッドロック判定）
- **行1461**: deadlockグラフの抽出

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

```
sp_BlitzLock
    |
    +-- [デッドロックXML取得]
    |      |
    |      +-- Extended Events / System Health読み込み
    |      +-- #deadlock_dataに格納
    |
    +-- [Initial Parse処理]
    |      |
    |      +-- RAISERROR 'Initial Parse process and input buffer xml'  <-- 本通知
    |      +-- SELECT INTO #dd
    |      |      +-- deadlock_xml.value('(event/@timestamp)[1]')
    |      |      +-- deadlock_xml.value('(//deadlock/victim-list/victimProcess/@id)[1]')
    |      |      +-- deadlock_xml.exist('//deadlock/resource-list/exchangeEvent')
    |      |      +-- deadlock_xml.query('/event/data/value/deadlock')
    |      +-- RAISERROR 'Finished'
    |
    +-- [Final Parse処理]
           |
           +-- RAISERROR 'Final Parse process and input buffer xml'  <-- 本通知
           +-- SELECT INTO #deadlock_process
           |      +-- プロセス詳細情報抽出
           |      +-- クライアントオプション展開
           +-- RAISERROR 'Finished'
```

### データフロー図

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

Extended Events ──┐
                  │
System Health ────┼──▶ #deadlock_data ──▶ Initial Parse ──▶ #dd
                  │         |
Ring Buffer ──────┘         ▼
                      Final Parse ──────────────────▶ #deadlock_process
                            |
                            ▼
                      RAISERROR出力 ─────────────────▶ SQLクライアント
```

### 関連ファイル一覧

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