# バッチ設計書 8-log:clear

## 概要

本ドキュメントは、Railsアプリケーションのログファイルをクリアする（0バイトに切り詰める）Rakeタスク「log:clear」のバッチ設計書です。

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

log:clearタスクは、Railsアプリケーションの`log/`ディレクトリ内にある指定されたログファイルを0バイトに切り詰める（truncate）バッチ処理です。

**業務上の目的・背景**：Railsアプリケーションは、開発・本番環境での動作ログをlog/ディレクトリに出力します。これらのログファイルは時間とともに肥大化し、ディスク容量を圧迫する原因となります。特に開発環境では、デバッグ時に大量のログが出力されることがあります。本タスクは、ログファイルを削除するのではなく0バイトに切り詰めることで、ログファイルの存在を維持しながらディスク容量を解放します。これにより、ログローテーションの設定がない環境でもディスク容量を管理できます。

**バッチの実行タイミング**：開発環境でのログファイル肥大化時、定期的なメンテナンス時、またはディスク容量警告発生時に実行されます。本番環境では通常ログローテーションが設定されているため、このタスクの使用頻度は低いです。

**主要な処理内容**：
1. 対象ログファイルの決定（環境変数LOGSまたはデフォルト設定に基づく）
2. 各ログファイルを0バイトに切り詰め

**前後の処理との関連**：本タスクは単独で実行されることが多いですが、メンテナンススクリプトの一部として他のクリーンアップタスクと組み合わせて使用されることもあります。

**影響範囲**：指定されたログファイルの内容が完全に消去されます。ログファイル自体は維持されるため、アプリケーションは継続してログを出力できます。

## バッチ種別

データクレンジング / ログクリア

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（メンテナンス時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Railsアプリケーション環境 | Railsプロジェクトのルートディレクトリで実行する必要がある |
| ファイルシステム権限 | log/ディレクトリ内のファイルへの書き込み権限が必要 |

### 実行可否判定

特別な判定ロジックはなく、タスクは常に実行可能です。対象ファイルが存在しない場合はスキップされます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| LOGS | 環境変数（String） | No | 全環境のログ | 対象ログを指定（例: test,development または all） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| log/*.log | ファイル | ログファイル格納ディレクトリ |
| config/environments/*.rb | ファイル | 環境名の取得元 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| log/*.log | ファイル | 0バイトに切り詰められたログファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 変更なし（既存ファイルを切り詰め） |
| 出力先 | log/ |
| ファイルサイズ | 0バイト |

## 処理フロー

### 処理シーケンス

```
1. 対象ログファイルの決定
   ├─ LOGS=all の場合: log/*.log の全ファイル
   ├─ LOGS指定あり の場合: 指定された環境のログファイル
   └─ LOGS未指定 の場合: config/environments/*.rb から環境名を取得
2. 各ログファイルを処理
   └─ ファイルを書き込みモードで開き、即座に閉じる（0バイトに切り詰め）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{LOGS環境変数}
    B -->|all| C[log/*.logを対象]
    B -->|指定あり| D[指定環境のログを対象]
    B -->|未指定| E[全環境のログを対象]
    C --> F[対象ファイルループ]
    D --> F
    E --> F
    F --> G{ファイル存在?}
    G -->|Yes| H[ファイルを0バイトに切り詰め]
    G -->|No| I[スキップ]
    H --> J{次のファイル?}
    I --> J
    J -->|Yes| F
    J -->|No| K[バッチ終了]
```

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

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

本タスクはデータベース操作を行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイルシステムエラー | 書き込み権限がない場合 | 実行ユーザーの権限を確認する |
| - | ファイルシステムエラー | ファイルが使用中の場合 | 対象ファイルを使用しているプロセスを確認する |

### リトライ仕様

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

### 障害時対応

ファイル操作に失敗した場合は、手動で対象ファイルの状態を確認し、使用中のプロセスがあれば適切に対応してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイルシステム操作のみ） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数件のログファイル |
| 目標処理時間 | 1秒以内 |
| メモリ使用量上限 | 最小限 |

## 排他制御

同時実行の制御は行われていません。アプリケーションがログを書き込んでいる最中に実行しても、ファイルは正常に切り詰められます。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 処理ログ | なし | 標準出力なし |
| エラーログ | エラー発生時 | ファイルシステムエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

本タスクは標準的な監視・アラート設定はありません。

## 備考

- 本タスクはログファイルを削除するのではなく、0バイトに切り詰めます。これにより、ファイルハンドルを保持しているプロセスに影響を与えにくくなっています。
- LOGS環境変数の値：
  - 未指定: config/environments/ディレクトリ内の全環境（development, test, production等）のログを対象
  - all: log/*.logの全ファイルを対象
  - カンマ区切りの環境名（例: test,development）: 指定環境のログのみを対象
- 存在しないログファイルは自動的にスキップされます（selectでFile.exist?をチェック）。
- 本番環境では通常、logrotateなどのシステムレベルのログローテーションが設定されているため、このタスクの使用は限定的です。
