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

この記事のポイント

・set -o pipefail を設定するとパイプ途中の失敗でパイプライン全体が非ゼロを返す
・$PIPESTATUS 配列で各コマンドの終了コードを個別に参照できる
・$PIPESTATUS はすぐに上書きされるため、実行直後に別変数にコピーするのが定石
・set -u（nounset）で未定義変数参照をエラーにし、タイポによる意図しない処理を防ぐ
・set -e・set -u・set -o pipefail の3つを組み合わせた set -euo pipefail が堅牢な出発点
・grep のマッチなし（exit 1）や head との組み合わせ（SIGPIPE/exit 141）には専用の回避設計が必要

# デフォルトの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

#!/bin/bash
set -e   # これだけでは不十分

# catが失敗しても、wc -l が成功（0）を返すためスクリプトは継続する
cat /var/log/nonexistent.log | grep "Error" | wc -l
echo "ここに到達してしまう"

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

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

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

#!/bin/bash
set -euo pipefail
IFS=$'
	'   # スペースをフィールド区切りから除外（ファイル名にスペースがある環境で有効）

# 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 "完了"

#!/bin/bash
# set -u を設定していない危険な例

BACKUP_DIR="/var/backup"
# タイポで変数名を間違えた場合
rm -rf "${BACKUP_DUR}/"   # BACKUP_DUR は未定義 → 空文字列として展開される
# 展開後は rm -rf "/" と同等になる可能性がある

#!/bin/bash
set -u

BACKUP_DIR="/var/backup"
rm -rf "${BACKUP_DUR}/"   # ← ここで即停止

# 実行結果（RHEL 9.4）
# /path/to/script.sh: line 5: BACKUP_DUR: unbound variable

#!/bin/bash
set -u

# 環境変数が未定義のときはデフォルト値を使う
LOG_DIR="${MYAPP_LOG_DIR:-/var/log/myapp}"
MAX_RETRY="${MAX_RETRY:-3}"
DRY_RUN="${DRY_RUN:-false}"

echo "ログ出力先 : ${LOG_DIR}"
echo "最大リトライ: ${MAX_RETRY}"
echo "ドライラン  : ${DRY_RUN}"

#!/bin/bash
set -euo pipefail

# 通常のパイプ処理（pipefailが有効）
cat /etc/passwd | wc -l

# grepのマッチなし（exit 1）を無視したい場合は一時無効化
set +o pipefail
MATCH_COUNT=$(grep "対象パターン" /var/log/app.log | wc -l)
set -o pipefail

echo "マッチ件数: ${MATCH_COUNT}"

# パイプラインを実行
[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 -euo pipefail

check_pipeline() {
    local logfile="$1"
    local pattern="$2"
    local pipe_status

    grep "$pattern" "$logfile" | sort | uniq -c
    pipe_status=("${PIPESTATUS[@]}")

    # grep の終了コード2（ファイルアクセスエラー）のみ異常とする
    if [ "${pipe_status[0]}" -eq 2 ]; then
        echo "ERROR: grep でファイルアクセスエラーが発生しました" >&2
        return 1
    fi
    # 終了コード1（マッチなし）は正常として許容
    return 0
}

check_pipeline "/var/log/app.log" "ERROR"

#!/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

DB_HOST="db01.internal"
DB_USER="backup_user"
DB_NAME="myapp"
BACKUP_DIR="/backup/mysql"
BACKUP_FILE="${BACKUP_DIR}/$(date '+%Y%m%d_%H%M%S')_${DB_NAME}.sql.gz"

mkdir -p "$BACKUP_DIR"

# ダンプ → gzip のパイプ
mysqldump --host="$DB_HOST" --user="$DB_USER"   --single-transaction --quick "$DB_NAME"   | gzip -c > "$BACKUP_FILE"
PIPE_STATUS=("${PIPESTATUS[@]}")

# mysqldump（ステージ0）の確認
if [ "${PIPE_STATUS[0]}" -ne 0 ]; then
    echo "ERROR: mysqldump が失敗しました（終了コード: ${PIPE_STATUS[0]})" >&2
    rm -f "$BACKUP_FILE"    # 破損バックアップを削除
    exit 1
fi

# gzip（ステージ1）の確認
if [ "${PIPE_STATUS[1]}" -ne 0 ]; then
    echo "ERROR: gzip 圧縮が失敗しました（終了コード: ${PIPE_STATUS[1]})" >&2
    rm -f "$BACKUP_FILE"
    exit 1
fi

echo "バックアップ完了: $BACKUP_FILE"

#!/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

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

# IP別アクセス数の集計（4段パイプライン）
awk '{print $1}' "$LOG_FILE" | sort | uniq -c | sort -rn | head -20 > "$REPORT"
PIPE_STATUS=("${PIPESTATUS[@]}")

# 全ステージを一括検証（インデックスは0始まり）
for i in 0 1 2 3 4; do
    if [ "${PIPE_STATUS[$i]:-0}" -ne 0 ]; then
        echo "ERROR: パイプのステージ $(($i+1)) が失敗（終了コード: ${PIPE_STATUS[$i]})" >&2
        exit 1
    fi
done

echo "レポート生成完了: $REPORT"

#!/bin/bash
set -uo pipefail

LOGFILE="/var/log/app/production.log"
OUTFILE="/var/report/$(date +%Y%m%d)-errors.txt"

# tee で標準出力とファイルに同時出力
grep "ERROR" "$LOGFILE" | sort | uniq -c | tee "$OUTFILE"
PIPE_STATUS=("${PIPESTATUS[@]}")

# grepとteeそれぞれの終了コードを確認
if [ "${PIPE_STATUS[0]}" -ge 2 ]; then
    echo "ERROR: ログファイルにアクセスできません" >&2
    exit 1
fi
if [ "${PIPE_STATUS[3]}" -ne 0 ]; then
    echo "ERROR: ファイルへの書き込みに失敗しました: $OUTFILE" >&2
    exit 1
fi

echo "レポート保存完了: $OUTFILE"

# ログの先頭5行だけ表示したい
cat /var/log/syslog | head -n 5
echo "終了コード: $?"

# SIGPIPEが発生することが分かっている処理だけ pipefail を一時無効化
set +o pipefail
cat /var/log/syslog | head -n 5
set -o pipefail

cat /var/log/syslog | head -n 5
cat_exit="${PIPESTATUS[0]}"

# SIGPIPE（141）は正常な打ち切りとして許容する
if [ "$cat_exit" -ne 0 ] && [ "$cat_exit" -ne 141 ]; then
    echo "ERROR: cat が失敗しました（exit $cat_exit)" >&2
    exit 1
fi

# sed -n '1,5p' は5行処理後に自ら正常終了するので SIGPIPE が発生しない
cat /var/log/syslog | sed -n '1,5p'
echo "終了コード: $?"   # 0

#!/bin/bash
set -euo pipefail

LOCK_FILE="/tmp/$(basename "$0").lock"
LOG_FILE="/var/log/myapp/process.log"
TIMESTAMP=$(date '+%Y-%m-%d %H:%M:%S')

# EXIT シグナルで後始末を確実に実行（正常・異常問わず）
cleanup() {
    local exit_code=$?
    rm -f "$LOCK_FILE"
    if [ $exit_code -ne 0 ]; then
        echo "[$TIMESTAMP] ERROR: 異常終了しました（exit=$exit_code)" >> "$LOG_FILE"
    fi
}
trap cleanup EXIT

# 二重起動防止
if [ -e "$LOCK_FILE" ]; then
    echo "[$TIMESTAMP] 既に実行中のプロセスがあります" >> "$LOG_FILE"
    exit 1
fi
touch "$LOCK_FILE"

# パイプラインを実行して直後に PIPESTATUS を保存
cat /var/log/app/access.log | grep "ERROR" | sort | uniq -c | sort -rn > /tmp/error_summary.txt
PIPE_STATUS=("${PIPESTATUS[@]}")

# ステージごとの検証
if [ "${PIPE_STATUS[0]}" -ne 0 ]; then
    echo "[$TIMESTAMP] ERROR: ログファイルの読み込み失敗（exit=${PIPE_STATUS[0]})" >> "$LOG_FILE"
    exit 2
fi

# grep マッチなし（exit 1）は業務的に正常として扱う
if [ "${PIPE_STATUS[1]}" -eq 1 ]; then
    echo "[$TIMESTAMP] INFO: ERRORパターンなし（正常）" >> "$LOG_FILE"
    exit 0
fi

echo "[$TIMESTAMP] INFO: エラー集計完了" >> "$LOG_FILE"

#!/bin/bash
set -euo pipefail

# エラー発生時に行番号と終了コードをログに記録する
on_error() {
    local exit_code=$?
    local line_no=$1
    echo "[ERROR] $(date '+%Y-%m-%d %H:%M:%S') 行 ${line_no} で失敗 (終了コード: ${exit_code})" >&2
    rm -f /tmp/myapp_lock.pid || true
}
trap 'on_error $LINENO' ERR

echo "[INFO] バックアップ開始"
rsync -av --delete /var/www/html/ /mnt/backup/www/
echo "[INFO] バックアップ完了"

#!/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

# OK: サブシェル () 内では pipefail が継承される
(
    cat /tmp/nonexistent | wc -l    # サブシェルが exit 1 で終了 → 親シェルも停止
)

# 注意: bash -c 内は独立したシェル → pipefail は引き継がれない
bash -c 'cat /tmp/nonexistent | wc -l; echo done'

# 安全策: bash -c でも明示的に設定を渡す
bash -c 'set -euo pipefail; cat /tmp/nonexistent | wc -l; echo done'

# 別スクリプトへの呼び出しも同様: 呼び出し先にも set -euo pipefail を書く
bash /path/to/sub_script.sh

#!/bin/bash
set -euo pipefail

# 安全なパターン: if 文で先にマッチ有無を確認してから件数取得
if grep -q "ERROR" /var/log/app.log; then
    COUNT=$(grep -c "ERROR" /var/log/app.log)
    echo "エラー件数: $COUNT"
else
    echo "エラーログなし"
fi

# grepのexit 1を|| trueで打ち消す（マッチなしを正常として扱う場合）
INVALID_COUNT=$(grep "INVALID USER" /var/log/auth.log | wc -l || true)
echo "不正アクセス試行: ${INVALID_COUNT}件"

# set +e を局所的に使い、マッチなし（exit 1）を正常として扱う
set +e
COUNT=$(grep -c "ERROR" /var/log/app.log)
set -e
echo "エラー件数: $COUNT"

set -euo pipefail

# pipefailあり: grepが失敗してもif文の条件評価なのでset -eは発動しない
# ただしpipefailにより条件式がfalseになりelseブランチに入る
if grep "ERROR" /var/log/app.log | head -n 1; then
    echo "エラーログあり"
else
    echo "エラーなし（またはログ取得失敗）"
fi

#!/bin/bash
set -euo pipefail
set -x    # デバッグ時のみ: 実行するコマンドをステップ表示

# スクリプト本体
tar czf - /var/data | ssh backup-server "cat > /backup/data.tar.gz"
PIPE_STATUS=("${PIPESTATUS[@]}")
echo "pipe_status: ${PIPE_STATUS[@]}"

set +x    # トレース終了

# 構文エラーがないか事前に確認する（実際には実行されない）
$ bash -n /path/to/backup.sh

# 構文エラーが見つかった場合の出力例
$ bash -n /path/to/backup.sh
/path/to/backup.sh: line 15: unexpected token `fi'
# エラーがなければ何も出力されない（終了コード0）

# bash: PIPESTATUS（大文字）
bash -c 'cat /etc/passwd | grep "foo" | wc -l; echo "${PIPESTATUS[@]}"'
# → 0 1 0

# zsh: pipestatus（小文字）
zsh -c 'cat /etc/passwd | grep "foo" | wc -l; echo "${pipestatus[@]}"'
# → 0 1 0

#!/bin/bash
set -euo pipefail

get_value() {
    # NG: local と代入を同時に行うと set -e が発動しない
    local result=$(some_failing_command)   # some_failing_command が失敗しても止まらない

    # OK: 宣言と代入を分けることで set -e が正しく働く
    local result2
    result2=$(some_failing_command)        # これは set -e が有効
}