# 機能設計書 311-Watch-DbaXESession

## 概要

本ドキュメントは、SQL Server Extended Events セッションをリアルタイムで監視し、発生するイベントデータをライブストリーミングするWatch-DbaXESession機能の設計仕様を記載する。

### 本機能の処理概要

Watch-DbaXESessionは、実行中のExtended Eventsセッションからライブイベントデータをストリーミングし、データベースアクティビティ、パフォーマンス問題、またはセキュリティイベントのリアルタイム監視を可能にする機能である。

**業務上の目的・背景**：SQL Serverのパフォーマンス問題やセキュリティインシデントの調査において、リアルタイムでのイベント監視は極めて重要である。従来のトレースファイル分析では事後的な分析しかできなかったが、本機能によりイベント発生時点での即座の確認が可能となり、問題の早期発見と迅速な対応を実現する。特に、間欠的に発生する問題や再現が困難な問題の調査において、ライブ監視は不可欠なツールである。

**機能の利用シーン**：本機能は以下のような場面で利用される。
- パフォーマンスボトルネックのリアルタイム調査
- デッドロックやブロッキングの即時検出
- セキュリティ監査イベントのライブモニタリング
- クエリ実行パターンの観察と分析
- 特定のワークロードに対するイベント収集

**主要な処理内容**：
1. SqlInstanceパラメータまたはInputObject（パイプライン入力）からXEセッション情報を取得
2. 指定されたXEセッションの実行状態を確認
3. Read-XEventコマンドレットを使用してライブイベントデータをストリーミング
4. 各イベントのフィールドとアクションを動的に処理し、整形されたPowerShellオブジェクトとして出力
5. セッション停止またはユーザー中断まで継続的にイベントを監視

**関連システム・外部連携**：SQL Server Management Objects (SMO)を使用してXEセッションに接続し、Microsoft.SqlServer.XEvent.Linq名前空間のRead-XEventコマンドレットでイベントストリームを読み取る。

**権限による制御**：対象のSQL Serverインスタンスに対するsysadmin権限が必要。SQL Server 2008以降のバージョンで動作する。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 84 | XEセッション管理 | 主機能 | 拡張イベントセッションのリアルタイム監視 |
| 85 | XEセッションテンプレート | 参照画面 | XEセッションテンプレートからのセッション選択 |

## 機能種別

データ連携 / リアルタイム監視

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter | No | 監視対象のSQL Serverインスタンス | SQL Server 2008以降、sysadmin権限必要 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | Windows認証、SQL認証、AD認証をサポート |
| Session | string | No | 監視するXEセッション名 | セッションが存在し実行中であること |
| InputObject | Microsoft.SqlServer.Management.XEvent.Session[] | No | Get-DbaXESessionからのパイプライン入力 | 有効なXESessionオブジェクト |
| Raw | switch | No | 生のXEventオブジェクトを返す | - |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

- SQL Serverインスタンスへの直接接続
- Get-DbaXESessionからのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| name | string | Extended Eventタイプ名（sql_statement_completed等） |
| timestamp | DateTime | イベントがキャプチャされた日時 |
| 動的プロパティ | 各種 | セッション設定に基づくイベントフィールドとアクション |

### 出力先

- PowerShellパイプライン（標準出力）
- Export-Csvなどへのパイプライン連携可能

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectのいずれかが必要
2. XEセッション取得
   └─ SqlInstance指定時はGet-DbaXESessionを呼び出し
3. セッション実行状態確認
   └─ IsRunningプロパティをチェック、未実行ならエラー
4. カラム構造の構築
   └─ name, timestampを基本カラムとし、フィールドとアクションを動的追加
5. イベントストリーミング開始
   └─ Read-XEventでライブデータを読み取り
6. イベント処理ループ
   └─ 各イベントをPSCustomObjectに変換して出力
7. 終了処理
   └─ セッション停止、PowerShell終了、またはCtrl-Cで終了
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaXESessionでセッション取得]
    B -->|No| D[InputObjectを使用]
    C --> E[foreach xesession]
    D --> E
    E --> F{セッション実行中?}
    F -->|No| G[エラー: セッション未実行]
    F -->|Yes| H[カラム構造構築]
    H --> I{Raw指定?}
    I -->|Yes| J[生のRead-XEvent結果を返却]
    I -->|No| K[Read-XEventでストリーミング開始]
    K --> L[イベント受信ループ]
    L --> M[ハッシュテーブル作成]
    M --> N[カラム値を設定]
    N --> O[Actions値を追加]
    O --> P[Fields値を追加]
    P --> Q[PSCustomObject出力]
    Q --> L
    L --> R{エラー発生?}
    R -->|Yes| S{セッション停止?}
    S -->|Yes| T[セッション停止メッセージ]
    S -->|No| U[エラーメッセージ]
    G --> V[次のセッションへ]
    J --> V
    T --> V
    U --> V
    V --> W[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | セッション実行状態確認 | 監視対象のXEセッションは実行中でなければならない | 常時 |
| BR-002 | フィールド名正規化 | collect_プレフィックスはフィールド名から除去される | フィールド処理時 |
| BR-003 | アクション名正規化 | アクション名はドット区切りの最後の部分のみ使用 | アクション処理時 |
| BR-004 | カラム順序 | name, timestampが先頭、その後にソートされたフィールド/アクション | 出力時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| XEセッション監視 | - | SELECT (DMV) | sys.dm_xe_sessionsなどを内部的に参照 |

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

本機能はDMVからの読み取りのみであり、ユーザーテーブルへの直接操作は行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | SessionNotRunning | XEセッションが実行中でない | Start-DbaXESessionでセッションを開始 |
| - | ConnectionError | SQL Serverへの接続失敗 | 接続情報と権限を確認 |
| - | StreamingError | ストリーミング中のエラー | セッション状態を確認し再実行 |

### リトライ仕様

エラー発生時は1秒待機後にセッション状態を再確認し、適切なエラーメッセージを出力する。

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

本機能は読み取り専用であり、トランザクション管理は不要。

## パフォーマンス要件

- イベント発生から出力までの遅延は最小限に抑える
- 高頻度イベントセッションでも安定したストリーミングを維持

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

- sysadmin権限が必要
- SqlCredentialによる認証情報の安全な受け渡し
- MFA対応はConnect-DbaInstanceを通じて実現

## 備考

- Ctrl-Cによる中断は、パイプライン処理中（Export-Csvへの出力中など）は即座に効かない場合がある
- 最も確実な終了方法はXEセッションを停止すること

---

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

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

### 推奨読解順序

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

XEセッションオブジェクトとイベントデータの構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Watch-DbaXESession.ps1 | `public/Watch-DbaXESession.ps1` | InputObjectの型（Microsoft.SqlServer.Management.XEvent.Session）を確認 |

**読解のコツ**: XEvent.Sessionオブジェクトは、Events、EventFields、Actionsなどのプロパティを持つSMOオブジェクト。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Watch-DbaXESession.ps1 | `public/Watch-DbaXESession.ps1` | param()ブロックでパラメータ定義を確認 |

**主要処理フロー**:
1. **82-91行目**: パラメータ定義（SqlInstance、Session、InputObject、Raw）
2. **92-95行目**: SqlInstance指定時のGet-DbaXESession呼び出し
3. **97-155行目**: メイン処理ループ

#### Step 3: XEセッション取得処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Watch-DbaXESession.ps1 | `public/Watch-DbaXESession.ps1` | 93-95行目のセッション取得ロジック |

**主要処理フロー**:
- **93-95行目**: SqlInstance指定時はGet-DbaXESessionを呼び出してInputObjectを取得

#### Step 4: カラム構造構築を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Watch-DbaXESession.ps1 | `public/Watch-DbaXESession.ps1` | 106-121行目のカラム構造構築 |

**主要処理フロー**:
- **107行目**: 基本カラム（name, timestamp）の定義
- **110-113行目**: EventFieldsからカラム抽出（collect_プレフィックス除去）
- **115-118行目**: Actionsからカラム抽出（ドット区切りの最後の部分）
- **120-121行目**: カラムのソートと重複除去

#### Step 5: イベントストリーミング処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | Watch-DbaXESession.ps1 | `public/Watch-DbaXESession.ps1` | 123-154行目のストリーミング処理 |

**主要処理フロー**:
- **124-126行目**: Raw指定時は生のRead-XEvent結果を返却
- **128-145行目**: 通常モードでのイベント処理ループ
- **130-142行目**: イベントデータをハッシュテーブルに変換
- **144行目**: PSCustomObjectとして出力

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

```
Watch-DbaXESession
    │
    ├─ Get-DbaXESession (SqlInstance指定時)
    │      └─ Connect-DbaInstance
    │
    ├─ Read-XEvent (XEvent.Linq)
    │      └─ イベントストリーミング
    │
    └─ Get-DbaXESession (エラー時のステータス確認)
```

### データフロー図

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

SqlInstance/Session ───▶ Get-DbaXESession ───▶ XESession オブジェクト
        │                                              │
        └─────────────────────────────────────────────┤
                                                       ▼
InputObject ──────────────────────────────────▶ セッション検証
                                                       │
                                                       ▼
                                              Read-XEvent
                                                       │
                                                       ▼
                                              イベント変換処理
                                                       │
                                                       ▼
                                              PSCustomObject ───▶ パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Watch-DbaXESession.ps1 | `public/Watch-DbaXESession.ps1` | ソース | メイン機能実装 |
| Get-DbaXESession.ps1 | `public/Get-DbaXESession.ps1` | ソース | XEセッション取得（依存先） |
| Start-DbaXESession.ps1 | `public/Start-DbaXESession.ps1` | ソース | XEセッション開始（関連機能） |
| Stop-DbaXESession.ps1 | `public/Stop-DbaXESession.ps1` | ソース | XEセッション停止（関連機能） |
