# バッチ設計書 13-webhook_event_log.cleanup

## 概要

本ドキュメントは、Shopwareプラットフォームにおけるウェブフックイベントログクリーンアップバッチの設計仕様を定義します。ウェブフック配信時に記録されるイベントログを定期的に削除し、データベースの肥大化を防止します。

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

**業務上の目的・背景**：Shopwareのウェブフック機能は、システムイベント発生時に外部システムへ通知を送信します。各ウェブフック呼び出しの履歴（配信ステータス、リクエスト/レスポンス情報等）はwebhook_event_logテーブルに記録されます。このログは障害調査やデバッグには有用ですが、長期間保持すると大量のデータが蓄積されてしまいます。本バッチは古いログエントリを自動削除することで、データベースの健全性を維持します。

**バッチの実行タイミング**：日次（86400秒間隔）でスケジュール実行されます。

**主要な処理内容**：
1. システム設定からログ保持期間（`core.webhook.entryLifetimeSeconds`）を取得
2. 保持期間が-1の場合は処理をスキップ（無期限保持）
3. 成功（SUCCESS）および失敗（FAILED）ステータスのログを保持期間経過後に削除
4. キュー待ち（QUEUED）ステータスのログは保持期間の2倍経過後に削除（スタックしたメッセージ対応）
5. バッチサイズ（500件）単位で削除を繰り返し実行

**前後の処理との関連**：前提となるバッチは特にありません。ウェブフック機能を使用するアプリケーションや連携システムがウェブフックを登録・利用している場合に、本バッチでログがクリーンアップされます。log_entry.cleanupなど他のログクリーンアップタスクと同様の目的を持ちます。

**影響範囲**：webhook_event_logテーブルに対してDELETE操作を実行します。削除されたログは復元できないため、長期保存が必要な場合は外部システムへのエクスポートを検討してください。

## バッチ種別

データクレンジング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | スケジュールタスクランナーに依存 |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron（スケジュールタスク） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| core.webhook.entryLifetimeSeconds | -1以外の値が設定されている場合に削除処理を実行 |

### 実行可否判定

タスクは常に実行されますが、entryLifetimeSecondsが-1に設定されている場合は即座にリターンし、削除処理は実行しません。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 入力パラメータは不要 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| system_config | DB | ログ保持期間設定（entryLifetimeSeconds） |
| webhook_event_log | DB | 削除対象のウェブフックイベントログ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| webhook_event_log | DB | 削除操作（DELETE） |

### 出力ファイル仕様

ファイル出力はありません。

## 処理フロー

### 処理シーケンス

```
1. 設定値取得
   └─ systemConfigServiceからentryLifetimeSecondsを取得
2. 有効性チェック
   └─ entryLifetimeSeconds == -1 の場合は終了
3. 成功/失敗ログ削除
   └─ STATUS_SUCCESS, STATUS_FAILED のログを保持期間経過後に削除
   └─ BATCH_SIZE（500件）単位でループ削除
4. キュー待ちログ削除
   └─ STATUS_QUEUED のログを保持期間×2経過後に削除
   └─ BATCH_SIZE（500件）単位でループ削除
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[設定値取得]
    B --> C{entryLifetimeSeconds == -1?}
    C -->|Yes| Z[バッチ終了]
    C -->|No| D[削除日時計算]
    D --> E[SUCCESS/FAILEDログ削除ループ]
    E --> F{削除件数 == BATCH_SIZE?}
    F -->|Yes| E
    F -->|No| G[QUEUED削除日時計算]
    G --> H[QUEUEDログ削除ループ]
    H --> I{削除件数 == BATCH_SIZE?}
    I -->|Yes| H
    I -->|No| Z
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 設定取得 | system_config | SELECT | ログ保持期間設定の取得 |
| ログ削除 | webhook_event_log | DELETE | 古いイベントログを削除 |

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

#### webhook_event_log

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | 全カラム | created_at < :before AND delivery_status IN (:status) LIMIT 500 | バッチ削除 |

#### 削除SQL

```sql
DELETE FROM `webhook_event_log`
WHERE `created_at` < :before
  AND `delivery_status` IN (:status)
LIMIT :limit
```

- 成功/失敗ログ: `:before` = 現在時刻 - entryLifetimeSeconds
- キュー待ちログ: `:before` = 現在時刻 - (entryLifetimeSeconds * 2)

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| DB接続エラー | システムエラー | データベース接続失敗 | 接続設定を確認、再試行 |
| SQLエラー | システムエラー | DELETE文実行失敗 | ログを確認、手動対応 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 失敗時再スケジュール有効 |
| リトライ間隔 | 次回スケジュール実行時 |
| リトライ対象エラー | 全般的なエラー |

### 障害時対応

1. エラーログを確認し原因を特定
2. データベース接続を確認
3. 手動でDELETEクエリを実行（必要に応じて）

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各DELETE文単位（BATCH_SIZE件ごと） |
| コミットタイミング | 各DELETE文実行完了時 |
| ロールバック条件 | DELETE文失敗時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数千〜数十万件（運用状況による） |
| 目標処理時間 | 数分以内 |
| メモリ使用量上限 | 通常のPHP制限に準拠 |
| バッチサイズ | 500件 |

## 排他制御

特別な排他制御は実装されていません。DELETE操作はデータベースレベルで行ロックを取得します。LIMIT句によりバッチサイズを制限し、長時間のロックを回避しています。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | タスク開始時 | タスク開始通知 |
| 終了ログ | タスク終了時 | 処理完了通知 |
| エラーログ | エラー発生時 | エラー詳細、スタックトレース |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 600秒 | システム管理者 |
| エラー件数 | 1件以上 | システム管理者 |

## 備考

- 内部使用タスク（@internal）として定義されています
- QUEUEDステータスのログは保持期間の2倍経過後に削除されます（メッセージリトライ機構との整合性のため）
- BATCH_SIZE（500件）単位で削除を繰り返すことで、大量削除時のデータベースロック時間を最小化しています
- entryLifetimeSecondsが-1の場合、ログは無期限に保持されます
- WebhookCleanupサービスクラスに実際の削除ロジックが委譲されています
