# 通知設計書 25-リスナー/AG名必須

## 概要

sp_BlitzBackupsプロシージャにおいて、@PushBackupHistoryToListener = 1（バックアップ履歴をリスナーにプッシュ）モードで実行時に、@WriteBackupsToListenerNameと@AGNameの両方がNULLの場合に発生するエラーメッセージの設計書。

### 本通知の処理概要

**業務上の目的・背景**：sp_BlitzBackupsのバックアップ履歴プッシュ機能は、Availability Group（AG）のリスナーを経由してリモートサーバーにデータを書き込む。書き込み先を特定するために、リスナー名を直接指定するか、AG名から自動的にリスナー名を解決する必要がある。両方がNULLの場合は書き込み先を特定できないため、エラーを発生させる。

**通知の送信タイミング**：@PushBackupHistoryToListener = 1で実行され、@WriteBackupsToDatabaseNameの検証を通過した後、@WriteBackupsToListenerName IS NULL かつ @AGName IS NULL の場合に発生する。

**通知の受信者**：sp_BlitzBackupsを実行したデータベース管理者。

**通知内容の概要**：@WriteBackupsToListenerNameと@AGNameの両方がNULLに設定されているが、少なくとも一方は必須である旨を通知する。

**期待されるアクション**：ユーザーは@WriteBackupsToListenerName（AGリスナーのDNS名）または@AGName（Availability Groupの名前）のいずれかを指定する。@AGNameを指定した場合、リスナー名はsys.availability_group_listenersから自動取得される。

## 通知種別

SQL Serverエラーメッセージ（RAISERROR）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（即時） |
| 優先度 | 高（重大度16） |
| リトライ | 無し |

### 送信先決定ロジック

プロシージャを実行したセッションに対して直接エラーメッセージとして送信される。

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | RAISERROR |
| 重大度 | 16 |
| 状態 | 1 |

### 本文テンプレート

```
@WriteBackupsToListenerName and @AGName can't both be NULL.
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzBackups実行（プッシュモード） | @WriteBackupsToListenerName IS NULL AND @AGName IS NULL | 両パラメータがNULL |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @PushBackupHistoryToListener = 0 | プッシュ機能未使用時 |
| @WriteBackupsToListenerNameに値あり | リスナー名が直接指定された場合 |
| @AGNameに値あり | AG名が指定された場合（リスナー名を自動解決） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[msdb書き込みチェック通過] --> B{@WriteBackupsToListenerName IS NULL?}
    B -->|No| C[リンクサーバー検証へ]
    B -->|Yes| D{@AGName IS NULL?}
    D -->|No| E[AG名からリスナー名を自動取得]
    D -->|Yes| F[RAISERROR発行]
    F --> G[RETURN - 処理終了]
    E --> C
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.availability_groups | AG名からgroup_id取得 | @AGName指定時（エラー時は参照しない） |
| sys.availability_group_listeners | group_idからdns_name取得 | @AGName指定時（エラー時は参照しない） |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | エラー発生時は処理中断 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 必須パラメータ未設定 | 両パラメータがNULL | いずれかのパラメータを指定 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限なし | プロシージャ実行毎に即時発行 |

### 配信時間帯

制限なし（プロシージャ実行時に即時発行）

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

- エラーメッセージには機密情報を含まない
- パラメータ値自体はメッセージに出力されない

## 備考

- @WriteBackupsToListenerNameと@AGNameの両方のデフォルト値はNULL
- @AGNameが指定された場合、sys.availability_groups と sys.availability_group_listeners を結合してdns_nameを取得する
- このチェックはmsdb書き込みチェックの後に実行される

---

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

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

### 推奨読解順序

#### Step 1: パラメータ定義を確認

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | @WriteBackupsToListenerNameと@AGNameの定義 |

**主要処理フロー**:
1. **行8**: `@AGName NVARCHAR(256) = NULL` - AGNameパラメータ定義
2. **行14**: `@WriteBackupsToListenerName NVARCHAR(256) = NULL` - リスナー名パラメータ定義

#### Step 2: 検証ロジックを理解

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | ネストされたIF文による条件チェック |

**主要処理フロー**:
- **行1169-1185**: @WriteBackupsToListenerName IS NULL の場合の処理ブロック
- **行1171-1175**: @AGName IS NULL チェックとRAISERROR
- **行1176-1183**: @AGName指定時のリスナー名自動取得

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

```
sp_BlitzBackups (PushBackupHistoryToListenerモード)
    |
    +-- @WriteBackupsToDatabaseName検証
    |
    +-- msdb書き込み禁止チェック
    |
    +-- @WriteBackupsToListenerName IS NULL チェック
            |
            +-- NOT NULL → リンクサーバー検証へ
            |
            +-- NULL → @AGName IS NULL チェック
                    |
                    +-- NULL → RAISERROR + RETURN（本エラー）
                    |
                    +-- NOT NULL → sys.availability_group_listeners から
                                   dns_name を取得して
                                   @WriteBackupsToListenerName に設定
```

### データフロー図

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

@WriteBackupsToListenerName ───> NULL判定
         |                           |
         |                    @AGName ───> NULL判定 ───> RAISERROR (両方NULL時)
         |                           |
         +───────────────────────────+───> AG名からリスナー解決 (@AGName指定時)
                                     |
                                     +───> 次の検証へ (リスナー名指定時)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | ソース | バックアップ分析プロシージャ |
