# 通知設計書 12-セッション不存在

## 概要

本ドキュメントは、sp_BlitzLock ストアドプロシージャにおいて、指定されたイベントセッションが存在しないか、非アクティブな場合に発生するエラー通知の設計書である。

### 本通知の処理概要

本通知は、デッドロック情報を拡張イベントセッションから取得する際に、指定されたセッションの存在と状態を検証し、利用不可能な場合にエラーを通知する機能を提供する。

**業務上の目的・背景**：sp_BlitzLockは、SQL Serverの拡張イベント（Extended Events）セッションからデッドロック情報を取得・分析するプロシージャである。デッドロック情報を取得するには、system_healthやカスタムの拡張イベントセッションが稼働している必要がある。セッションが存在しない、または停止している場合、データ取得が不可能となるため、事前に検証してエラーを通知する。

**通知の送信タイミング**：sp_BlitzLock実行時の初期検証フェーズで、@EventSessionNameパラメータで指定されたセッションがsys.server_event_sessions（またはAzure環境ではsys.database_event_sessions）に存在し、かつsys.dm_xe_sessions（またはsys.dm_xe_database_sessions）でアクティブであることを確認する。条件を満たさない場合にエラーが発生する。

**通知の受信者**：sp_BlitzLockを実行したSQL Serverセッションの呼び出し元。通常はDBA（データベース管理者）やSQL Serverエージェントジョブ。

**通知内容の概要**：指定されたセッション名と、セッションが存在しないか非アクティブである旨のエラーメッセージを含む。

**期待されるアクション**：受信者は、正しい拡張イベントセッション名を指定するか、指定したセッションを開始（ALTER EVENT SESSION ... ON SERVER STATE = START）してからsp_BlitzLockを再実行する。

## 通知種別

SQLメッセージ（RAISERROR）

## 送信仕様

### 基本情報

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

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

実行中のSQL Serverセッションに対して直接メッセージを送信する。特定の宛先決定ロジックは不要。

## 通知テンプレート

### SQLメッセージの場合

| 項目 | 内容 |
|-----|------|
| Severity | 11 |
| State | 1 |
| WITH NOWAIT | あり |

### 本文テンプレート

```
A session with the name %s does not exist or is not currently active.
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | - |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| @EventSessionName | イベントセッション名 | @EventSessionNameパラメータ | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzLock実行（オンプレミス） | sys.server_event_sessionsとsys.dm_xe_sessionsの結合結果が0件 | セッションが存在しないか非アクティブ |
| プロシージャ実行 | sp_BlitzLock実行（Azure） | sys.database_event_sessionsとsys.dm_xe_database_sessionsの結合結果が0件 | Azure環境でのセッション検証 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @TargetSessionType = 'table' | テーブルからデータを取得する場合はセッション検証をスキップ |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzLock実行] --> B{@Azure = 0?}
    B -->|Yes| C{@TargetSessionType <> 'table'?}
    B -->|No| D{@TargetSessionType <> 'table'?}
    C -->|Yes| E[sys.server_event_sessions + sys.dm_xe_sessions検証]
    C -->|No| F[検証スキップ]
    D -->|Yes| G[sys.database_event_sessions + sys.dm_xe_database_sessions検証]
    D -->|No| F
    E --> H{セッション存在かつアクティブ?}
    G --> I{セッション存在かつアクティブ?}
    H -->|Yes| J[検証OK - 処理継続]
    H -->|No| K[RAISERROR発行]
    I -->|Yes| J
    I -->|No| K
    K --> L[RETURN - プロシージャ終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.server_event_sessions | サーバーレベルのイベントセッション定義 | オンプレミス環境 |
| sys.dm_xe_sessions | 実行中のイベントセッション情報 | オンプレミス環境 |
| sys.database_event_sessions | データベースレベルのイベントセッション定義 | Azure環境 |
| sys.dm_xe_database_sessions | データベースレベルの実行中セッション情報 | Azure環境 |

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

#### sys.server_event_sessions / sys.dm_xe_sessions

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| ses.name | セッション名 | WHERE ses.name = @EventSessionName |
| dxs.name | アクティブセッション名 | JOIN ON dxs.name = ses.name |
| dxs.create_time | セッション作成時刻 | AND dxs.create_time IS NOT NULL |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 本通知処理でデータ更新は行わない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| セッション不存在 | 指定されたセッションが定義されていない | 正しいセッション名を指定するか、セッションを作成 |
| セッション非アクティブ | セッションは存在するが停止中 | ALTER EVENT SESSIONでセッションを開始 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- sys.dm_xe_sessions / sys.dm_xe_database_sessionsの参照にはVIEW SERVER STATE権限が必要
- セッション名はユーザー入力値だが、パラメータとしてバインドされるためSQLインジェクションのリスクは低い

## 備考

- オンプレミスとAzure環境で参照するDMVが異なる
- @Azureフラグは SERVERPROPERTY('EngineEdition') IN (5, 6, 8) で自動判定される
- デフォルトのセッション名は 'system_health' が使用されることが多い

---

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

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

### 推奨読解順序

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

sp_BlitzLockのパラメータ定義と、セッション関連のパラメータを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | プロシージャのパラメータ定義（@EventSessionName等） |

**読解のコツ**: CREATE PROCEDURE文のパラメータ宣言部分を確認し、@EventSessionNameのデフォルト値と使用方法を理解する。

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

Azure判定とセッション検証ロジックの開始点を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | 行536-570付近のセッション検証部分 |

**主要処理フロー**:
1. **行536-551**: オンプレミス環境でのセッション検証（@Azure = 0）
2. **行548**: RAISERRORによるエラーメッセージ発行
3. **行549**: RETURNによるプロシージャ終了
4. **行553-570**: Azure環境でのセッション検証（@Azure = 1）
5. **行567**: Azure環境でのRAISERROR発行

#### Step 3: 環境判定ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | @Azure変数の設定部分 |

**主要処理フロー**:
- SERVERPROPERTY('EngineEdition') の値でAzure環境を判定

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

```
sp_BlitzLock
    |
    +-- 環境判定フェーズ
    |      |
    |      +-- SERVERPROPERTY('EngineEdition') 取得
    |      |
    |      +-- @Azure フラグ設定
    |
    +-- セッション検証フェーズ
    |      |
    |      +-- @Azure = 0 の場合（オンプレミス）
    |      |      |
    |      |      +-- @TargetSessionType <> 'table' の確認
    |      |      |
    |      |      +-- sys.server_event_sessions + sys.dm_xe_sessions 参照
    |      |      |
    |      |      +-- 条件不一致時: RAISERROR + RETURN
    |      |
    |      +-- @Azure = 1 の場合（Azure）
    |             |
    |             +-- @TargetSessionType <> 'table' の確認
    |             |
    |             +-- sys.database_event_sessions + sys.dm_xe_database_sessions 参照
    |             |
    |             +-- 条件不一致時: RAISERROR + RETURN
    |
    +-- デッドロック分析フェーズ（本エラー時は到達しない）
```

### データフロー図

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

@EventSessionName ──────> 環境判定 ──────> セッション検証 ──────> エラーメッセージ
                          |                |                      |
                          v                v                      v
                     @Azure判定       DMV参照                  RAISERROR
                     (EngineEdition)  (ses + dxs JOIN)         (Severity 11)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzLock.sql | `sp_BlitzLock.sql` | ソース | デッドロック分析プロシージャ本体 |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | インストールスクリプト | 全スクリプトの一括インストール（sp_BlitzLock含む） |
| Install-Azure.sql | `Install-Azure.sql` | インストールスクリプト | Azure用インストールスクリプト |
