# バッチ設計書 1-heartbeat

## 概要

本ドキュメントは、InvenTreeシステムにおけるheartbeatバッチ処理の設計仕様を定義します。このバッチは、バックグラウンドワーカー（Django-Q）の稼働状態を定期的に確認するための死活監視機能を提供します。

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

**業務上の目的・背景**：InvenTreeは在庫管理システムとして、バックグラウンドで様々な非同期タスク（在庫更新、通知送信、レポート生成など）を処理しています。これらのタスクを処理するDjango-Qワーカーが正常に稼働しているかを確認することは、システムの信頼性を維持するために不可欠です。heartbeatバッチは、ワーカープロセスが「生きている」ことを証明するシンプルなタスクとして機能し、管理者がワーカーの稼働状況を監視できるようにします。

**バッチの実行タイミング**：5分間隔で自動実行されます。Django-Qのスケジューラによって管理され、ワーカープロセスが起動している間は継続的に実行されます。

**主要な処理内容**：
1. 30分以上経過した古いheartbeat成功レコードをSuccessテーブルから削除
2. キューに残っている重複したheartbeatタスクを削除
3. 処理完了後、新しい成功レコードがSuccessテーブルに自動的に記録される

**前後の処理との関連**：このバッチは他のバッチとの依存関係はありません。独立した死活監視機能として動作し、他のすべてのスケジュールタスクが正常に実行されるための前提条件となるワーカー稼働状態を確認します。

**影響範囲**：Django-Q Successテーブルおよびタスクキュー（OrmQ）に影響します。システム全体のパフォーマンスへの影響は最小限です。

## バッチ種別

死活監視 / システムメンテナンス

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 5分間隔 |
| 実行時刻 | 常時（5分ごと） |
| 実行曜日 | 毎日 |
| 実行日 | 毎日 |
| トリガー | Django-Qスケジューラ（cron相当） |

## 実行条件

### 前提条件

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

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| django_q.Success | DB | 成功したタスクのログテーブル |
| django_q.OrmQ | DB | タスクキューテーブル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| django_q.Success | DB | 処理成功時に自動的にレコードが追加される |
| ログ | テキスト | 処理状況をstructlogで出力 |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. Django-Qモデルのインポート
   └─ Success, OrmQモデルをインポート（失敗時は処理終了）
2. 古いheartbeatレコードの削除
   └─ 30分以上前のheartbeat成功レコードを検索・削除
3. 重複タスクの削除
   └─ OrmQキュー内のheartbeatタスクを検索・削除
4. 処理完了
   └─ Django-Qが自動的に新しいSuccessレコードを作成
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{Appレジストリ準備完了?}
    B -->|No| C[ログ出力して終了]
    B -->|Yes| D[現在時刻から30分前を計算]
    D --> E[古いheartbeatレコードを検索]
    E --> F[古いheartbeatレコードを削除]
    F --> G[OrmQキューを走査]
    G --> H{heartbeatタスクあり?}
    H -->|Yes| I[重複タスクを削除]
    H -->|No| J[バッチ終了]
    I --> J
    C --> K[処理終了]
    J --> K
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 古いレコード削除 | django_q.Success | DELETE | 30分以上経過したheartbeat成功レコードを削除 |
| 重複タスク削除 | django_q.OrmQ | DELETE | キュー内の重複heartbeatタスクを削除 |

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

#### django_q.Success

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | func='InvenTree.tasks.heartbeat' AND started <= (現在時刻 - 30分) | 古いheartbeatレコードのクリーンアップ |

#### django_q.OrmQ

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | func() == 'InvenTree.tasks.heartbeat' | 重複タスクの削除 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

- AppRegistryNotReady発生時：Djangoアプリケーションの起動完了を待って自動的に次回実行される
- データベース接続エラー：データベースの復旧後、次回スケジュール実行で自動復旧

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 最大6件（30分間のheartbeat数） |
| 目標処理時間 | 1秒以内 |
| メモリ使用量上限 | 10MB以下 |

## 排他制御

- 同時実行：複数ワーカーが存在する場合でも、Django-Qのスケジューラにより1つのみ実行される
- ロック仕様：特別なロック機構は不要（処理が軽量かつ冪等性あり）

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | Appレジストリ未準備時 | 'Could not perform heartbeat task - App registry not ready' |
| トレースログ | 処理開始時 | OpenTelemetryスパン 'heartbeat' |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| heartbeat未実行 | 10分以上 | システム管理者（要設定） |
| ワーカー停止 | Successテーブルに新規レコードなし | システム管理者（要設定） |

## 備考

- このバッチはワーカーの死活監視が主目的であり、Successテーブルに定期的にレコードが追加されることで、外部からワーカーの稼働状態を確認可能
- `@tracer.start_as_current_span('heartbeat')`デコレータにより、OpenTelemetryによる分散トレーシングに対応
- 実装ファイル: `src/backend/InvenTree/InvenTree/tasks.py`
