# バッチ設計書 4-delete_old_error_logs

## 概要

本ドキュメントは、InvenTreeシステムにおけるdelete_old_error_logsバッチ処理の設計仕様を定義します。このバッチは、指定期間より古いエラーログをサーバーから自動的に削除し、データベースの肥大化を防止するメンテナンス機能を提供します。

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

**業務上の目的・背景**：InvenTreeでは、アプリケーション実行中に発生したエラーが`error_report`モジュールのErrorテーブルに記録されます。これらのエラーログは、障害発生時の原因調査やシステムの安定性評価に重要ですが、長期間保持するとデータベースサイズが肥大化し、ストレージコストの増加やクエリパフォーマンスの低下を引き起こす可能性があります。本バッチは、設定可能な保持期間（デフォルト30日）を超えたエラーログを自動的に削除することで、必要な期間のエラー履歴を保持しつつシステムの健全性を維持します。

**バッチの実行タイミング**：日次で自動実行されます。Django-Qスケジューラにより、毎日1回実行されます。

**主要な処理内容**：
1. グローバル設定`INVENTREE_DELETE_ERRORS_DAYS`から保持日数を取得（デフォルト30日）
2. 保持期間を超えたエラーレコードをErrorテーブルから検索
3. 該当レコードが存在する場合、削除件数をログ出力後に一括削除

**前後の処理との関連**：このバッチは`delete_successful_tasks`、`delete_failed_tasks`とともにシステムのログメンテナンス群を構成します。エラーログは独自の設定`INVENTREE_DELETE_ERRORS_DAYS`で保持期間を管理しており、タスクログとは独立して設定可能です。

**影響範囲**：error_report.Errorテーブルのみに影響します。エラー履歴が削除されるため、古いエラーの調査には影響が出る可能性があります。

## バッチ種別

データクレンジング / システムメンテナンス

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | Django-Qスケジューラ依存 |
| 実行曜日 | 毎日 |
| 実行日 | 毎日 |
| トリガー | Django-Qスケジューラ（DAILY） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Django-Qワーカー起動 | バックグラウンドワーカープロセスが稼働していること |
| データベース接続 | データベースへの接続が確立されていること |
| Appレジストリ準備完了 | Djangoアプリケーションレジストリが初期化されていること |

### 実行可否判定

- Django-Qワーカープロセスが起動している場合、スケジュールに従って自動実行
- `AppRegistryNotReady`例外が発生した場合は処理をスキップしログ出力

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| error_report.Error | DB | エラーログテーブル |
| InvenTreeGlobalSetting | DB | グローバル設定（INVENTREE_DELETE_ERRORS_DAYS） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| error_report.Error | DB | 古いレコードが削除される |
| ログ | テキスト | 削除件数をstructlogで出力 |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. error_reportモデルのインポート
   └─ Errorモデルをインポート（失敗時は処理終了）
2. 設定値の取得
   └─ INVENTREE_DELETE_ERRORS_DAYS設定を取得（デフォルト30日）
3. 削除閾値の計算
   └─ 現在時刻から保持日数を減算して閾値日時を算出
4. 対象レコードの検索
   └─ when <= 閾値日時のErrorレコードを検索
5. レコードの削除
   └─ 対象件数が0より大きい場合、ログ出力後に削除実行
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{Appレジストリ準備完了?}
    B -->|No| C[ログ出力して終了]
    B -->|Yes| D[保持日数設定を取得]
    D --> E[削除閾値日時を計算]
    E --> F[古いErrorレコードを検索]
    F --> G{対象件数 > 0?}
    G -->|Yes| H[削除件数をログ出力]
    H --> I[レコードを一括削除]
    G -->|No| J[バッチ終了]
    I --> J
    C --> K[処理終了]
    J --> K
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 設定取得 | InvenTreeGlobalSetting | SELECT | 保持日数設定を取得 |
| レコード検索 | error_report.Error | SELECT | 削除対象レコードを検索 |
| レコード削除 | error_report.Error | DELETE | 古いエラーレコードを削除 |

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

#### error_report.Error

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | when | when <= (現在時刻 - 保持日数) | 削除対象レコードの特定 |
| DELETE | - | when <= (現在時刻 - 保持日数) | 古いレコードの一括削除 |

#### InvenTreeGlobalSetting

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | value | key='INVENTREE_DELETE_ERRORS_DAYS' | デフォルト30日 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | AppRegistryNotReady | Djangoアプリ初期化前に実行 | ログ出力後、処理をスキップ |

### リトライ仕様

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

### 障害時対応

- AppRegistryNotReady発生時：次回スケジュール実行で自動復旧
- データベース接続エラー：データベースの復旧後、次回スケジュール実行で自動復旧

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | DELETE操作全体 |
| コミットタイミング | DELETE完了時に自動コミット |
| ロールバック条件 | 例外発生時（ただし明示的なロールバック処理なし） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十〜数百件（エラー発生頻度依存） |
| 目標処理時間 | 10秒以内 |
| メモリ使用量上限 | 50MB以下 |

## 排他制御

- 同時実行：Django-Qスケジューラにより1日1回のみ実行
- ロック仕様：特別なロック機構は不要

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | 削除実行時 | 'Deleting %s old error logs' |
| 情報ログ | Appレジストリ未準備時 | "Could not perform 'delete_old_error_logs' - App registry not ready" |
| トレースログ | 処理開始時 | OpenTelemetryスパン 'delete_old_error_logs' |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 削除件数 | 異常に多い場合（要定義） | システム管理者 |
| 処理時間 | 60秒以上 | システム管理者 |

## 備考

- 設定`INVENTREE_DELETE_ERRORS_DAYS`はInvenTree管理画面から変更可能
- タスクログとは別の設定項目を使用しているため、独立して保持期間を設定可能
- エラーログにはスタックトレースなどの詳細情報が含まれる場合があり、セキュリティ観点からも定期的な削除が推奨される
- `@tracer.start_as_current_span('delete_old_error_logs')`デコレータにより、OpenTelemetryによる分散トレーシングに対応
- 実装ファイル: `src/backend/InvenTree/InvenTree/tasks.py`
