# 機能設計書 272-Get-DbaDbMirrorMonitor

## 概要

本ドキュメントは、SQL Serverデータベースミラーリングのパフォーマンスメトリクスと監視履歴を取得するdbatools PowerShellコマンド`Get-DbaDbMirrorMonitor`の機能設計書です。

### 本機能の処理概要

`Get-DbaDbMirrorMonitor`は、msdbデータベースの監視テーブルから詳細なデータベースミラーリングパフォーマンス統計を取得し、ミラーリングの健全性追跡とパフォーマンスボトルネックの特定を支援します。sp_dbmmonitorresultsストアドプロシージャを実行して、ログ生成率、送信率、トランザクション遅延、リカバリ進捗などのメトリクスを取得します。

**業務上の目的・背景**：データベースミラーリングのパフォーマンス監視は、高可用性構成の健全性維持に不可欠です。DBAはレプリケーションラグのトラブルシューティング、パフォーマンス監視、コンプライアンスレポート生成のために詳細なメトリクスを必要とします。本コマンドは、システムテーブルへの手動クエリを排除し、重要な指標を一括取得できます。

**機能の利用シーン**：
- ミラーリングパフォーマンスの問題調査
- レプリケーションラグの監視
- 高可用性構成のコンプライアンスレポート生成
- プリンシパルとミラー間のデータ同期状態確認

**主要な処理内容**：
1. Get-DbaDatabaseを使用してデータベースオブジェクトを取得
2. msdb.dbo.dbm_monitor_dataテーブルの存在確認
3. sp_dbmmonitorresultsストアドプロシージャの実行
4. 取得結果をPSCustomObjectとして整形出力

**関連システム・外部連携**：SQL Serverのmsdbデータベース内のミラーリング監視テーブルとストアドプロシージャを使用します。

**権限による制御**：sysadmin権限が推奨されます。sp_dbmmonitorupdateの実行（-Updateパラメータ使用時）にはsysadmin権限が必要です。監視データの更新は15秒に1回に制限されています。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | PowerShellコンソール | 主画面 | コマンド実行・結果表示 |

## 機能種別

データ取得（SELECT操作）/ ストアドプロシージャ実行

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス | - |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows/SQL認証対応 |
| Database | string[] | No | 対象データベース名 | - |
| InputObject | Microsoft.SqlServer.Management.Smo.Database[] | No | パイプライン入力データベース | ValueFromPipeline |
| Update | switch | No | 統計を更新してから取得 | - |
| LimitResults | string | No | 取得行数/期間の制限 | ValidateSet |
| EnableException | switch | No | 例外処理の有効化 | - |

### LimitResults オプション

| オプション値 | sp_dbmmonitorresults mode値 | 説明 |
|-------------|---------------------------|------|
| LastRow | 0 | 最新の1行のみ |
| LastTwoHours | 1 | 直近2時間（デフォルト） |
| LastFourHours | 2 | 直近4時間 |
| LastEightHours | 3 | 直近8時間 |
| LastDay | 4 | 直近24時間 |
| LastTwoDays | 5 | 直近48時間 |
| Last100Rows | 6 | 直近100行 |
| Last500Rows | 7 | 直近500行 |
| Last1000000Rows | 8 | 直近100万行 |

### 入力データソース

- SQL Serverインスタンスへの接続情報
- Get-DbaDatabaseからのデータベースオブジェクト
- msdb.dbo.dbm_monitor_dataテーブル

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全修飾インスタンス名 |
| DatabaseName | string | ミラーリング対象データベース名 |
| Role | string | サーバーロール（Principal/Mirror） |
| MirroringState | string | ミラーリング状態 |
| WitnessStatus | string | ウィットネス接続状態 |
| LogGenerationRate | int | ログ生成率（KB/秒） |
| UnsentLog | int | 未送信ログサイズ（KB） |
| SendRate | int | ログ送信率（KB/秒） |
| UnrestoredLog | int | 未復元ログサイズ（KB） |
| RecoveryRate | int | リカバリ率（KB/秒） |
| TransactionDelay | int | トランザクション遅延（ミリ秒） |
| TransactionsPerSecond | int | 1秒あたりトランザクション数 |
| AverageDelay | int | 平均遅延（ミリ秒） |
| TimeRecorded | DateTime | 記録日時 |
| TimeBehind | int | ミラー遅延時間（ミリ秒） |
| LocalTime | DateTime | サーバーローカル時刻 |

### 出力先

パイプライン出力（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. LimitResultsパラメータをmode値に変換
   └─ switch文で0-8の数値にマッピング
2. Updateパラメータをブール値に変換
   └─ $false → 0, $true → 1
3. SqlInstanceからデータベースオブジェクト取得
   └─ Get-DbaDatabaseを使用
4. 各データベースに対してループ処理
   └─ InputObjectとSqlInstance両方を統合
5. dbm_monitor_dataテーブルの存在確認
   └─ 存在しない場合はエラーメッセージ出力
6. sp_dbmmonitorresults実行
   └─ database_name, mode, update_tableパラメータを指定
7. 結果をPSCustomObjectに整形
   └─ 17個のプロパティを含むオブジェクト作成
8. オブジェクト出力
   └─ 即座にパイプラインへ出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[LimitResults変換]
    B --> C[Update値変換]
    C --> D[SqlInstanceループ]
    D --> E[Get-DbaDatabase実行]
    E --> F[データベースループ]
    F --> G{dbm_monitor_data<br/>存在確認}
    G -->|No| H[Stop-Function]
    G -->|Yes| I[sp_dbmmonitorresults<br/>実行]
    I --> J{結果あり?}
    J -->|Yes| K[PSCustomObject作成]
    J -->|No| L[次のDB]
    K --> M[オブジェクト出力]
    M --> L
    H --> L
    L --> N{次のDB<br/>あり?}
    N -->|Yes| F
    N -->|No| O{次のインスタンス<br/>あり?}
    O -->|Yes| D
    O -->|No| P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-272-01 | 監視テーブル必須 | dbm_monitor_dataテーブルが存在しない場合はエラー | 常時 |
| BR-272-02 | 更新間隔制限 | sp_dbmmonitorupdateは15秒に1回のみ実行可能 | Update=true時 |
| BR-272-03 | デフォルト期間 | LimitResults未指定時は直近2時間のデータを取得 | パラメータ省略時 |

### 計算ロジック

LimitResultsからmode値への変換:
```powershell
$rows = switch ($LimitResults) {
    'LastRow' { 0 }
    'LastTwoHours' { 1 }
    'LastFourHours' { 2 }
    'LastEightHours' { 3 }
    'LastDay' { 4 }
    'LastTwoDays' { 5 }
    'Last100Rows' { 6 }
    'Last500Rows' { 7 }
    'Last1000000Rows' { 8 }
}
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 監視データ取得 | msdb.dbo.dbm_monitor_data | SELECT（間接） | sp_dbmmonitorresults経由 |
| 監視データ更新 | msdb.dbo.dbm_monitor_data | UPDATE（間接） | sp_dbmmonitorupdate経由（Update時） |

### ストアドプロシージャ呼び出し

#### sp_dbmmonitorresults

| パラメータ | 値 | 説明 |
|----------|-----|------|
| @database_name | $db | 対象データベース名 |
| @mode | $rows | 取得モード（0-8） |
| @update_table | $updatebool | テーブル更新フラグ（0/1） |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | テーブル未存在 | dbm_monitor_dataがない | Add-DbaDbMirrorMonitor実行を促す |
| - | 実行エラー | sp_dbmmonitorresults失敗 | Stop-Functionでエラー記録 |

### リトライ仕様

リトライ処理なし。エラー発生時は処理を停止しエラーメッセージを出力。

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

- 読み取り専用操作（Update=false時）
- Update=trueの場合、sp_dbmmonitorupdateが内部でトランザクションを管理

## パフォーマンス要件

- 大量の監視履歴取得時は適切なLimitResultsを指定
- Last1000000Rowsは大量データ取得のため注意が必要

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

- sysadmin権限推奨（特にUpdate使用時）
- PSCredentialによる安全な認証情報管理

## 備考

- 事前にAdd-DbaDbMirrorMonitorで監視ジョブを設定する必要がある
- SQL Server 2005以降で利用可能

---

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

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

### 推奨読解順序

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

監視データの構造とLimitResultsパラメータのマッピングを理解します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbMirrorMonitor.ps1 | `public/Get-DbaDbMirrorMonitor.ps1` | 110行目: ValidateSetで許可されるLimitResults値 |
| 1-2 | Get-DbaDbMirrorMonitor.ps1 | `public/Get-DbaDbMirrorMonitor.ps1` | 145-164行目: PSCustomObjectのプロパティ構造 |

**読解のコツ**: sp_dbmmonitorresultsストアドプロシージャの戻り値カラムと、PSCustomObjectのプロパティが1:1で対応しています。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbMirrorMonitor.ps1 | `public/Get-DbaDbMirrorMonitor.ps1` | 関数全体の構造（171行） |

**主要処理フロー**:
1. **102-113行目**: パラメータ定義
2. **114-129行目**: beginブロック - LimitResults/Update値の変換
3. **131-134行目**: SqlInstanceからInputObjectへの統合
4. **136-139行目**: dbm_monitor_dataテーブル存在確認
5. **140-142行目**: sp_dbmmonitorresults SQL生成と実行
6. **144-165行目**: 結果のPSCustomObject変換
7. **166-168行目**: エラーハンドリング

#### Step 3: 依存関係を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Add-DbaDbMirrorMonitor.ps1 | `public/Add-DbaDbMirrorMonitor.ps1` | 監視ジョブの設定（前提条件） |

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

```
Get-DbaDbMirrorMonitor
    │
    ├─ begin ブロック
    │      ├─ LimitResults → mode 変換
    │      └─ Update → updatebool 変換
    │
    ├─ Get-DbaDatabase (SqlInstance指定時)
    │      └─ Connect-DbaInstance
    │
    └─ foreach ($db in $InputObject)
           │
           ├─ テーブル存在確認
           │      └─ $db.Parent.Databases['msdb'].Tables['dbm_monitor_data']
           │
           ├─ sp_dbmmonitorresults 実行
           │      └─ $db.Parent.Query($sql)
           │
           └─ PSCustomObject 作成・出力
```

### データフロー図

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

SqlInstance ───────▶ Get-DbaDatabase ──────▶ Database Objects
      or                    │
InputObject ────────────────┤
                            ▼
                    msdb.dbm_monitor_data 確認
                            │
                            ▼
                    sp_dbmmonitorresults
                    (@database_name, @mode, @update_table)
                            │
                            ▼
                    PSCustomObject 作成 ──────▶ 監視メトリクス
                    (17プロパティ)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbMirrorMonitor.ps1 | `public/Get-DbaDbMirrorMonitor.ps1` | ソース | メイン機能実装 |
| Get-DbaDbMirrorMonitor.Tests.ps1 | `tests/Get-DbaDbMirrorMonitor.Tests.ps1` | テスト | 単体テスト |
| Add-DbaDbMirrorMonitor.ps1 | `public/Add-DbaDbMirrorMonitor.ps1` | ソース | 監視設定（前提） |
| Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | ソース | 依存関数 |
