bashのPIPESTATUSとset -o pipefailでパイプラインの失敗を検知する方法｜パイプ途中のエラーを見逃さない設計

この記事のポイント

・set -o pipefail を設定するとパイプ途中の失敗でパイプライン全体が非ゼロを返す
・$PIPESTATUS 配列で各コマンドの終了コードを個別に参照できる
・$PIPESTATUS はすぐに上書きされるため、実行直後に別変数にコピーするのが定石
・set -e・set -u・set -o pipefail の3つを組み合わせると堅牢なエラー検知になる

# デフォルトのbash動作（RHEL 9.4 での実行例）
[admin@rhel94-sv01 ~]$ cat /var/log/nonexistent.log | grep "Error" | wc -l
cat: /var/log/nonexistent.log: No such file or directory
0

# catは失敗しているが、$? は wc -l の終了コード（0）を返す
[admin@rhel94-sv01 ~]$ echo $?
0

# コマンドラインから設定（現在のシェルセッションに適用）
set -o pipefail

# スクリプト内での典型的な記述（shebang の直後）
#!/bin/bash
set -o pipefail

# set -e・set -u とセットで使うのが現場での定番
#!/bin/bash
set -euo pipefail

# pipefail 設定後の動作（RHEL 9.4）
[admin@rhel94-sv01 ~]$ set -o pipefail
[admin@rhel94-sv01 ~]$ cat /var/log/nonexistent.log | grep "Error" | wc -l
cat: /var/log/nonexistent.log: No such file or directory
0

# 今度は $? が 1 を返す（catの失敗がパイプライン全体に伝播）
[admin@rhel94-sv01 ~]$ echo $?
1

# pipefailの設定状態を確認する
[admin@rhel94-sv01 ~]$ set -o | grep pipefail
pipefail        on

#!/bin/bash
set -euo pipefail

echo "ログ集計を開始します"

# pipefail がなければ cat の失敗を見逃す
RESULT=$(cat /var/log/application.log | grep "ERROR" | wc -l)
echo "エラー件数: $RESULT"

echo "完了"

# パイプラインを実行
[admin@rhel94-sv01 ~]$ cat /var/log/nonexistent.log | grep "Error" | wc -l
cat: /var/log/nonexistent.log: No such file or directory
0

# 各コマンドの終了コードを確認する
[admin@rhel94-sv01 ~]$ echo "${PIPESTATUS[@]}"
1 1 0

# インデックスで個別にアクセスする
# ${PIPESTATUS[0]} = cat の終了コード（1: ファイルなし）
# ${PIPESTATUS[1]} = grep の終了コード（1: マッチなし）
# ${PIPESTATUS[2]} = wc -l の終了コード（0: 正常）
[admin@rhel94-sv01 ~]$ echo "cat:${PIPESTATUS[0]} grep:${PIPESTATUS[1]} wc:${PIPESTATUS[2]}"
cat:1 grep:1 wc:0

# NG例: if 文の条件式評価時に $PIPESTATUS が上書きされる
cat /var/log/nonexistent.log | grep "Error" | wc -l

# この if 文の [ ] が実行された瞬間に $PIPESTATUS は [ ] の結果で上書きされる
if [ "${PIPESTATUS[0]}" -ne 0 ]; then
    echo "catが失敗しました"
fi
# → 正しく動作しない

#!/bin/bash

# パイプラインを実行
cat /var/log/nonexistent.log | grep "Error" | wc -l

# 実行直後に配列全体をコピー（これが唯一安全な方法）
PIPE_STATUS=("${PIPESTATUS[@]}")

# コピーした変数で判定する
if [ "${PIPE_STATUS[0]}" -ne 0 ]; then
    echo "ERROR: cat コマンドが失敗しました（終了コード: ${PIPE_STATUS[0]}）" >&2
fi

if [ "${PIPE_STATUS[1]}" -ne 0 ]; then
    echo "WARN: grep にマッチする行がありませんでした（終了コード: ${PIPE_STATUS[1]}）" >&2
fi

# 全コマンドの失敗をループで確認する
for i in "${!PIPE_STATUS[@]}"; do
    if [ "${PIPE_STATUS[$i]}" -ne 0 ]; then
        echo "コマンド $((i+1)) が失敗（終了コード: ${PIPE_STATUS[$i]}）" >&2
    fi
done

#!/bin/bash
set -uo pipefail

# ---- 設定 ----
BACKUP_SRC="/var/data/important"
BACKUP_HOST="backup@192.168.x.x"
BACKUP_DEST="/backup/$(date +%Y%m%d).tar.gz"
LOG="/var/log/backup.log"

log() {
    echo "[$(date '+%Y-%m-%d %H:%M:%S')] $*" >> "$LOG"
}

# ---- バックアップ実行 ----
log "バックアップ開始: $BACKUP_SRC"

tar czf - "$BACKUP_SRC" | ssh -q "$BACKUP_HOST" "cat > '$BACKUP_DEST'"
PIPE_STATUS=("${PIPESTATUS[@]}")

# ---- 終了コードを確認 ----
if [ "${PIPE_STATUS[0]}" -ne 0 ]; then
    log "ERROR: tar が失敗（終了コード: ${PIPE_STATUS[0]}）"
    exit 1
fi

if [ "${PIPE_STATUS[1]}" -ne 0 ]; then
    log "ERROR: ssh 転送が失敗（終了コード: ${PIPE_STATUS[1]}）"
    exit 1
fi

log "バックアップ正常終了"
exit 0

#!/bin/bash
set -uo pipefail

LOG_FILE="/var/log/application/access.log"
REPORT="/var/tmp/error_report_$(date +%Y%m%d).txt"

# エラーログを集計してレポートファイルに出力
grep "ERROR" "$LOG_FILE" | awk '{print $1, $4}' | sort | uniq -c | sort -rn > "$REPORT"
PIPE_STATUS=("${PIPESTATUS[@]}")

# grep が失敗した場合（ファイルが読めないなど）は異常終了
if [ "${PIPE_STATUS[0]}" -ge 2 ]; then
    echo "ERROR: ログファイルの読み込みに失敗しました: $LOG_FILE" >&2
    exit 1
fi

# grep 終了コード1（マッチなし）は正常状態として扱う
if [ "${PIPE_STATUS[0]}" -eq 0 ]; then
    echo "レポートを出力しました: $REPORT"
else
    echo "エラーログは検出されませんでした"
fi

#!/bin/bash
set -uo pipefail

# コマンド置換内のパイプラインを実行
RESULT=$(cat /nonexistent | grep "foo" | wc -l)
PIPE_STATUS=("${PIPESTATUS[@]}")

# $PIPESTATUS は $() 自体の終了コードのみ（要素が1つ）
echo "${PIPE_STATUS[@]}"   # → "1" のみ（コマンド置換全体の失敗を示す）
echo "${#PIPE_STATUS[@]}"  # → 1（要素数は1）

# 正しい対処: パイプラインをコマンド置換の外に出す
cat /nonexistent | grep "foo" | wc -l
PIPE_STATUS=("${PIPESTATUS[@]}")
echo "${PIPE_STATUS[@]}"   # → "1 1 0"（各コマンドの終了コード）

#!/bin/bash
set -uo pipefail

# パイプの右側が while read の場合
# while が exit 0 で終了するため、cat の失敗が pipefail で検知されないケースがある
cat /var/log/app.log | while read -r line; do
    echo "処理: $line"
done
PIPE_STATUS=("${PIPESTATUS[@]}")
# while は通常 exit 0 を返すため PIPE_STATUS[1] が 0 になる場合がある

# 推奨: process substitution を使う
while read -r line; do
    echo "処理: $line"
done < <(cat /var/log/app.log)
# この形式であれば cat の終了コードを $? で確認できる

#!/bin/bash
set -euo pipefail

# 問題のあるパターン: マッチなしで set -e がスクリプトを停止させる
COUNT=$(grep -c "ERROR" /var/log/app.log)

# 安全なパターン1: -e を局所的に無効にする
set +e
COUNT=$(grep -c "ERROR" /var/log/app.log)
set -e

# 安全なパターン2: if 文で先にファイルと内容を確認する
if grep -q "ERROR" /var/log/app.log; then
    COUNT=$(grep -c "ERROR" /var/log/app.log)
    echo "エラー件数: $COUNT"
else
    echo "エラーログなし"
fi