How do I manage log verbosity inside a shell script? How do I manage log verbosity inside a shell script? unix unix

How do I manage log verbosity inside a shell script?


Improving on @Fred's idea a little bit more, we could build a small logging library this way:

declare -A _log_levels=([FATAL]=0 [ERROR]=1 [WARN]=2 [INFO]=3 [DEBUG]=4 [VERBOSE]=5)declare -i _log_level=3set_log_level() {  level="${1:-INFO}"  _log_level="${_log_levels[$level]}"}log_execute() {  level=${1:-INFO}  if (( $1 >= ${_log_levels[$level]} )); then    "${@:2}" >/dev/null  else    "${@:2}"  fi}log_fatal()   { (( _log_level >= ${_log_levels[FATAL]} ))   && echo "$(date) FATAL  $*";  }log_error()   { (( _log_level >= ${_log_levels[ERROR]} ))   && echo "$(date) ERROR  $*";  }log_warning() { (( _log_level >= ${_log_levels[WARNING]} )) && echo "$(date) WARNING  $*";  }log_info()    { (( _log_level >= ${_log_levels[INFO]} ))    && echo "$(date) INFO   $*";  }log_debug()   { (( _log_level >= ${_log_levels[DEBUG]} ))   && echo "$(date) DEBUG  $*";  }log_verbose() { (( _log_level >= ${_log_levels[VERBOSE]} )) && echo "$(date) VERBOSE $*"; }# functions for logging command outputlog_debug_file()   { (( _log_level >= ${_log_levels[DEBUG]} ))   && [[ -f $1 ]] && echo "=== command output start ===" && cat "$1" && echo "=== command output end ==="; }log_verbose_file() { (( _log_level >= ${_log_levels[VERBOSE]} )) && [[ -f $1 ]] && echo "=== command output start ===" && cat "$1" && echo "=== command output end ==="; }

Let's say the above source is in a library file called logging_lib.sh, we could use it in a regular shell script this way:

#!/bin/bashsource /path/to/lib/logging_lib.shset_log_level DEBUGlog_info  "Starting the script..."# method 1 of controlling a command's output based on log levellog_execute INFO date# method 2 of controlling the output based on log leveldate &> date.outlog_debug_file date.outlog_debug "This is a debug statement"...log_error "This is an error"...log_warning "This is a warning"...log_fatal "This is a fatal error"...log_verbose "This is a verbose log!"

Will result in this output:

Fri Feb 24 06:48:18 UTC 2017 INFO    Starting the script...Fri Feb 24 06:48:18 UTC 2017=== command output start ===Fri Feb 24 06:48:18 UTC 2017=== command output end ===Fri Feb 24 06:48:18 UTC 2017 DEBUG   This is a debug statementFri Feb 24 06:48:18 UTC 2017 ERROR   This is an errorFri Feb 24 06:48:18 UTC 2017 WARNING   This is a warningFri Feb 24 06:48:18 UTC 2017 FATAL   This is a fatal error

As we can see, log_verbose didn't produce any output since the log level is at DEBUG, one level below VERBOSE. However, log_debug_file date.out did produce the output and so did log_execute INFO, since log level is set to DEBUG, which is >= INFO.

Using this as the base, we could also write command wrappers if we need even more fine tuning:

git_wrapper() {  # run git command and print the output based on log level}

With these in place, the script could be enhanced to take an argument --log-level level that can determine the log verbosity it should run with.


Here is a complete implementation of logging for Bash, rich with multiple loggers:

https://github.com/codeforester/base/blob/master/lib/stdlib.sh


If anyone is curious about why some variables are named with a leading underscore in the code above, see this post:


You already have what seems to be the cleanest idea in your question (a wrapper function), but you seem to think it would be messy. I would suggest you reconsider. It could look like the following (not necessarily a full-fledged solution, just to give you the basic idea) :

#!/bin/bash# Argument 1 : Logging level for that command# Arguments 2... : Command to execute# Output suppressed if command level >= current logging level log(){if  (($1 >= logging_level))then  "${@:2}" >/dev/null 2>&1else  "${@:2}"fi}logging_level=2log 1 command1 and its argslog 2 command2 and its argslog 3 command4 and its args

You can arrange for any required redirection (with file descriptors if you want) to be handled in the wrapper function, so that the rest of the script remains readable and free from redirections and conditions depending on the selected logging level.


Solution 1.Consider using additional file descriptors.Redirect required file descriptors to STDOUT or /dev/null depending on selected verbosity.Redirect output of every statement in your script to a file descriptor corresponding to its importance.Have a look at https://unix.stackexchange.com/a/218355 .