# 機能設計書 301-Get-DbaXESessionTarget

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Get-DbaXESessionTarget` コマンドレットの機能設計を記述する。このコマンドレットはSQL Serverの拡張イベント(Extended Events)セッションのターゲット構成情報を取得する機能を提供する。

### 本機能の処理概要

`Get-DbaXESessionTarget` は、SQL Serverインスタンス上で構成されている拡張イベントセッションのターゲット情報を詳細に取得するコマンドレットである。ターゲットとは、拡張イベントで収集されたデータの出力先（イベントファイル、リングバッファ、イベントカウンター等）を指す。

**業務上の目的・背景**：SQL Server DBAは、拡張イベントセッションがどこにデータを出力しているかを確認する必要がある。パフォーマンス監視、セキュリティ監査、トラブルシューティング等の場面で、XEログファイルの場所を特定したり、ターゲット構成を検証したりすることが頻繁に求められる。本機能により、複数のSQLインスタンスに対して一括でターゲット情報を取得でき、運用効率が大幅に向上する。

**機能の利用シーン**：
- XEログファイル（.xel）の物理的な場所を特定したい場合
- リングバッファやイベントファイル等のターゲット構成を確認したい場合
- 拡張イベントセッションが正しくデータを収集しているかの検証時
- 複数のSQLインスタンスに対するXE構成の一括監査時

**主要な処理内容**：
1. SQL Serverインスタンスに接続し、XEセッション情報を取得
2. 各セッションのターゲットオブジェクトをイテレーション
3. ターゲットファイルのパスをローカルパスとUNCパスの両方で解決
4. メタデータ（セッション名、ステータス、パッケージ名等）を付与して出力

**関連システム・外部連携**：SQL Server Management Objects (SMO) を通じてSQL Serverに接続する。ファイルパス解決時には `Join-AdminUnc` 関数を使用してリモートアクセス用のUNCパスを生成する。

**権限による制御**：sysadmin権限が必要。SQL Server 2008以降をサポート。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 86 | XEセッションターゲット | 主機能 | XEセッションターゲットの取得 |

## 機能種別

データ取得処理（SELECT）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes（ParameterSet: instance） | 接続先SQLインスタンス | SQL Server 2008以降 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | Windows/SQL認証対応 |
| Session | string[] | No | 対象セッション名（ワイルドカード対応） | - |
| Target | string[] | No | 対象ターゲット種別（event_file等） | - |
| InputObject | Microsoft.SqlServer.Management.XEvent.Session[] | Yes（ParameterSet: piped） | パイプライン入力用セッションオブジェクト | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- SQL Serverインスタンスの拡張イベント構成（SMO経由）
- Get-DbaXESessionからのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQLインスタンスのコンピューター名 |
| InstanceName | String | SQLインスタンス名 |
| SqlInstance | String | 完全修飾インスタンス名 |
| Session | String | セッション名 |
| SessionStatus | String | セッションステータス（Running/Stopped） |
| Name | String | ターゲット種別名（package0.event_file等） |
| ID | Int | ターゲットID |
| Field | Collection | ターゲットフィールド構成 |
| PackageName | String | パッケージ名 |
| File | String[] | ファイルパス配列 |
| Description | String | ターゲットの説明 |
| ScriptName | String | スクリプト用名称 |
| TargetFile | String[] | ローカルファイルパス |
| RemoteTargetFile | String[] | UNCパス |

### 出力先

PowerShellパイプライン（コンソール出力またはパイプライン後続処理）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectの確認
2. SQLインスタンスへの接続（SqlInstance指定時）
   └─ Get-DbaXESessionを呼び出してセッション取得
3. Get-Target内部関数の呼び出し
   └─ 各セッションのターゲットを処理
4. ターゲットファイル情報の解決
   └─ ファイル名フィールドからパスを構築
   └─ 相対パスの場合はErrorLogPathと結合
   └─ UNCパスの生成
5. NotePropertyの追加
   └─ ComputerName, InstanceName等のメタデータ
6. Select-DefaultViewで出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaXESession呼び出し]
    B -->|No| D[InputObjectを使用]
    C --> E[Get-Target内部関数]
    D --> E
    E --> F{各セッションを処理}
    F --> G{Sessionフィルタ適用}
    G -->|該当| H[各ターゲットを処理]
    G -->|非該当| F
    H --> I{Targetフィルタ適用}
    I -->|該当| J[ファイルパス解決]
    I -->|非該当| H
    J --> K[NoteProperty追加]
    K --> L[Select-DefaultView出力]
    L --> H
    H --> M{次のターゲット?}
    M -->|Yes| H
    M -->|No| F
    F --> N{次のセッション?}
    N -->|Yes| F
    N -->|No| O[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-301-01 | ファイルパス解決 | 相対パスの場合はErrorLogPathと結合 | ファイル名にドライブ文字・UNCパスが含まれない場合 |
| BR-301-02 | セッションステータス判定 | IsRunningフラグに基づきRunning/Stoppedを設定 | 常時 |
| BR-301-03 | UNCパス生成 | Join-AdminUnc関数でリモートアクセス用パス生成 | ファイルターゲットが存在する場合 |

### 計算ロジック

- ファイルパス解決: `$directory = $server.ErrorLogPath.TrimEnd("\"); $file = "$directory\$file"`

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 取得 | sys.dm_xe_sessions | SELECT | セッション情報取得（SMO経由） |

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

#### sys.dm_xe_sessions（SMO経由）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | Targets | セッションに属するターゲット情報 | SMOを通じて取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQLインスタンス接続失敗 | Stop-Functionで警告後継続 |
| - | FunctionInterrupt | 処理中断フラグ検知 | 早期リターン |

### リトライ仕様

なし（エラー時はStop-Functionで処理を継続）

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

なし（読み取り専用処理）

## パフォーマンス要件

- 複数インスタンスへの並列実行はサポートされない（順次処理）
- 大量のセッション・ターゲットがある場合でも実用的な応答時間

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

- sysadmin権限が必要
- SqlCredentialによる代替認証をサポート
- Windows認証、SQL認証、Active Directory認証に対応

## 備考

- Get-DbaXESession、Get-DbaXESessionTargetFile と組み合わせて使用することが多い
- SQL Server 2008以降が必要

---

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

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

### 推奨読解順序

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

SMOのXEventターゲットオブジェクト構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaXESessionTarget.ps1 | `public/Get-DbaXESessionTarget.ps1` | 出力オブジェクトの構造（46-79行目のOUTPUTS記述） |

**読解のコツ**: Add-MemberでNotePropertyを追加している箇所（146-152行目）を確認し、出力オブジェクトにどのようなプロパティが付与されるかを把握する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaXESessionTarget.ps1 | `public/Get-DbaXESessionTarget.ps1` | process ブロック（160-167行目） |

**主要処理フロー**:
1. **161行目**: Test-FunctionInterrupt で中断チェック
2. **163-165行目**: SqlInstanceからGet-DbaXESessionでセッション取得
3. **166行目**: Get-Target内部関数を呼び出し

#### Step 3: 内部関数Get-Targetを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaXESessionTarget.ps1 | `public/Get-DbaXESessionTarget.ps1` | begin ブロック内のGet-Target関数（109-157行目） |

**主要処理フロー**:
- **118-156行目**: セッションごとにターゲットを処理
- **131行目**: ファイル名フィールドの取得
- **136-143行目**: ファイルパスの解決とUNCパス生成
- **146-152行目**: メタデータの付与
- **154行目**: デフォルトビューでの出力

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

```
Get-DbaXESessionTarget
    │
    ├─ Test-FunctionInterrupt
    │
    ├─ Get-DbaXESession（SqlInstance指定時）
    │
    └─ Get-Target（内部関数）
           │
           ├─ Join-AdminUnc
           │
           ├─ Add-Member
           │
           └─ Select-DefaultView
```

### データフロー図

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

SqlInstance ───────────────▶ Get-DbaXESession ──▶ Session[]
                                    │
                                    ▼
Session/Target Filter ────▶ Get-Target ─────────▶ Target[] + Metadata
                                    │
                                    ▼
                             Join-AdminUnc ─────▶ UNC Paths
                                    │
                                    ▼
                             Add-Member ────────▶ Enriched Target Object
                                    │
                                    ▼
                             Select-DefaultView ─▶ Console/Pipeline Output
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaXESessionTarget.ps1 | `public/Get-DbaXESessionTarget.ps1` | ソース | メインコマンドレット |
| Get-DbaXESession.ps1 | `public/Get-DbaXESession.ps1` | ソース | セッション取得（依存先） |
| Join-AdminUnc | 内部関数 | ユーティリティ | UNCパス生成 |
| Select-DefaultView | 内部関数 | ユーティリティ | 出力フォーマット |
