<p><!-- [META] Topic: Robust Shell Scripting with set -euo pipefail and trap Target: SRE / DevOps Engineers Focus: Reliability, Error Handling, Resource Cleanup Language: Japanese [/META] --> 本記事は<strong>Geminiの出力をプロンプト工学で整理した業務ドラフト（未検証）</strong>です。</p> <h1 class="wp-block-heading">堅牢なシェルスクリプト設計：エラー検知と自動クリーンアップによる安全な自動化の実装</h1> <p>【導入と前提】 API経由でデータを取得・加工するバッチ処理を、想定外の停止やリソース残留を防ぎつつ堅牢に自動化する手法を解説します。</p> <ul class="wp-block-list"> <li><p><strong>実行環境</strong>: GNU/Linux (Ubuntu 22.04+, RHEL 8+ 推奨)</p></li> <li><p><strong>必須ツール</strong>: <code>bash</code> (4.4+), <code>curl</code>, <code>jq</code>, <code>systemd</code></p></li> </ul> <p>【処理フローと設計】</p> <div class="wp-block-merpress-mermaidjs diagram-source-mermaid"><pre class="mermaid"> graph TD Start["スクリプト開始"] --> Init["setオプション / trap設定"] Init --> Temp["一時ファイル生成"] Temp --> Fetch["curl: 外部APIデータ取得"] Fetch --> Validate{"jq: バリデーション"} Validate -- Success --> Process["データ加工・保存"] Validate -- Failure --> ErrorHandler["エラーログ出力"] Process --> Cleanup["trap: 一時ファイル削除"] ErrorHandler --> Cleanup Cleanup --> End["スクリプト終了"] </pre></div> <p>処理の各フェーズでエラーが発生しても、<code>trap</code> によって必ず一時リソースの解放が行われる設計です。</p> <p>【実装：堅牢な自動化スクリプト】 以下は、外部APIからJSONデータを取得し、特定のフィールドを抽出して保存する実戦的なスクリプト例です。</p> <div class="codehilite"> <pre data-enlighter-language="generic">#!/usr/bin/env bash # --- 堅牢化設定 --- # -e: エラー発生時に即座に終了 # -u: 未定義変数の参照時にエラー # -o pipefail: パイプライン途中のエラーを無視しない set -euo pipefail # --- グローバル設定 --- readonly API_URL="https://api.example.com/v1/metrics" readonly WORK_DIR="/tmp/batch_job" readonly OUT_FILE="/var/log/metrics_summary.json" TMP_FILE=$(mktemp "/tmp/api_response.XXXXXX.json") # --- クリーンアップ処理 --- # スクリプト終了時（正常・異常問わず）に実行 cleanup() { local exit_code=$? echo "Cleaning up temporary files..." rm -f "$TMP_FILE" exit "$exit_code" } # EXITシグナルを捕捉してcleanup関数を実行 trap cleanup EXIT # --- メイン処理 --- echo "Starting data fetch..." # curl のオプション解説: # -s: 進捗を表示しない (silent) # -S: エラー時はメッセージを表示 # -L: リダイレクトを追跡 # --retry: 失敗時に3回リトライ curl -sSL --retry 3 --retry-delay 2 "$API_URL" -o "$TMP_FILE" # jq によるバリデーションと加工 # -e: 結果がnullまたはfalseの場合に終了ステータス1を返す if ! jq -e '.data' "$TMP_FILE" > /dev/null; then echo "Error: Invalid JSON structure received." >&2 exit 1 fi # データの抽出と保存 jq -c '.data[] | {id: .id, val: .value}' "$TMP_FILE" >> "$OUT_FILE" echo "Process completed successfully." </pre> </div> <h4 class="wp-block-heading">systemd による定期実行の設定</h4> <p>バッチ処理を確実に実行し、ログを <code>journald</code> で管理するために <code>systemd</code> を活用します。</p> <div class="codehilite"> <pre data-enlighter-language="generic"># /etc/systemd/system/metric-collector.service [Unit] Description=Metric Collector Batch Job After=network.target [Service] Type=oneshot ExecStart=/usr/local/bin/metric-collector.sh User=batchuser Group=batchuser PrivateTmp=true # /etc/systemd/system/metric-collector.timer [Unit] Description=Run Metric Collector every hour [Timer] OnCalendar=hourly Persistent=true [Install] WantedBy=timers.target </pre> </div> <p>【検証と運用】</p> <ol class="wp-block-list"> <li><p><strong>構文チェック</strong>: <code>bash -n script.sh</code> で基本的な構文を確認。</p></li> <li><p><strong>正常系テスト</strong>: スクリプトを手動実行し、終了ステータス <code>$?</code> が <code>0</code> であること、および <code>$OUT_FILE</code> が生成されていることを確認。</p></li> <li><p><strong>異常系テスト</strong>: <code>API_URL</code> を無効なURLに変更し、<code>trap</code> が作動して一時ファイルが削除されるか確認。</p></li> <li><p><strong>ログ確認</strong>: systemd経由での実行ログを確認。</p> <div class="codehilite"> <pre data-enlighter-language="generic">journalctl -u metric-collector.service -f </pre> </div></li> </ol> <p>【トラブルシューティングと落とし穴】</p> <ul class="wp-block-list"> <li><p><strong>環境変数の欠落</strong>: <code>systemd</code> や <code>cron</code> で実行する場合、ユーザーの <code>.bashrc</code> は読み込まれません。必要なパス（<code>/usr/local/bin</code> 等）はスクリプト内で明示するか、systemdの <code>Environment</code> 項目で指定してください。</p></li> <li><p><strong>部分的な書き込み</strong>: パイプライン途中でディスクフルが発生した場合、<code>set -o pipefail</code> がないとエラーを見逃す可能性があります。必ず設定に含めてください。</p></li> <li><p><strong>sudo の扱い</strong>: スクリプト内で <code>sudo</code> を多用すると、非対話型実行時にパスワード入力で停止します。<code>NOPASSWD</code> 設定を行うか、実行ユーザーの権限を適切に設計（最小権限の原則）してください。</p></li> </ul> <p>【まとめ】 運用の冪等性と堅牢性を維持するための3つの重要ポイント：</p> <ol class="wp-block-list"> <li><p><strong>即時停止の原則</strong>: <code>set -euo pipefail</code> を冒頭に記述し、エラーを隠蔽しない。</p></li> <li><p><strong>自動クリーンアップ</strong>: <code>trap</code> を用いて、異常終了時でもゴミファイルやロックファイルを残さない。</p></li> <li><p><strong>入力の検証</strong>: <code>jq</code> や <code>grep</code> を駆使し、後続処理に不正なデータを渡さない。</p></li> </ol>

graph TD
Start["スクリプト開始"] --> Init["setオプション / trap設定"]
Init --> Temp["一時ファイル生成"]
Temp --> Fetch["curl: 外部APIデータ取得"]
Fetch --> Validate{"jq: バリデーション"}
Validate -- Success --> Process["データ加工・保存"]
Validate -- Failure --> ErrorHandler["エラーログ出力"]
Process --> Cleanup["trap: 一時ファイル削除"]
ErrorHandler --> Cleanup
Cleanup --> End["スクリプト終了"]

#!/usr/bin/env bash

# --- 堅牢化設定 ---


# -e: エラー発生時に即座に終了


# -u: 未定義変数の参照時にエラー


# -o pipefail: パイプライン途中のエラーを無視しない

set -euo pipefail

# --- グローバル設定 ---

readonly API_URL="https://api.example.com/v1/metrics"
readonly WORK_DIR="/tmp/batch_job"
readonly OUT_FILE="/var/log/metrics_summary.json"
TMP_FILE=$(mktemp "/tmp/api_response.XXXXXX.json")

# --- クリーンアップ処理 ---


# スクリプト終了時（正常・異常問わず）に実行

cleanup() {
    local exit_code=$?
    echo "Cleaning up temporary files..."
    rm -f "$TMP_FILE"
    exit "$exit_code"
}

# EXITシグナルを捕捉してcleanup関数を実行

trap cleanup EXIT

# --- メイン処理 ---

echo "Starting data fetch..."

# curl のオプション解説:


# -s: 進捗を表示しない (silent)


# -S: エラー時はメッセージを表示


# -L: リダイレクトを追跡


# --retry: 失敗時に3回リトライ

curl -sSL --retry 3 --retry-delay 2 "$API_URL" -o "$TMP_FILE"

# jq によるバリデーションと加工


# -e: 結果がnullまたはfalseの場合に終了ステータス1を返す

if ! jq -e '.data' "$TMP_FILE" > /dev/null; then
    echo "Error: Invalid JSON structure received." >&2
    exit 1
fi

# データの抽出と保存

jq -c '.data[] | {id: .id, val: .value}' "$TMP_FILE" >> "$OUT_FILE"

echo "Process completed successfully."

# /etc/systemd/system/metric-collector.service

[Unit]
Description=Metric Collector Batch Job
After=network.target

[Service]
Type=oneshot
ExecStart=/usr/local/bin/metric-collector.sh
User=batchuser
Group=batchuser
PrivateTmp=true

# /etc/systemd/system/metric-collector.timer

[Unit]
Description=Run Metric Collector every hour

[Timer]
OnCalendar=hourly
Persistent=true

[Install]
WantedBy=timers.target