# バッチ設計書 5-tmp:pids:clear

## 概要

本ドキュメントは、RailsアプリケーションのPIDファイルを削除するRakeタスク「tmp:pids:clear」のバッチ設計書です。

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

tmp:pids:clearタスクは、Railsアプリケーションの`tmp/pids/`ディレクトリ内に作成されたPID（プロセスID）ファイルを削除するバッチ処理です。

**業務上の目的・背景**：Railsアプリケーションやその関連プロセス（Pumaなどのアプリケーションサーバー、Sidekiqなどのバックグラウンドワーカー）は、自身のプロセスIDを記録したPIDファイルをtmp/pids/ディレクトリに作成します。これらのファイルはプロセスの管理や監視に使用されますが、アプリケーションが異常終了した場合にPIDファイルが残存すると、次回起動時に「既に起動中」と誤判定されるなどの問題が発生することがあります。本タスクは、これらの残存PIDファイルを削除し、クリーンな状態でのアプリケーション起動を支援します。

**バッチの実行タイミング**：サーバーのメンテナンス時、アプリケーションの異常終了後のリカバリ時、またはデプロイ前のクリーンアップ時に実行されます。通常はアプリケーションが完全に停止していることを確認してから実行します。

**主要な処理内容**：
1. tmp/pids/ディレクトリ内のファイルを検索
2. ドットファイル（隠しファイル）を除く全てのファイルを削除

**前後の処理との関連**：本タスクは単独で実行されることが多いですが、メンテナンス作業の一部として他のtmp:*タスクと組み合わせて使用されることもあります。注意点として、tmp:clearタスクの依存タスクには含まれていません。

**影響範囲**：tmp/pids/ディレクトリ内の全てのPIDファイルが削除されます。実行中のプロセスがある場合、そのプロセスの管理ツールが正常に動作しなくなる可能性があります。

## バッチ種別

データクレンジング / ファイル削除

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Railsアプリケーション環境 | Railsプロジェクトのルートディレクトリで実行する必要がある |
| ファイルシステム権限 | tmp/pids/ディレクトリへの書き込み・削除権限が必要 |
| プロセス停止確認 | 対象PIDを使用するプロセスが停止していることを確認することを推奨 |

### 実行可否判定

特別な判定ロジックはなく、タスクは常に実行可能です。対象ディレクトリやファイルが存在しない場合もエラーにはなりません。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本タスクは入力パラメータを受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| tmp/pids/ | ディレクトリ | PIDファイル格納ディレクトリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| なし | - | 本タスクは出力を生成しません（削除のみ） |

### 出力ファイル仕様

本タスクはファイル出力を行いません。

## 処理フロー

### 処理シーケンス

```
1. tmp/pids/ディレクトリ内のファイル一覧取得
   └─ Dir["tmp/pids/[^.]*"]パターンでマッチ（ドットファイル除外）
2. マッチしたファイルを削除
   └─ rm関数を使用（verbose: false）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[tmp/pids/内ファイル一覧取得]
    B --> C{ファイル存在?}
    C -->|Yes| D[rmでファイル削除]
    C -->|No| E[スキップ]
    D --> F[バッチ終了]
    E --> F
```

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

ファイル削除に失敗した場合は、手動で対象ファイルの状態を確認し、使用中のプロセスがあれば停止した後に再実行してください。

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

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

## パフォーマンス要件

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

## 排他制御

同時実行の制御は行われていません。PIDファイルを参照しているプロセス管理ツールが存在する場合、それらの動作に影響を与える可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 処理ログ | なし | verbose: falseのため出力されない |
| エラーログ | エラー発生時 | ファイルシステムエラーメッセージ |

## 監視・アラート

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

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

## 備考

- 本タスクはrm（非再帰的削除）を使用しており、ファイルのみが削除されます。
- 削除対象はドットファイル（隠しファイル）を除くすべてのファイルです（`[^.]*`パターン）。
- **重要**：本タスクはtmp:clearの依存タスクには含まれていないため、tmp:clearを実行しても自動的には実行されません。必要に応じて個別に実行してください。
- PIDファイルはプロセス管理に重要なため、削除前にアプリケーションが完全に停止していることを確認することを強く推奨します。
