# バッチ設計書 20-409.status-gconcat

## 概要

本ドキュメントは、FreeBSDのperiodicフレームワークにおけるdailyバッチ `409.status-gconcat` の設計仕様を記述する。本バッチは `gconcat(8)` デバイスの状態を確認し、異常があれば報告する。

### 本バッチの処理概要

本バッチは、FreeBSDのGEOMベース連結（concatenation）フレームワークである `gconcat(8)` のデバイス状態を日次で確認し、UPでないコンポーネントが存在する場合にアラートを発生させる。

**業務上の目的・背景**：gconcat(8)はFreeBSDのソフトウェアディスク連結実装であり、複数のディスクを1つの論理ボリュームに結合する。ストライピングと同様に冗長性がないため、コンポーネントの障害はデータ損失に直結する。本バッチにより管理者は日次でconcatデバイスの状態を自動監視し、異常を早期に検知できる。

**バッチの実行タイミング**：日次（daily periodic）で実行される。デフォルトでは無効（daily_status_gconcat_enable=NO）。

**主要な処理内容**：
1. `gconcat status` コマンドを実行してデバイス状態を表示
2. `gconcat status -s` の出力からUP以外のコンポーネントをフィルタリング
3. 非UPコンポーネントが存在する場合にrc=3（エラー）を返す

**前後の処理との関連**：dailyカテゴリのステータス確認系バッチ群（400番台）に属する。No.19（408.status-gstripe）の後続に位置し、同様のGEOMステータス確認パターンを踏襲する。正常状態判定文字列もgstripeと同じくUPである。

**影響範囲**：読み取り専用の処理であり、システムに変更を加えない。

## バッチ種別

レポート生成 / ステータス確認

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | periodicフレームワークの日次実行時刻（デフォルト: 3:01） |
| 実行曜日 | 毎日 |
| 実行日 | 毎日 |
| トリガー | cron経由のperiodicフレームワーク |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| daily_status_gconcat_enable | "YES"に設定されていること（デフォルト: NO） |
| gconcat(8)コマンド | システムにgconcatコマンドが利用可能であること |

### 実行可否判定

`daily_status_gconcat_enable` が "YES" でない場合、rc=0でスキップする。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| daily_status_gconcat_enable | 文字列 | Yes | NO | バッチの有効/無効フラグ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| gconcat status出力 | テキスト | gconcatデバイスの状態情報 |
| gconcat status -s出力 | テキスト | gconcatデバイスのステータス簡易表示 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | "Checking status of gconcat(8) devices:" ヘッダ、gconcat status出力 |

### 出力ファイル仕様

本バッチはファイル出力を行わない。

| 項目 | 内容 |
|-----|------|
| ファイル名 | N/A |
| 出力先 | 標準出力のみ |
| 文字コード | N/A |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. periodic.confの読み込み
   └─ /etc/defaults/periodic.confとローカル設定を読み込む
2. daily_status_gconcat_enable判定
   └─ YESでない場合、rc=0で終了
3. "Checking status of gconcat(8) devices:" ヘッダ出力
4. gconcat status実行
   └─ 失敗時: rc=2
5. gconcat status -s実行・UP以外のフィルタリング
   └─ 非UPコンポーネントが存在: rc=3
   └─ 全てUP: rc=0
6. 終了コード(rc)を返却して終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[periodic.conf読み込み]
    B --> C{daily_status_gconcat_enable=YES?}
    C -->|No| D[スキップ rc=0]
    C -->|Yes| E["Checking status of gconcat(8) devices:" 出力]
    E --> F[gconcat status実行]
    F --> G{gconcat status成功?}
    G -->|No| H[rc=2]
    G -->|Yes| I[gconcat status -s実行・UP以外フィルタ]
    I --> J{非UPコンポーネントあり?}
    J -->|Yes| K[rc=3]
    J -->|No| L[rc=0]
    D --> M[exit rc]
    H --> M
    K --> M
    L --> M
```

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

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

本バッチはデータベース操作を行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| rc=2 | コマンド実行エラー | gconcat statusの実行が失敗 | gconcatコマンドの存在確認、GEOMモジュールの読み込み確認 |
| rc=3 | 連結異常検出 | UPでないコンポーネントが存在 | 連結デバイスの状態を確認し、障害ディスクの対処を実施。連結には冗長性がないため、データ損失の可能性がある |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（リトライ機構なし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

rc=3の場合、gconcatデバイスにコンポーネント障害が発生している。ディスク連結には冗長性がないため、データ損失が発生している可能性がある。バックアップからの復旧を検討する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（読み取り専用） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | gconcatデバイス数に依存 |
| 目標処理時間 | 通常数秒以内 |
| メモリ使用量上限 | シェルスクリプトのため最小限 |

## 排他制御

特別な排他制御は実装されていない。読み取り専用の処理であるため、同時実行による問題はない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | "Checking status of gconcat(8) devices:" |
| ステータスログ | gconcat status実行後 | gconcatデバイスの状態一覧 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | rc=3（連結異常） | periodicフレームワーク経由のメール通知 |
| 終了コード | rc=2（コマンドエラー） | periodicフレームワーク経由のメール通知 |

## 備考

- デフォルト無効（daily_status_gconcat_enable=NO）であり、gconcat使用環境でのみ有効化する
- 正常状態の判定文字列はUP（gstripeと同じ）
- fgrep -v UPにより、UP以外の行を検出する
- ディスク連結（JBOD/spanning）は冗長性がないため、異常検出時の対応優先度は高い
- 構造はNo.19（408.status-gstripe）と同一パターン
- ソースファイル: `usr.sbin/periodic/etc/daily/409.status-gconcat`
