bash入門：logging(ロギング)について -vol.5-

今日は、bashにおけるlogging(ロギング)についてご紹介します。

背景

bashにおけるlogging(ロギング)について調査する機会があったので、そのときの内容を備忘として残しました。

この記事のソースは下記のサイトにアップしています。

実行環境について

実行環境は下記の記事を参考にお願いします。

概要

本記事のロギングは、デバッグとエラーで使い分けるようにしました。

作成ファイル一覧

下記のファイルを作成しました。

        new file:   local/work/11_logging/11_logging.sh

11_logging.sh

#!/usr/bin/env bash

set -euCo pipefail

readonly LOG_OUT=./stdout.log
readonly LOG_ERR=./stderr.log

exec 1> >(tee -a "$LOG_OUT")
exec 2> >(tee -a "$LOG_ERR")

function log_debug() {
    lgg_msg=$(gen_log_msg 'DEBUG' "$*")
    echo "${lgg_msg}"
}

function log_err() {
    lgg_msg=$(gen_log_msg 'ERROR' "$*")
    echo "${lgg_msg}" >&2
}

function gen_log_msg() {
    printf "%s\t[%5s]\t%s" "$(date '+%Y/%m/%d %H:%M:%S.%3N')" "$1" "$2"
}

function trap_err() {
    error_status=$?
    msg=$(printf "エラー発生 \$?=%d %s %s:%d" ${error_status} "${BASH_SOURCE[0]}" "${FUNCNAME[1]}" ${BASH_LINENO[0]})
    log_err "${msg}"
}

function trap_exit() {
    msg=$(printf "終了時の処理 %s %s:%d" "${BASH_SOURCE[0]}" "${FUNCNAME[1]}" ${BASH_LINENO[0]})
    log_debug "${msg}"
}

trap trap_err ERR

trap trap_exit EXIT

log_debug "$(which bash)"

log_debug "$(bash --version)"

# 標準エラーへの出力確認用
ls dummy.txt

echo "ここは表示されない"

動作確認

下記のコマンドを実行します。

make build

make up

make login

cd 11_logging

chmod +x 11_logging.sh

./11_logging.sh

stdout.logとstderr.logに下記の文言が出力されている想定です。

root@1e7efdb14467:/work/11_logging# cat stdout.log 
2023/12/10 15:33:40.439 [DEBUG] /usr/bin/bash
2023/12/10 15:33:40.444 [DEBUG] GNU bash, version 5.2.15(1)-release (aarch64-unknown-linux-gnu)
Copyright (C) 2022 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
ls: cannot access 'dummy.txt': No such file or directory
2023/12/10 15:33:40.449 [ERROR] エラー発生 $?=2 ./11_logging.sh main:45
2023/12/10 15:33:40.452 [DEBUG] 終了時の処理 ./11_logging.sh main:1

root@1e7efdb14467:/work/11_logging# cat stderr.log 
ls: cannot access 'dummy.txt': No such file or directory
2023/12/10 15:33:40.449 [ERROR] エラー発生 $?=2 ./11_logging.sh main:45

解説

11_logging.sh

このスクリプトは、ログ出力機能、エラーハンドリング、スクリプト終了時の処理を組み合わせた Bash スクリプトです。以下に各部分の解説を示します：

1. #!/usr/bin/env bash: スクリプトが Bash シェルで実行されることを指定しています。
2. set -euCo pipefail: スクリプトの設定を変更しています。

• -e: エラーが発生したら即座にスクリプトを終了します。
• -u: 未定義の変数を使用しようとするとエラーを発生させます。
• -C: コマンドの返り値が0以外の場合、そのコマンドが非零であることを示します。
• -o pipefail: パイプの途中でエラーが発生した場合、パイプ全体をエラーとして扱います。

1. readonly LOG_OUT=./stdout.log: 標準出力を記録するログファイルのパスを指定します。
2. readonly LOG_ERR=./stderr.log: 標準エラーを記録するログファイルのパスを指定します。
3. exec 1> >(tee -a "$LOG_OUT"): 標準出力をファイルにリダイレクトし、同時にその内容を標準出力にも表示します。リダイレクト先は $LOG_OUT となります。
4. exec 2> >(tee -a "$LOG_ERR"): 標準エラーをファイルにリダイレクトし、同時にその内容を標準エラーにも表示します。リダイレクト先は $LOG_ERR となります。
5. function log_debug() { ... }: log_debugというデバッグ用のログを記録する関数を定義しています。gen_log_msg関数を呼び出してログの整形を行い、標準出力に表示します。
6. function log_err() { ... }: log_errというエラーログを記録する関数を定義しています。gen_log_msg関数を呼び出してログの整形を行い、標準エラーに表示します。
7. function gen_log_msg() { ... }: gen_log_msgという共通のログ整形関数を定義しています。日付、ログの種類、メッセージを整形して返します。
8. function trap_err() { ... }: trap_errというエラーが発生した際に呼び出される関数を定義しています。エラーのステータスや発生箇所の情報を取得し、log_err関数を呼び出してエラーログを記録します。
9. function trap_exit() { ... }: trap_exitというスクリプトが終了する際に呼び出される関数を定義しています。終了時の処理を行い、log_debug関数を呼び出してデバッグログを記録します。
10. trap trap_err ERR: ERR シグナルに対して、trap_err関数が呼び出されるように設定します。
11. trap trap_exit EXIT: EXIT シグナルに対して、trap_exit関数が呼び出されるように設定します。
12. log_debug "$(which bash)": インストールされている Bash の実行ファイルのパスをデバッグログに記録します。
13. log_debug "$(bash --version)": Bash のバージョン情報をデバッグログに記録します。
14. ls dummy.txt: 標準エラーへの出力確認用に、存在しないファイル dummy.txt を ls コマンドでリストします。この部分でエラーが発生し、trap_err関数が呼び出されてエラーログが記録されます。

おわりに

今日は、bashにおけるlogging(ロギング)についてご紹介しました。