# 機能設計書 407-Get-DbaLatchStatistic

## 概要

本ドキュメントは、SQL Serverからラッチ競合統計を取得してパフォーマンスボトルネックを特定する`Get-DbaLatchStatistic`機能について記述する。

### 本機能の処理概要

**業務上の目的・背景**：ラッチはSQL Serverがメモリ内のデータ構造を保護するために使用する軽量な同期メカニズムである。ラッチ競合が発生すると、クエリの待機時間が増加しパフォーマンスが低下する。本機能は、Paul Randalのラッチトラブルシューティング手法に基づき、sys.dm_os_latch_statsから累積待機時間の割合に基づいて最も重要なラッチクラスを返す。各結果にはSQLSkillsドキュメントへの直接リンクが含まれ、手動でのDMVクエリなしでラッチ関連のパフォーマンスボトルネックを診断・修正できる。

**機能の利用シーン**：
- ラッチ競合によるパフォーマンス問題の診断時
- パフォーマンスボトルネックの原因特定時
- ラッチ統計のベースライン確立時
- SQLSkillsドキュメントを参照したトラブルシューティング時

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. sys.dm_os_latch_statsからラッチ統計を取得
3. 累積待機時間割合に基づくフィルタリング（デフォルト95%）
4. SQLSkillsへのURLを含む結果オブジェクトの生成
5. ラッチクラス、待機時間、待機回数、平均待機時間の出力

**関連システム・外部連携**：SQL Serverの動的管理ビュー`sys.dm_os_latch_stats`を参照する。SQLSkillsのラッチヘルプページへのリンクを生成。

**権限による制御**：VIEW SERVER STATE権限またはsysadminロールが必要。

## 関連画面

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

## 機能種別

データ取得（パフォーマンス診断）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstance[] | Yes | 対象のSQL Serverインスタンス | DbaInstance型による検証 |
| SqlCredential | PSCredential | No | SQL Server認証用の資格情報 | PowerShell資格情報オブジェクト |
| Threshold | int | No | 累積待機時間割合の閾値（%）、デフォルト95 | 整数値（0-100） |
| EnableException | switch | No | 例外処理を有効化 | - |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全修飾SQL Serverインスタンス名 |
| WaitType | string | ラッチクラス名（sys.dm_os_latch_statsから） |
| WaitSeconds | decimal(14,2) | このラッチクラスの合計待機時間（秒） |
| WaitCount | bigint | このラッチクラスの待機リクエスト数 |
| Percentage | decimal(14,2) | 全ラッチ待機時間に対するこのクラスの割合（0-100%） |
| AverageWaitSeconds | decimal(14,4) | このラッチクラスの平均待機時間（秒） |
| URL | string | SQLSkillsラッチドキュメントへのハイパーリンク |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. SQLクエリ準備（BEGINブロック）
   └─ CTEによるラッチ統計集計クエリ構築
   └─ BUFFERラッチクラスを除外
   └─ 累積割合によるフィルタリング

2. 各インスタンスに対してループ処理
   └─ Test-FunctionInterruptによる中断チェック
   └─ Connect-DbaInstanceによる接続確立（MinimumVersion 9）
   └─ 接続失敗時はStop-Functionで継続処理

3. SQLクエリ実行
   └─ Thresholdに基づくフィルタリング適用

4. 結果オブジェクト出力
   └─ SQLSkills URLを含むPSCustomObject生成
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SQLクエリ準備]
    B --> C{Test-FunctionInterrupt?}
    C -->|Yes| Z[終了]
    C -->|No| D{各インスタンスでループ}
    D --> E[Connect-DbaInstance]
    E --> F{接続成功?}
    F -->|No| G[Stop-Function -Continue]
    G --> D
    F -->|Yes| H[SQLクエリ実行]
    H --> I{各レコードでループ}
    I --> J[PSCustomObject生成]
    J --> K[パイプライン出力]
    K --> I
    I -->|ループ終了| D
    D -->|ループ終了| Z
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | バージョン要件 | SQL Server 2005以上が必要 | 接続時に検証 |
| BR-002 | BUFFERラッチ除外 | BUFFERラッチクラスは結果から除外 | 常時適用 |
| BR-003 | デフォルト閾値 | Thresholdのデフォルトは95%（Paul Randalの手法） | Threshold未指定時 |
| BR-004 | URL生成 | https://www.sqlskills.com/help/latches/{ラッチクラス} | 各ラッチクラスに対して |
| BR-005 | 累積割合フィルター | 累積待機時間割合がThreshold未満のラッチのみ返す | 常時適用 |

### 計算ロジック

- 待機秒数: `wait_time_ms / 1000.0`
- 割合: `100.0 * wait_time_ms / SUM(wait_time_ms) OVER()`
- 平均待機秒数: `WaitS / WaitCount` (WaitCount > 0の場合)
- 累積割合フィルター: `SUM(Percentage) OVER rows <= Threshold`

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ラッチ統計取得 | sys.dm_os_latch_stats | SELECT | ラッチクラスごとの待機統計取得 |

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

#### sys.dm_os_latch_stats

| 操作 | 項目（カラム名） | 取得条件 | 備考 |
|-----|-----------------|---------|------|
| SELECT | latch_class | latch_class NOT IN ('BUFFER') | ラッチクラス名 |
| SELECT | wait_time_ms | - | 合計待機時間（ミリ秒） |
| SELECT | waiting_requests_count | - | 待機リクエスト数 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverへの接続失敗 | Stop-Functionで処理継続 |
| - | VersionError | SQL Server 2005未満 | MinimumVersionで接続拒否 |

### リトライ仕様

自動リトライなし。

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

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

## パフォーマンス要件

- クエリ実行時間：通常1秒未満
- Threshold 100%指定時は全ラッチクラスを返す

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

- VIEW SERVER STATE権限またはsysadminロールが必要
- SqlCredentialパラメータでSQL認証を使用可能

## 備考

- Paul Randalのトラブルシューティング手法に基づいた実装
- SQLSkillsのブログ記事およびラッチヘルプページを参照
- 結果のURLをStart-Processで開くことでドキュメントを閲覧可能

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: URLプロパティはXML型としてSQLから返され、文字列として出力される。

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

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

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

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

#### Step 3: SQLクエリを理解する

ラッチ統計を集計するSQLクエリ。

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

**主要処理フロー**:
- **109-119行目**: Latches CTEによる基本統計計算
- **118行目**: BUFFERラッチの除外
- **120-131行目**: 累積割合によるフィルタリング

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

```
Get-DbaLatchStatistic
    │
    ├─ Test-FunctionInterrupt (内部関数)
    │      └─ 処理中断チェック
    │
    ├─ Connect-DbaInstance (内部関数)
    │      └─ SQL Server接続確立
    │
    └─ $server.Query() (SMOメソッド)
           └─ ラッチ統計取得クエリ
```

### データフロー図

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

SqlInstance ───────────▶ Connect-DbaInstance ──────▶ $server
                                 │
SqlCredential ───────────────────┘
                                 │
                                 ▼
Threshold ─────────────▶ SQLクエリ実行
                         (ラッチ統計集計)
                                 │
                                 ▼
                         累積割合フィルタリング
                                 │
                                 ▼
                         PSCustomObject生成 ────────▶ パイプライン出力
                         (ComputerName, InstanceName,
                          SqlInstance, WaitType,
                          WaitSeconds, WaitCount,
                          Percentage, AverageWaitSeconds,
                          URL)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaLatchStatistic.ps1 | `public/Get-DbaLatchStatistic.ps1` | ソース | メイン機能実装 |
| Get-DbaLatchStatistic.Tests.ps1 | `tests/Get-DbaLatchStatistic.Tests.ps1` | テスト | Pesterユニットテスト |
| Clear-DbaLatchStatistics.ps1 | `public/Clear-DbaLatchStatistics.ps1` | ソース | ラッチ統計クリア（関連機能） |
