# 通知設計書 109-Perfmon取得

## 概要

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

### 本通知の処理概要

この通知は、sp_BlitzAnalysis プロシージャがPerfmon（パフォーマンスカウンター）の過去データを取得・分析する際に出力される情報メッセージである。

**業務上の目的・背景**：SQL Server のパフォーマンス分析において、パフォーマンスカウンター（Perfmon）は CPU、メモリ、ディスク、ネットワークなどのシステムリソースの状態を把握するための重要な指標である。sp_BlitzFirst によって収集されたパフォーマンスカウンターデータを分析することで、サーバーのリソース使用状況やボトルネックを特定できる。この通知により、DBAはパフォーマンスカウンターデータの取得が開始されたことを確認できる。

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

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

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

**期待されるアクション**：通知を受け取った受信者は、パフォーマンスカウンターデータの取得が開始されたことを確認する。結果にはバッファキャッシュヒット率、ページライフエクスペクタンシーなどの重要なメトリクスが含まれる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
Getting Perfmon info from %s
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

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

## 処理フロー

### 送信フロー

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

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| {OutputDatabaseName}.{OutputSchemaName}.{OutputTableNamePerfmonStats}_Actuals | Perfmon の実測値データ | sp_BlitzFirst が出力 |

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

#### BlitzFirst_PerfmonStats_Actuals テーブル

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| ServerName | サーバー名 | = @Servername |
| CheckDate | チェック日時 | BETWEEN @StartDate AND @EndDate |
| counter_name | カウンター名 | ORDER BY |
| object_name | オブジェクト名 | 結果出力用 |
| instance_name | インスタンス名 | 結果出力用 |
| cntr_value | カウンター値 | 結果出力用 |

### 更新テーブル一覧

なし（参照のみ）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| テーブル不存在 | 指定されたテーブルが存在しない | エラーメッセージを出力して次の処理へ |
| 権限不足 | テーブルへの SELECT 権限がない | 適切な権限を付与 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- Perfmon テーブルへの SELECT 権限が必要
- @Debug = 1 の場合、実行されるクエリが出力される

## 備考

- テーブル名は「{OutputTableNamePerfmonStats}_Actuals」形式（実測値テーブル）
- 結果はCheckDate と counter_name でソートされる
- 一般的なカウンターには Page life expectancy、Buffer cache hit ratio、Batch Requests/sec などが含まれる

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 79行目で @FullOutputTableNamePerfmonStats 変数の定義を確認 |
| 1-2 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 98行目でテーブル名の構築（_Actuals サフィックス）を確認 |

**読解のコツ**: Perfmon テーブルは「_Actuals」サフィックスが付いた実測値テーブルを参照する（差分ではなく実際の値）。

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

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

**主要処理フロー**:
1. **445-459行目**: 動的SQLの構築（シンプルな SELECT）
2. **461行目**: `RAISERROR('Getting Perfmon info from %s',0,0,@FullOutputTableNamePerfmonStats)` - 本通知の出力
3. **463-466行目**: @Debug = 1 の場合のSQL出力
4. **468-490行目**: テーブル存在チェックとクエリ実行

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

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

**主要処理フロー**:
- **446-452行目**: 基本的な SELECT 文（カウンター情報の取得）
- **454-455行目**: WHERE 条件（ServerName、CheckDate）
- **456-458行目**: ORDER BY（CheckDate、counter_name）

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

```
sp_BlitzAnalysis
    │
    ├─ FileStats 処理
    │
    ├─ テーブル名構築
    │      └─ @FullOutputTableNamePerfmonStats = ...+QUOTENAME(@OutputTableNamePerfmonStats+N'_Actuals')
    │
    ├─ 動的SQL構築
    │      └─ SELECT counter_name, object_name, instance_name, cntr_value
    │
    ├─ RAISERROR('Getting Perfmon info from %s')
    │      └─ 本通知の出力
    │
    ├─ OBJECT_ID チェック
    │      └─ テーブル存在確認
    │
    └─ sp_executesql
           └─ 動的SQL実行
```

### データフロー図

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

@OutputTableNamePerfmonStats ▶ + '_Actuals' ─────────────▶ 完全修飾テーブル名
                               │
@StartDate ───────────────────▶ 期間フィルタ ───────────▶ CheckDate 条件
@EndDate ─────────────────────▶    │
                               │
@Servername ──────────────────▶ サーバーフィルタ ──────▶ ServerName 条件
                               │
                               ▼
                         RAISERROR ──────────────────────▶ 'Getting Perfmon info from %s'
                               │                           (メッセージ出力)
                               ▼
                    OBJECT_ID チェック ──────────────────▶ (存在確認)
                               │
                               ▼
                    sp_executesql ───────────────────────▶ 結果セット
                               │                           (パフォーマンスカウンター)
```

### 関連ファイル一覧

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