# 機能設計書 484-Get-DbaAgentAlertCategory

## 概要

本ドキュメントは、SQL Server Agent のアラートカテゴリと関連アラート数を取得する Get-DbaAgentAlertCategory 関数の機能設計書である。

### 本機能の処理概要

Get-DbaAgentAlertCategory は、対象インスタンスからすべての SQL Server Agent アラートカテゴリを取得し、各カテゴリに割り当てられているアラートの数を表示する機能を提供する。カテゴリはアラートを論理的にグループ化し、重大度ベースのアラート、データベースメンテナンスアラート、カスタムビジネスアラートなどを整理・管理するのに役立つ。

**業務上の目的・背景**：大規模な SQL Server 環境では、アラートを適切に分類することで管理が容易になる。アラートカテゴリの構成を確認し、未使用のカテゴリや過度に使用されているカテゴリを特定することで、アラート管理の最適化が可能となる。

**機能の利用シーン**：
- アラートの組織構造の確認
- 未使用カテゴリの特定と削除候補の洗い出し
- カテゴリ別アラート数の監査
- 新規カテゴリ作成前の既存カテゴリ確認
- 複数サーバー間でのカテゴリ構成の比較

**主要な処理内容**：
1. 指定されたインスタンスへの接続
2. AlertCategories コレクションの取得
3. Category パラメータによるフィルタリング
4. 各カテゴリに属するアラート数のカウント
5. カスタムプロパティの追加と結果出力

**関連システム・外部連携**：SQL Server Agent の AlertCategories コレクションを SMO 経由で取得。アラート数のカウントには Alerts コレクションを使用。

**権限による制御**：msdb データベースへの読み取りアクセスが必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 12 | Agentアラート管理 | 補助機能 | アラートカテゴリの取得 |

## 機能種別

データ取得 / 監査・レポーティング

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可 |
| SqlCredential | PSCredential | No | 認証用資格情報 | Windows/SQL認証対応 |
| Category | string[] | No | 取得するカテゴリ名 | ワイルドカード非対応 |
| EnableException | Switch | No | 例外処理を有効化 | - |

### 入力データソース

SMO を介した SQL Server インスタンスの JobServer.AlertCategories コレクションから取得。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverのコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なインスタンス名 |
| Name | String | カテゴリ名 |
| ID | Int | カテゴリID |
| AlertCount | Int | カテゴリに属するアラート数 |

### 出力先

パイプライン出力として Microsoft.SqlServer.Management.Smo.Agent.AlertCategory オブジェクトを返す。

## 処理フロー

### 処理シーケンス

```
1. 各インスタンスに対してループ処理
   └─ Connect-DbaInstance で接続
   └─ 接続失敗時は Continue で次へ

2. AlertCategories の取得
   └─ $server.JobServer.AlertCategories から取得

3. フィルタリング処理
   └─ Category パラメータ: 完全一致フィルタ

4. 各カテゴリに対するループ処理
   └─ アラート数のカウント
   └─ カスタムプロパティの追加

5. 結果の出力
   └─ Select-DefaultView で表示プロパティ設定
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[インスタンスループ開始]
    B --> C[インスタンス接続]
    C --> D{接続成功?}
    D -->|No| B
    D -->|Yes| E[AlertCategories取得]
    E --> F{Category指定?}
    F -->|Yes| G[カテゴリ名でフィルタ]
    F -->|No| H[カテゴリループ開始]
    G --> H
    H --> I[アラート数カウント]
    I --> J[カスタムプロパティ追加]
    J --> K[Select-DefaultView]
    K --> L[結果出力]
    L --> M{次のカテゴリ?}
    M -->|Yes| H
    M -->|No| N{次のインスタンス?}
    N -->|Yes| B
    N -->|No| O[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | カテゴリフィルタ | Category は完全一致（-in 演算子） | Category指定時 |
| BR-002 | アラート数計算 | CategoryName一致のアラートをカウント | 常時 |

### 計算ロジック

**AlertCount の計算**:
```powershell
$alertCount = ($server.JobServer.Alerts | Where-Object { $_.CategoryName -eq $cat.Name }).Count
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| カテゴリ取得 | msdb.dbo.syscategories | SELECT | アラートカテゴリ一覧の取得（SMO経由） |
| アラート取得 | msdb.dbo.sysalerts | SELECT | カテゴリ別アラート数のカウント（SMO経由） |

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

本機能は読み取り専用であり、データベースへの書き込みは行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | インスタンス接続失敗 | Continue で次のインスタンスへ |
| CategoryError | カテゴリエラー | カテゴリ取得時のエラー | Stop-Function で警告出力、Continue |

### リトライ仕様

特になし。

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

読み取り専用のため、トランザクション制御は不要。

## パフォーマンス要件

- カテゴリ数は通常少数（10未満）のため、パフォーマンス問題は発生しにくい
- アラート数カウントのため、各カテゴリで Alerts コレクションを走査

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

- msdb データベースへの読み取りアクセスが必要
- SQL 認証を使用する場合、資格情報は PSCredential オブジェクトとして安全に渡される

## 備考

- Category パラメータはワイルドカードをサポートしない（完全一致のみ）
- AlertCount プロパティは動的に計算されるカスタムプロパティ
- 組み込みカテゴリ（[Uncategorized] など）も含めて取得

---

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

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

### 推奨読解順序

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

パラメータ定義と出力プロパティの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaAgentAlertCategory.ps1 | `public/Get-DbaAgentAlertCategory.ps1` | 70-77行目: パラメータ定義 |
| 1-2 | Get-DbaAgentAlertCategory.ps1 | `public/Get-DbaAgentAlertCategory.ps1` | 28-46行目: .OUTPUTS ドキュメント |

**読解のコツ**: Category パラメータがワイルドカード非対応で、AlertCount がカスタムプロパティであることに注目。

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

処理の起点となる process ブロックを特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaAgentAlertCategory.ps1 | `public/Get-DbaAgentAlertCategory.ps1` | 79-110行目: processブロック全体 |

**主要処理フロー**:
1. **81-86行目**: インスタンスへの接続
2. **88-91行目**: AlertCategories の取得とフィルタリング
3. **93行目**: デフォルト表示プロパティの定義

#### Step 3: アラート数カウントとプロパティ追加を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaAgentAlertCategory.ps1 | `public/Get-DbaAgentAlertCategory.ps1` | 95-108行目: カテゴリループとプロパティ追加 |

**主要処理フロー**:
- **97行目**: アラート数のカウント（CategoryName一致）
- **99-102行目**: Add-Member でカスタムプロパティ追加
- **104行目**: Select-DefaultView で表示プロパティ設定

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

```
Get-DbaAgentAlertCategory
    │
    └─ [process] foreach ($instance in $SqlInstance)
           │
           ├─ Connect-DbaInstance
           │      └─ インスタンス接続
           │
           ├─ $server.JobServer.AlertCategories
           │      └─ カテゴリコレクション取得
           │
           ├─ Where-Object フィルタ
           │      └─ Category: -in でフィルタ
           │
           └─ foreach ($cat in $alertCategories)
                  │
                  ├─ $server.JobServer.Alerts | Where-Object
                  │      └─ CategoryName 一致のアラートをカウント
                  │
                  ├─ Add-Member
                  │      ├─ ComputerName
                  │      ├─ InstanceName
                  │      ├─ SqlInstance
                  │      └─ AlertCount
                  │
                  └─ Select-DefaultView
                         └─ 表示プロパティ設定
```

### データフロー図

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

SqlInstance ─────────────────▶ Connect-DbaInstance ─────────────▶ SMO Server
                                │
                                ▼
Category ────────────────────▶ $server.JobServer.AlertCategories
                                │
                                ▼
                          Where-Object フィルタ (-in)
                                │
                                ▼
                          foreach カテゴリ
                                │
                                ├──▶ Alerts.Where(CategoryName) ──▶ .Count
                                │
                                ▼
                          Add-Member (AlertCount)
                                │
                                ▼
                          Select-DefaultView ─────────────────────▶ AlertCategory Objects
                                                                    - Name
                                                                    - ID
                                                                    - AlertCount
                                                                    ...
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaAgentAlertCategory.ps1 | `public/Get-DbaAgentAlertCategory.ps1` | ソース | メイン関数 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | インスタンス接続 |
| Get-DbaAgentAlert.ps1 | `public/Get-DbaAgentAlert.ps1` | ソース | 関連機能（アラート取得） |
| New-DbaAgentAlertCategory.ps1 | `public/New-DbaAgentAlertCategory.ps1` | ソース | 関連機能（カテゴリ作成） |
| Remove-DbaAgentAlertCategory.ps1 | `public/Remove-DbaAgentAlertCategory.ps1` | ソース | 関連機能（カテゴリ削除） |
