# 通知設計書 106-BlitzFirst情報取得

## 概要

本ドキュメントは、SQL Server First Responder Kit の sp_BlitzAnalysis プロシージャにおける「BlitzFirst情報取得」情報通知の設計を定義する。

### 本通知の処理概要

この通知は、sp_BlitzAnalysis プロシージャがBlitzFirstの過去データを取得・分析する際に出力される情報メッセージである。

**業務上の目的・背景**：sp_BlitzAnalysis は、sp_BlitzFirst、sp_BlitzCache、sp_BlitzWho などで収集されたパフォーマンスデータを分析するためのプロシージャである。DBAが過去の期間におけるサーバーの状態を分析する際、各データソースからの取得状況を把握することは重要である。この通知により、BlitzFirst テーブルからのデータ取得が開始されたことを確認でき、処理の進行状況を監視できる。

**通知の送信タイミング**：sp_BlitzAnalysis の実行中、BlitzFirst データの取得クエリが実行される直前に出力される。テーブルが存在し、パラメータで指定されている場合に出力される。

**通知の受信者**：sp_BlitzAnalysis プロシージャを実行しているDBA、またはSQL Server Management Studio (SSMS) のクエリウィンドウで結果を監視しているオペレーター。

**通知内容の概要**：「Getting BlitzFirst info from {テーブル名}」というメッセージが出力され、どのテーブルからBlitzFirstデータを取得しているかを示す。

**期待されるアクション**：通知を受け取った受信者は、BlitzFirst データの取得が開始されたことを確認する。取得に時間がかかる場合や、テーブルが見つからない場合は別途メッセージが出力される。

## 通知種別

RAISERROR によるメッセージ出力（SQL Server メッセージ / SSMS メッセージタブ）

## 送信仕様

### 基本情報

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

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

本通知はクライアント接続に対して直接送信される。sp_BlitzAnalysis を実行しているセッションのクライアントが受信者となる。

## 通知テンプレート

### メッセージ通知の場合

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | プレーンテキスト |
| 重大度 | 0（情報） |
| 状態 | 0 |

### 本文テンプレート

```
Getting BlitzFirst info from %s
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| %s | 完全修飾テーブル名 | @FullOutputTableNameBlitzFirst 変数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | BlitzFirst データ取得前 | @OutputTableNameBlitzFirst IS NOT NULL | BlitzFirst テーブルからのデータ取得開始 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @OutputTableNameBlitzFirst IS NULL | BlitzFirst テーブル名が指定されていない |
| OBJECT_ID(@FullOutputTableNameBlitzFirst) IS NULL | テーブルが存在しない（別メッセージを出力） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzAnalysis 実行開始] --> B[パラメータ検証]
    B --> C[動的SQLの構築]
    C --> D[RAISERROR 'Getting BlitzFirst info from %s']
    D --> E{@Debug = 1?}
    E -->|Yes| F[SQL文出力]
    E -->|No| G{テーブル存在?}
    F --> G
    G -->|No| H[テーブル不存在メッセージ]
    G -->|Yes| I[sp_executesql 実行]
    I --> J[結果返却]
    H --> K[次の処理へ]
    J --> K
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| {OutputDatabaseName}.{OutputSchemaName}.{OutputTableNameBlitzFirst} | BlitzFirst の過去データ | ユーザー指定のテーブル |

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

#### BlitzFirst テーブル

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| Priority | 優先度によるフィルタリング | BETWEEN 1 AND @MaxBlitzFirstPriority |
| FindingsGroup | 検出グループ | GROUP BY |
| Finding | 検出内容 | GROUP BY |
| CheckDate | チェック日時 | BETWEEN @StartDate AND @EndDate |
| ServerName | サーバー名 | = @Servername |
| CheckID | チェックID | > -1 |
| URL | 参照URL | 結果出力用 |
| Details | 詳細情報 | 結果出力用 |
| HowToStopIt | 対処方法 | 結果出力用 |
| QueryPlan | クエリプラン | 結果出力用 |
| QueryText | クエリテキスト | 結果出力用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| #BlitzFirstCounts | INSERT | 検出結果のカウント集計 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| テーブル不存在 | 指定されたテーブルが存在しない | エラーメッセージを出力して次の処理へ |
| 権限不足 | テーブルへの SELECT 権限がない | 適切な権限を付与 |
| データベース無効 | @OutputDatabaseName が無効 | 事前のバリデーションで検出 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- BlitzFirst テーブルへの SELECT 権限が必要
- クエリプランやクエリテキストには機密情報が含まれる可能性がある
- @Debug = 1 の場合、実行されるクエリが出力される

## 備考

- @Debug = 1 の場合、生成されたクエリが PRINT で出力される
- テーブルが存在しない場合は「No BlitzFirst data available as the table cannot be found」と出力される
- @OutputTableNameBlitzFirst が NULL の場合は「Skipped logged BlitzFirst data」と出力される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 77-82行目でテーブル名変数の定義を確認 |
| 1-2 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 96行目で @FullOutputTableNameBlitzFirst の構築を確認 |

**読解のコツ**: テーブル名は QUOTENAME で安全にエスケープされ、完全修飾名（DB.Schema.Table）として構築される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 207-292行目で BlitzFirst データ取得処理全体を確認 |
| 2-2 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 260行目で本通知の出力箇所を確認 |

**主要処理フロー**:
1. **208-257行目**: 動的SQLの構築（INSERT INTO #BlitzFirstCounts と SELECT）
2. **260行目**: `RAISERROR('Getting BlitzFirst info from %s',0,0,@FullOutputTableNameBlitzFirst)` - 本通知の出力
3. **262-265行目**: @Debug = 1 の場合のSQL出力
4. **267-292行目**: テーブル存在チェックとクエリ実行

#### Step 3: 動的SQLの構築を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 208-257行目で SELECT クエリの動的構築 |

**主要処理フロー**:
- **208-223行目**: #BlitzFirstCounts への INSERT（集計クエリ）
- **224-257行目**: 詳細データの SELECT

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

```
sp_BlitzAnalysis
    │
    ├─ パラメータ検証
    │      └─ @OutputDatabaseName の DB_ID チェック
    │
    ├─ テーブル名構築
    │      └─ @FullOutputTableNameBlitzFirst = QUOTENAME(DB) + QUOTENAME(Schema) + QUOTENAME(Table)
    │
    ├─ 動的SQL構築
    │      └─ @Sql に SELECT ステートメントを設定
    │
    ├─ RAISERROR('Getting BlitzFirst info from %s')
    │      └─ 本通知の出力
    │
    ├─ OBJECT_ID チェック
    │      └─ テーブル存在確認
    │
    └─ sp_executesql
           └─ 動的SQL実行
```

### データフロー図

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

@OutputDatabaseName ──────▶ QUOTENAME ───────────────────▶ 完全修飾テーブル名
@OutputSchemaName ────────▶    │
@OutputTableNameBlitzFirst ▶   │
                               │
                               ▼
                         RAISERROR ──────────────────────▶ 'Getting BlitzFirst info from %s'
                               │                           (メッセージ出力)
                               ▼
                    OBJECT_ID チェック ──────────────────▶ (存在確認)
                               │
                               ▼
                    sp_executesql ───────────────────────▶ 結果セット
                               │
                               ▼
                    #BlitzFirstCounts ───────────────────▶ 集計結果
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | ソース | 本通知を発行するストアドプロシージャ本体 |
| BlitzFirst | ユーザー指定 | 参照テーブル | sp_BlitzFirst の出力データを格納 |
