# 通知設計書 59-設定変数セットアップ

## 概要

本ドキュメントは、sp_BlitzFirst実行時に設定変数のセットアップを開始したことを示す情報通知について定義する。

### 本通知の処理概要

sp_BlitzFirstはSQL Serverのリアルタイム診断を行うストアドプロシージャであり、実行開始時に多数の設定変数を初期化する。本通知は処理の進捗状況をユーザーに知らせるための情報メッセージであり、診断処理が正常に開始されたことを示す。

**業務上の目的・背景**：sp_BlitzFirstは長時間実行されることがあり、ユーザーは処理が正常に進行しているかを確認したい場合がある。このRAISERRORメッセージは重大度10で発行されるため、SSMSのメッセージタブにリアルタイムで表示され、処理の進捗状況を把握できる。特に初回実行時や問題発生時に、どの段階まで処理が進んだかを特定するのに役立つ。

**通知の送信タイミング**：sp_BlitzFirst実行時、ヘルプ表示（@Help = 1）が終了した直後、メイン処理の開始時点。

**通知の受信者**：sp_BlitzFirstを実行したSQL Serverユーザー（DBA、運用担当者など）。

**通知内容の概要**：設定変数のセットアップを開始したことを通知する。

**期待されるアクション**：通常は確認のみ。この通知が表示されれば、sp_BlitzFirstが正常に開始されたことを確認できる。以降の診断処理が進行しない場合は、この時点での問題を調査する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

sp_BlitzFirstを実行したセッションのメッセージ出力に直接表示される。

## 通知テンプレート

### コンソール出力

| 項目 | 内容 |
|-----|------|
| 出力方法 | RAISERROR WITH NOWAIT（重大度10、状態1） |
| メッセージタイプ | 情報メッセージ |

### 本文テンプレート

```
Setting up configuration variables
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | sp_BlitzFirst実行 | @Help = 1でない場合（通常実行時） | メイン処理開始時に常に出力 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @Help = 1 | ヘルプ表示のみの場合（行113でRETURN） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzFirst実行] --> B{@Help = 1?}
    B -->|Yes| C[ヘルプ表示]
    C --> D[RETURN]
    B -->|No| E[RAISERROR 'Setting up configuration variables']
    E --> F[変数宣言・初期化]
    F --> G[以降の診断処理]
    G --> H[終了]
    D --> I[終了]
```

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

### 参照テーブル一覧

なし（この時点ではテーブル参照なし）

### 更新テーブル一覧

なし（この時点ではテーブル更新なし）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | 本通知は情報メッセージのみ | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（sp_BlitzFirst実行時に即時出力）

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

- 本通知には機密情報は含まれない
- 処理開始を示す純粋な情報メッセージ

## 備考

- 重大度10は情報レベルのメッセージを示す
- WITH NOWAITによりバッファリングなしで即時出力される
- この通知の後、多数の変数宣言（@StringToExecute, @ParmDefinitions等）が行われる
- 次の主要な通知は「Now starting diagnostic analysis」

---

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

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

### 推奨読解順序

#### Step 1: 通知の位置と文脈を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | RAISERROR文の位置と前後の処理 |

**主要処理フロー**:
1. **行1-112**: パラメータ定義とヘルプ表示
2. **行113**: @Help = 1の場合のRETURN
3. **行114**: RAISERROR('Setting up configuration variables', 10, 1) WITH NOWAIT
4. **行115以降**: 変数宣言（@StringToExecute, @ParmDefinitions, @Parm1等）

**読解のコツ**: この通知はヘルプ表示終了直後、メイン処理の最初に位置する。重大度10は情報レベルを示す。

#### Step 2: 初期化される変数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行115以降の変数宣言 |

**主要処理フロー**:
- **行115**: @StringToExecute NVARCHAR(MAX)
- **行116**: @ParmDefinitions NVARCHAR(4000)
- **行117**: @Parm1 NVARCHAR(4000)
- **行118**: @OurSessionID INT
- **行119**: @LineFeed NVARCHAR(10)

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

```
sp_BlitzFirst (エントリーポイント)
    │
    ├─ [パラメータ定義] 行1-108
    │
    ├─ [ヘルプ処理] @Help = 1?
    │      │
    │      ├─ [Yes] ヘルプテキスト表示 → RETURN
    │      │
    │      └─ [No] 続行
    │
    ├─ RAISERROR('Setting up configuration variables', 10, 1) WITH NOWAIT
    │
    ├─ [変数宣言] 行115-200程度
    │      ├─ @StringToExecute
    │      ├─ @ParmDefinitions
    │      ├─ @Parm1
    │      ├─ @OurSessionID
    │      ├─ @LineFeed
    │      └─ ... その他多数の変数
    │
    └─ [以降の診断処理]
```

### データフロー図

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

@Help ───────────────────▶ [条件評価]
                              │
                    ┌─────────┴──────────┐
                    │                    │
                    ▼                    ▼
              [@Help = 1]           [@Help <> 1]
                    │                    │
                    ▼                    ▼
            ヘルプ表示              RAISERROR
            RETURN                 'Setting up configuration variables'
                                         │
                                         ▼
                                    変数宣言
                                   (初期化処理)
                                         │
                                         ▼
                                    診断処理開始
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | ソース | 本通知を発生させるメインプロシージャ（行114） |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | ソース | 全スクリプト一括インストール（行37031に同一ロジック） |
| Install-Azure.sql | `Install-Azure.sql` | ソース | Azure向けインストール（行9172に同一ロジック） |
