shell-logger:シェルスクリプトでのログ整形、Traceback機能を追加

前に作った shell-logger というシェルスクリプト用ロガーツールをアップデートして Traceback機能を付けたりしてみました。

• shell-logger
• コマンドラインで使う
• シェルスクリプトの中で使う
• Traceback
• 各種設定

shell-logger

• 

  shell-logger: シェルスクリプトで良い感じにログアウトプットを管理する

etc/shell-logger.sh</del>/etc/shell-logger**というファイルを読み込むと debug, info, notice, warn, errと言った関数が使える様になります。

インストールはcurlを使って

$ curl -fsSL https://raw.github.com/rcmdnk/shell-logger/install/install.sh| prefix=~/usr/local/ sh

とすると~/usr/local/etc/shell-loggerがインストールされます。 prefixの場所を適当に変えてインストールしてください。

macOSならHomebrewで

$ brew tap rcmdnk/rcmdnkpac/shell-logger

で入れることが出来ます。

もしくは shell-logger を直接ダウンロードして適当なところに置いてください。

コマンドラインで使う

コマンドラインで使う場合には.bashrcや.zshrcに

1

source /path/to/shell-logger

の様にshell-loggerをsourceする設定を入れてください。

これでinfoやerrと言った関数が使えるようになり、 出力したいワードを引数として渡せば良いだけです。

こんな感じ。

シェルスクリプトの中で使う

Bash/Zshの両方で使えます。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

#!/usr/bin/env bash

# Load shell-logger
source /path/to/shell-logger

# shell-logger settings
LOGGER_LEVEL=0
LOGGER_STDERR_LEVEL=4
LOGGER_ERROR_TRACE=0
LOGGER_COLOR=always


debug "debug"
information "information"
info "info"
notification "notification"
notice "notice"
warning "warning"
warn "warn"
error "error"
err "err"

こんな感じでshell-loggerを読み込んで 後は好きなところでinfoやerrを呼ぶだけです。

shell-loggerには5つのレベルがあり、 それぞれDEBUG, INFO, NOTICE, WARNING, ERRORとなっていて 出力する色や出力先が違います。

カラー出力はファイルへの出力などでは色を付けないようになっています。

デフォルトでは各レベルの色は以下の様な感じ。

また、INFO以上しか出力しない設定になっています さらに、ERRORに関してはエラー出力に出す様になっています。(他は標準出力)

debugに関してはデフォルト設定では出力しませんが、

1
2
3
4
5
6

#!/usr/bin/env bash

source /path/to/shell-logger
LOGGER_LEVEL=0

debug "debug"

と、LOGGER_LEVELを0にすることで表示することが出来るので 簡単にデバッグプリントを入れることが出来ます。

Traceback

トレースバック機能を付けてみました。

こんな感じでerrの時にPythonっぽい雰囲気のTraceback表示を表示してくれます。

各種設定

設定に関しては以下のLOGGER_という値を設定することで変更可能です。