# バッチ設計書 23-toolkit benchmark-log

## 概要

本ドキュメントは、Nushellプロジェクトにおけるtoolkit benchmark-logコマンドの設計仕様を定義したものである。このバッチは現在のブランチまたは指定されたブランチのベンチマーク結果を記録し、将来の比較分析に利用できるようにする。

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

toolkit benchmark-logは、単一のGitブランチに対してベンチマークを実行し、その結果をtango/samplesディレクトリに記録するツールである。cargo-exportを使用してベンチマーク用バイナリを生成し、結果を永続化する。

**業務上の目的・背景**：継続的なパフォーマンス監視のために、各ブランチやリリースバージョンのベンチマーク結果を記録しておく必要がある。この記録されたデータは、将来のbenchmark-compareでの比較基準として使用される。定期的なベンチマーク記録により、パフォーマンスの推移を長期的に追跡でき、パフォーマンス低下の原因特定が容易になる。

**バッチの実行タイミング**：開発中の任意のタイミングで手動実行される。特にリリースバージョンのベンチマーク基準を記録する際や、パフォーマンス改善作業の成果を記録する際に使用される。CI/CDでの定期実行も想定される。

**主要な処理内容**：
1. ターゲットブランチ（デフォルト: 現在のブランチ）を特定
2. 必要に応じてターゲットブランチにチェックアウト
3. cargo exportでベンチマーク用バイナリを生成し実行
4. 必要に応じて元のブランチに復帰
5. ベンチマーク結果をtango/samplesに保存

**前後の処理との関連**：toolkit benchmark-compareと相互に関連する。benchmark-logで記録されたデータは、benchmark-compareの比較基準として使用される。

**影響範囲**：tangoディレクトリにベンチマーク結果が保存される。異なるブランチを指定した場合、Gitの作業ツリーが一時的に変更される。

## バッチ種別

パフォーマンス検証 / ベンチマーク記録

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 / CI/CD |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Rust環境 | cargoがインストールされていること |
| cargo-export | cargo-exportがインストールされていること |
| Git環境 | Gitがインストールされ、リポジトリ内で実行されること |
| Nushell環境 | Nushellがインストールされ、toolkitモジュールが利用可能であること |
| クリーンな作業ツリー | 異なるブランチを指定する場合、未コミットの変更がないこと |

### 実行可否判定

cargo-exportが利用可能で、Gitリポジトリ内で実行可能。異なるブランチを指定する場合はクリーンな作業ツリーが必要。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| target | string | No | 現在のブランチ | ベンチマーク対象のブランチ名 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Gitリポジトリ | Git | ブランチ情報とソースコード |
| Cargo.toml | TOML | プロジェクトのビルド設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 処理進捗 |
| tango/bin/{ブランチ名}/ | バイナリ | ベンチマーク用実行可能ファイル |
| tango/samples/ | データ | ベンチマーク結果のサンプルデータ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | benchmarks（実行可能ファイル） |
| 出力先 | tango/bin/{ブランチ名}/ |
| 形式 | ネイティブバイナリ |

## 処理フロー

### 処理シーケンス

```
1. パラメータの解決
   └─ 現在のブランチ名を取得
   └─ targetのデフォルト値を現在のブランチに設定
2. 出力ディレクトリの設定
   └─ tango/bin/{target}を設定
3. ブランチ切り替え（必要な場合のみ）
   └─ target != currentの場合のみgit checkout {target}を実行
4. ベンチマーク実行
   └─ cargo export {bin_dir} -- bench
5. 元のブランチに復帰（必要な場合のみ）
   └─ target != currentの場合のみgit checkout {current}を実行
6. 結果のレポート出力
   └─ {bench_bin} compare -o -s 50 --dump {samples_dir}
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[パラメータ解決]
    B --> C[現在ブランチ取得]
    C --> D[出力ディレクトリ設定]
    D --> E{target != current?}
    E -->|Yes| F[ターゲットブランチにチェックアウト]
    E -->|No| G[cargo exportでベンチマーク実行]
    F --> G
    G --> H{target != current?}
    H -->|Yes| I[元のブランチに復帰]
    H -->|No| J[ベンチマーク結果を出力]
    I --> J
    J --> K[バッチ終了]
```

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

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

データベース操作なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ブランチ切替失敗 | 未コミットの変更がある | 変更をコミットまたはスタッシュ |
| - | cargo-export未インストール | cargo-exportが見つからない | cargo install cargo-exportを実行 |
| - | ビルドエラー | ソースコードにエラーがある | ビルドエラーを修正 |
| - | ブランチ不存在 | 指定されたブランチが存在しない | 正しいブランチ名を指定 |

### リトライ仕様

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

### 障害時対応

異なるブランチを指定して実行中にエラーが発生した場合、Gitの作業ツリーが別のブランチに残っている可能性がある。`git checkout {元のブランチ}`で手動復帰する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1ブランチ |
| 目標処理時間 | 数十分〜数時間（プロジェクトサイズに依存） |
| メモリ使用量上限 | ベンチマーク実行に依存 |

## 排他制御

同一リポジトリでの同時実行は不可（異なるブランチを指定する場合）。現在のブランチで実行する場合は、ビルドロックのみが適用される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | "-- Benchmarking {target}" |
| 終了ログ | 処理完了時 | "-- Done" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | 手動確認 |

## 備考

- cargo-exportのインストール: `cargo install cargo-export`
- benchmark-compareと異なり、現在のブランチで実行する場合はブランチ切り替えが発生しない（条件分岐あり）
- ベンチマーク比較オプション: `-o`（出力）、`-s 50`（サンプルサイズ50）、`--dump`（サンプルデータ保存）
- 結果はtango/ディレクトリに蓄積され、過去の記録との比較に利用される
