# 機能設計書 405-Get-DbaCpuUsage

## 概要

本ドキュメントは、SQL ServerプロセスとWindowsスレッドを相関させてCPUリソースを消費しているクエリを特定する`Get-DbaCpuUsage`機能について記述する。

### 本機能の処理概要

**業務上の目的・背景**：SQL ServerでCPU使用率が高い場合、標準的なSQL Serverツールだけでは具体的なクエリやプロセスを特定することが困難な場合がある。本機能は、SQL ServerのプロセスID（SPID）とWindowsカーネルプロセスID（KPID）を、システムDMVとWindowsパフォーマンスカウンターを通じて相関させることで、OSレベルでどのSQLクエリがCPUを消費しているかを正確に特定する。

**機能の利用シーン**：
- 高CPU使用率の原因となっているクエリの特定
- パフォーマンストラブルシューティング時のルートコーズ分析
- CPU使用率閾値を超えるプロセスの監視
- SQL Serverと他プロセス間のCPUリソース競合の調査

**主要な処理内容**：
1. SQL Serverインスタンスへの接続とプロセス情報取得（Get-DbaProcess）
2. WMI経由でWindowsスレッドパフォーマンスデータを取得
3. SPIDとKPIDの相関マッピング
4. スレッド状態と待機理由の人間可読形式への変換
5. プロセス情報、クエリテキスト、CPU使用率の統合出力

**関連システム・外部連携**：
- SQL Server DMV（sys.dm_exec_sessions、sys.dm_exec_requests、sys.dm_os_workers、sys.dm_os_threads）
- Windows WMI（Win32_PerfFormattedData_PerfProc_Thread）

**権限による制御**：
- SQL Server: VIEW SERVER STATE権限またはsysadminロール
- Windows: 対象コンピュータへのローカル管理者権限

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドライン | 主画面 | PowerShellコンソールからの直接実行 |

## 機能種別

データ取得（パフォーマンス監視） / クロスプラットフォーム相関分析

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象のSQL Serverインスタンス | DbaInstanceParameter型による検証 |
| SqlCredential | PSCredential | No | SQL Server認証用の資格情報 | PowerShell資格情報オブジェクト |
| Credential | PSCredential | No | Windowsサーバーへのログイン用代替資格情報 | PowerShell資格情報オブジェクト |
| Threshold | int | No | CPU使用率フィルター閾値（%）、デフォルト0 | 整数値（0-100） |
| EnableException | switch | No | 例外処理を有効化 | - |

### 入力データソース

- PowerShellコマンドライン入力
- パイプライン入力（SqlInstance）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全修飾SQL Serverインスタンス名 |
| Name | string | スレッド識別子（ProcessName_ProcessID_ThreadID形式） |
| ContextSwitchesPersec | int | このスレッドの毎秒コンテキストスイッチ数 |
| ElapsedTime | int | スレッド作成からの経過時間（秒） |
| IDProcess | int | SQL ServerプロセスのWindowsプロセスID（PID） |
| Spid | int | SQL Serverセッション ID（SPID） |
| PercentPrivilegedTime | double | 特権モードでの時間割合 |
| PercentProcessorTime | double | このスレッドが消費した総プロセッサ時間の割合 |
| PercentUserTime | double | ユーザーモードでの時間割合 |
| PriorityBase | int | スレッドの基本優先度 |
| PriorityCurrent | int | スレッドの現在優先度 |
| StartAddress | string | スレッドコード開始メモリアドレス |
| ThreadStateValue | string | スレッド状態の人間可読形式（Running、Waiting等） |
| ThreadWaitReasonValue | string | 待機理由の人間可読形式 |
| Process | object | Get-DbaProcessからの関連SQL Serverプロセスオブジェクト |
| Query | string | プロセスが実行した最後のT-SQLクエリ |

### 出力先

PowerShellパイプライン（拡張Win32_PerfFormattedData_PerfProc_Thread）

## 処理フロー

### 処理シーケンス

```
1. 初期化処理（beginブロック）
   └─ スレッド状態マッピング定義（0-7）
   └─ スレッド待機理由マッピング定義（0-20）

2. 各インスタンスに対してループ処理
   └─ Connect-DbaInstanceによるSQL Server接続
   └─ 接続失敗時はStop-Functionで継続処理

3. データ収集
   └─ Get-DbaProcessでSQL Serverプロセス情報取得
   └─ Get-DbaCmObjectでWMIスレッドデータ取得（sql*フィルター）
   └─ Thresholdでフィルタリング

4. SPID-KPID相関
   └─ SQL Server 2000: sysprocessesから取得
   └─ SQL Server 2005+: DMVから取得

5. 結果オブジェクト構築
   └─ スレッドオブジェクトに追加プロパティを付与
   └─ Select-DefaultViewで表示プロパティ設定
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[スレッド状態/待機理由マッピング初期化]
    B --> C{各インスタンスでループ}
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function -Continue]
    F --> C
    E -->|Yes| G[Get-DbaProcess実行]
    G --> H[Get-DbaCmObject実行]
    H --> I[sql*フィルター + Threshold適用]
    I --> J{バージョン = 8?}
    J -->|Yes| K[sysprocessesクエリ]
    J -->|No| L[DMVクエリ]
    K --> M{各スレッドでループ}
    L --> M
    M --> N[SPID-KPID相関]
    N --> O[プロパティ追加]
    O --> P[Select-DefaultView]
    P --> Q[パイプライン出力]
    Q --> M
    M -->|ループ終了| C
    C -->|ループ終了| R[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | WMIフィルター | sql*で始まるプロセス名のスレッドのみ取得 | 常時適用 |
| BR-002 | 閾値フィルター | PercentProcessorTime >= Thresholdでフィルタリング | Threshold指定時 |
| BR-003 | バージョン分岐 | SQL 2000とSQL 2005+でSPID取得クエリが異なる | バージョンによる |
| BR-004 | 全インスタンス結果 | サーバー上の全SQL Serverインスタンスの結果を返す | 常時 |

### 計算ロジック

- スレッド状態変換: `$threadstates.$threadstate`
- 待機理由変換: `$threadwaitreasons.$threadwaitreason`

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象 | 操作種別 | 概要 |
|-----|------|---------|------|
| SPID取得 (SQL 2000) | sysprocesses | SELECT | spid, kpid取得 |
| SPID取得 (SQL 2005+) | DMV結合 | SELECT | session_id, os_thread_id取得 |

### テーブル別操作詳細

#### SQL Server 2000: sysprocesses

| 操作 | 項目（カラム名） | 取得条件 | 備考 |
|-----|-----------------|---------|------|
| SELECT | spid | - | SQL Serverセッション ID |
| SELECT | kpid | - | カーネルプロセスID |

#### SQL Server 2005+: DMV結合

| 操作 | 参照DMV | 取得内容 |
|-----|---------|---------|
| SELECT | sys.dm_exec_sessions | session_id |
| SELECT | sys.dm_exec_requests | task_address |
| SELECT | sys.dm_os_workers | thread_address |
| SELECT | sys.dm_os_threads | os_thread_id |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverへの接続失敗 | Stop-Functionで処理継続 |
| - | WMIError | WMIクエリ失敗 | エラーメッセージ出力 |
| - | CredentialError | 資格情報不正 | 認証エラーメッセージ |

### リトライ仕様

自動リトライなし。

## トランザクション仕様

読み取り専用操作のため、トランザクション管理不要。

## パフォーマンス要件

- WMIクエリとSQL Serverクエリを並行実行
- 大量のスレッドがある場合はフィルタリングで最適化

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

- SQL Server: VIEW SERVER STATE権限またはsysadminロール
- Windows: 対象コンピュータへのローカル管理者権限が必要
- Credentialパラメータで別のWindowsユーザーとして実行可能

## 備考

- MSSQLTipsの記事に基づいた実装
- Process属性から関連するSQL Serverプロセスの詳細情報にアクセス可能
- 複数インスタンスがある場合、全インスタンスの結果が返される

---

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

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

### 推奨読解順序

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

スレッド状態と待機理由のマッピングテーブルを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaCpuUsage.ps1 | `public/Get-DbaCpuUsage.ps1` | 109-144行目のbeginブロック |

**読解のコツ**: `$threadstates`と`$threadwaitreasons`はPSCustomObjectとしてマッピングテーブルを定義している。

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

処理の起点となる関数定義とパラメータを特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaCpuUsage.ps1 | `public/Get-DbaCpuUsage.ps1` | 1-108行目のヘルプドキュメントとパラメータ定義 |

**主要処理フロー**:
1. **100-108行目**: パラメータ定義
2. **106行目**: Thresholdのデフォルト値0

#### Step 3: データ収集を理解する

SQL ServerとWMIからのデータ収集ロジック。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaCpuUsage.ps1 | `public/Get-DbaCpuUsage.ps1` | 154-155行目のデータ収集 |

**主要処理フロー**:
- **154行目**: Get-DbaProcessでSQL Serverプロセス取得
- **155行目**: Get-DbaCmObjectでWMIスレッドデータ取得

#### Step 4: SPID-KPID相関を理解する

バージョンによるSPID取得クエリの違い。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaCpuUsage.ps1 | `public/Get-DbaCpuUsage.ps1` | 157-165行目のバージョン分岐 |

**主要処理フロー**:
- **157-158行目**: SQL Server 2000（バージョン8）のsysprocessesクエリ
- **159-164行目**: SQL Server 2005+のDMV結合クエリ

#### Step 5: 結果オブジェクト構築を理解する

スレッドオブジェクトへの追加プロパティ付与。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | Get-DbaCpuUsage.ps1 | `public/Get-DbaCpuUsage.ps1` | 167-186行目の結果構築 |

**主要処理フロー**:
- **175-183行目**: Add-Memberで追加プロパティ付与
- **185行目**: Select-DefaultViewで表示プロパティ設定

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

```
Get-DbaCpuUsage
    │
    ├─ Connect-DbaInstance (内部関数)
    │      └─ SQL Server接続確立
    │
    ├─ Get-DbaProcess (公開関数)
    │      └─ SQL Serverプロセス情報取得
    │
    ├─ Get-DbaCmObject (内部関数)
    │      └─ WMIスレッドデータ取得
    │
    └─ $server.Query() (SMOメソッド)
           └─ SPID-KPIDマッピングクエリ
```

### データフロー図

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

SqlInstance ─────────────▶ Connect-DbaInstance ──────▶ $server
                                   │
SqlCredential ─────────────────────┘
                                   │
                    ┌──────────────┴──────────────┐
                    ▼                              ▼
            Get-DbaProcess              Get-DbaCmObject (WMI)
                    │                              │
                    ▼                              ▼
            $processes                        $threads
                    │                              │
                    └──────────────┬──────────────┘
                                   │
                                   ▼
                        SPID-KPIDマッピングクエリ
                                   │
                                   ▼
                            相関処理・プロパティ追加
                                   │
                                   ▼
Threshold ─────────────▶ フィルタリング ──────────▶ パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaCpuUsage.ps1 | `public/Get-DbaCpuUsage.ps1` | ソース | メイン機能実装 |
| Get-DbaCpuUsage.Tests.ps1 | `tests/Get-DbaCpuUsage.Tests.ps1` | テスト | Pesterユニットテスト |
| Get-DbaProcess.ps1 | `public/Get-DbaProcess.ps1` | ソース | SQL Serverプロセス取得（関連機能） |
