# 機能設計書 410-Get-DbaMemoryUsage

## 概要

本ドキュメントは、Windowsパフォーマンスカウンターを使用して全SQL Serverサービスからメモリ使用統計を収集する`Get-DbaMemoryUsage`機能について記述する。

### 本機能の処理概要

**業務上の目的・背景**：SQL Server環境では、データベースエンジンだけでなく、Analysis Services (SSAS)やIntegration Services (SSIS)など複数のコンポーネントがメモリを消費する。これらのサービス間でメモリがどのように割り当てられているかを理解することは、メモリ圧迫問題のトラブルシューティングや容量計画において重要である。本機能は、Windowsパフォーマンスカウンターを使用して、Memory Manager、Plan Cache、Buffer Manager、SSAS、SSISからメモリ使用統計を収集する。

**機能の利用シーン**：
- メモリ圧迫問題のトラブルシューティング時
- 複数SQL Serverコンポーネント間のメモリ割り当て把握時
- サーバー全体のメモリ使用状況の監視時
- キャパシティプランニングの分析時

**主要な処理内容**：
1. 対象コンピュータへの接続とネットワーク名解決
2. Windowsパフォーマンスカウンターの収集（リモート実行）
3. Memory Manager、Plan Cache、Buffer Manager、SSAS、SSISの各カウンター取得
4. 正規表現によるカウンターフィルタリング
5. ページ数とメモリサイズを含む結果オブジェクトの出力

**関連システム・外部連携**：
- Windows パフォーマンスカウンター（Get-Counter）
- PowerShellリモート実行（Invoke-Command2）

**権限による制御**：対象コンピュータへのローカル管理者権限が必要。

## 関連画面

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

## 機能種別

データ取得（パフォーマンス監視）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ComputerName | DbaInstanceParameter[] | No | 対象のWindowsサーバー、デフォルトはローカルコンピュータ | DbaInstanceParameter型による検証 |
| Credential | PSCredential | No | 代替資格情報 | PowerShell資格情報オブジェクト |
| MemoryCounterRegex | string | No | Memory Managerカウンターのフィルター正規表現 | 正規表現パターン |
| PlanCounterRegex | string | No | Plan Cacheカウンターのフィルター正規表現 | 正規表現パターン |
| BufferCounterRegex | string | No | Buffer Managerカウンターのフィルター正規表現 | 正規表現パターン |
| SSASCounterRegex | string | No | SSASカウンターのフィルター正規表現 | 正規表現パターン |
| SSISCounterRegex | string | No | SSISカウンターのフィルター正規表現 | 正規表現パターン |
| EnableException | switch | No | 例外処理を有効化 | - |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | カウンターを収集したコンピュータ名 |
| SqlInstance | string | SQL Serverインスタンス名（デフォルトインスタンスはmssqlserver、名前付きインスタンスはインスタンス名） |
| CounterInstance | string | パフォーマンスカウンターパスから抽出したカウンターインスタンス識別子 |
| Counter | string | Windowsパフォーマンスカウンター名（Total Server Memory、Free pages、cache pages等） |
| Pages | int/null | バッファプールおよびプランキャッシュカウンターのページ数、Memory Manager、SSAS、SSISではnull |
| Memory | DbaSize | メモリ使用量（バイト単位のDbaSize型） |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. スクリプトブロック準備（beginブロック）
   └─ リモート実行用スクリプトブロック定義
   └─ 各カウンタータイプ（Memory Manager、Plan Cache、Buffer Manager、SSAS、SSIS）の処理

2. 各コンピュータに対してループ処理
   └─ Resolve-DbaNetworkNameによるネットワーク名解決
   └─ 解決失敗時は警告出力して継続

3. リモートコマンド実行
   └─ Invoke-Command2によるスクリプトブロック実行
   └─ パフォーマンスカウンター収集

4. 結果オブジェクト出力
   └─ メモリ値をDbaSize型に変換（MB→バイト）
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[スクリプトブロック準備]
    B --> C{各コンピュータでループ}
    C --> D[Resolve-DbaNetworkName]
    D --> E{解決成功?}
    E -->|No| F[Warning出力]
    F --> C
    E -->|Yes| G[Invoke-Command2実行]
    G --> H[Memory Managerカウンター取得]
    H --> I[Plan Cacheカウンター取得]
    I --> J[Buffer Managerカウンター取得]
    J --> K[SSASカウンター取得]
    K --> L[SSISカウンター取得]
    L --> M{各結果でループ}
    M --> N[DbaSize変換]
    N --> O[PSCustomObject生成]
    O --> P[パイプライン出力]
    P --> M
    M -->|ループ終了| C
    C -->|ループ終了| Q[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルトコンピュータ | ComputerName未指定時はローカルコンピュータ | 常時 |
| BR-002 | インスタンス名変換 | sqlserverはmssqlserverに変換 | デフォルトインスタンスの場合 |
| BR-003 | メモリ変換（Memory Manager） | KB→MB: value / 1024 | Memory Manager、SSASカウンター |
| BR-004 | メモリ変換（Plan Cache/Buffer） | Pages * 8192 / 1048576 = MB | Plan Cache、Buffer Managerカウンター |
| BR-005 | メモリ変換（SSIS） | MB→MB: value / 1024 / 1024 | SSISカウンター |
| BR-006 | 最終変換 | MB * 1024 * 1024 = バイト | 全カウンター |

### 計算ロジック

- Memory Manager: `$_.cookedvalue / 1024` (KB→MB) → `* 1024 * 1024` (バイト)
- Plan Cache: `$_.cookedvalue * 8192 / 1048576` (Pages→MB) → `* 1024 * 1024` (バイト)
- Buffer Manager: `$_.cookedvalue * 8192 / 1048576.0` (Pages→MB) → `* 1024 * 1024` (バイト)
- SSAS: `$_.cookedvalue / 1024` (KB→MB) → `* 1024 * 1024` (バイト)
- SSIS: `$_.cookedvalue / 1024 / 1024` (バイト→MB) → `* 1024 * 1024` (バイト)

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

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

データベース操作なし。Windowsパフォーマンスカウンターのみを参照。

### 取得するパフォーマンスカウンター

| カテゴリ | カウンターセット | デフォルトフィルター |
|---------|-----------------|---------------------|
| Memory Manager | *sql*:Memory Manager* | Total Server Memory, Target Server Memory, Connection Memory, Lock Memory等 |
| Plan Cache | *sql*:Plan Cache* | cache pages, procedure plan, ad hoc sql plan, prepared SQL Plan |
| Buffer Manager | *Buffer Manager* | Free pages, Reserved pages, Stolen pages, Total pages, Database pages等 |
| SSAS | MSAS*:Memory | memory |
| SSIS | *SSIS* | memory |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | NetworkError | コンピュータ名解決失敗 | 警告出力して継続 |
| - | RemoteError | リモートコマンド実行失敗 | Stop-Functionでエラー出力 |
| - | CounterError | パフォーマンスカウンター取得失敗 | Verbose出力（スクリプトブロック内） |

### リトライ仕様

自動リトライなし。

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

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

## パフォーマンス要件

- リモートコマンド実行のためネットワーク遅延の影響を受ける
- 複数のパフォーマンスカウンターセットを順次取得

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

- 対象コンピュータへのローカル管理者権限が必要
- Credentialパラメータで別のWindowsユーザーとして実行可能
- PowerShellリモート実行が有効である必要あり

## 備考

- SSRSにはメモリカウンターがなく、メモリシュリンクと圧迫状態のみ
- 非英語環境ではカウンター名がローカライズされるため、*CounterRegexパラメータで調整可能
- MSDNのSSISカウンター資料を参照

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaMemoryUsage.ps1 | `public/Get-DbaMemoryUsage.ps1` | 235-242行目の出力オブジェクト定義 |

**読解のコツ**: スクリプトブロック内で生成されたオブジェクトを、processブロックでDbaSize型に変換している。

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

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

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

**主要処理フロー**:
1. **104-116行目**: パラメータ定義
2. **108行目**: ComputerNameのデフォルト値 $env:COMPUTERNAME
3. **110-114行目**: 各カウンター正規表現のデフォルト値

#### Step 3: スクリプトブロックを理解する

リモート実行されるカウンター収集ロジック。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaMemoryUsage.ps1 | `public/Get-DbaMemoryUsage.ps1` | 118-226行目のスクリプトブロック |

**主要処理フロー**:
- **128-145行目**: Memory Managerカウンター取得
- **147-165行目**: Plan Cacheカウンター取得
- **166-185行目**: Buffer Managerカウンター取得
- **186-205行目**: SSASカウンター取得
- **206-225行目**: SSISカウンター取得

#### Step 4: リモート実行処理を理解する

コンピュータへの接続とスクリプトブロック実行。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaMemoryUsage.ps1 | `public/Get-DbaMemoryUsage.ps1` | 228-252行目のprocessブロック |

**主要処理フロー**:
- **229-231行目**: Resolve-DbaNetworkNameによる名前解決
- **233-244行目**: Invoke-Command2によるリモート実行と結果処理

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

```
Get-DbaMemoryUsage
    │
    ├─ Resolve-DbaNetworkName (内部関数)
    │      └─ コンピュータ名解決
    │
    └─ Invoke-Command2 (内部関数)
           │
           └─ [スクリプトブロック] (リモート実行)
                  ├─ Get-Counter -ListSet '*sql*:Memory Manager*'
                  ├─ Get-Counter -ListSet '*sql*:Plan Cache*'
                  ├─ Get-Counter -ListSet '*Buffer Manager*'
                  ├─ Get-Counter -ListSet 'MSAS*:Memory'
                  └─ Get-Counter -ListSet '*SSIS*'
```

### データフロー図

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

ComputerName ─────────▶ Resolve-DbaNetworkName ─────▶ FullComputerName
                                │
Credential ──────────────────────┘
                                │
                                ▼
*CounterRegex ────────▶ Invoke-Command2
                        (スクリプトブロック実行)
                                │
                    ┌───────────┼───────────┐
                    ▼           ▼           ▼
            Memory Manager  Plan Cache  Buffer Manager
                    │           │           │
                    └───────────┼───────────┘
                                │
                    ┌───────────┼───────────┐
                    ▼           ▼           ▼
                  SSAS        SSIS     (各カウンター)
                    │           │           │
                    └───────────┼───────────┘
                                │
                                ▼
                        DbaSize変換 ────────────▶ パイプライン出力
                        (MB→バイト)

出力プロパティ:
- ComputerName, SqlInstance
- CounterInstance, Counter
- Pages, Memory
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaMemoryUsage.ps1 | `public/Get-DbaMemoryUsage.ps1` | ソース | メイン機能実装 |
| Get-DbaMemoryUsage.Tests.ps1 | `tests/Get-DbaMemoryUsage.Tests.ps1` | テスト | Pesterユニットテスト |
