Skip to content

Latest commit

 

History

History
executable file
·
64 lines (38 loc) · 1.68 KB

README.md

File metadata and controls

executable file
·
64 lines (38 loc) · 1.68 KB
Raw

Bash Logger

Fork of Bash Logger designed to incorperate PSR-3 compliance.

Contributors

  • Dean Rather
  • Fred Palmer

Using Bash Logger

source the bash-logger.sh script at the beginning of any Bash program.

    #!/bin/bash
    source /path/to/bash-logger.sh

    INFO "This is a test info log"

Function names are in CAPS as not to conflict with the info function and alert aliases.

An Overview of Bash Logger

Colorized Output

Colour Screenshot

Logging Levels

Bash Logger supports the logging levels described by RFC 5424.

  • DEBUG Detailed debug information.

  • INFO Interesting events. Examples: User logs in, SQL logs.

  • NOTICE Normal but significant events.

  • WARNING Exceptional occurrences that are not errors. Examples: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.

  • ERROR Runtime errors that do not require immediate action but should typically be logged and monitored.

  • CRITICAL Critical conditions. Example: Application component unavailable, unexpected exception.

  • ALERT Action must be taken immediately. Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.

  • EMERGENCY Emergency: system is unusable.

Handlers

By default:

  • Logs are displayed in colour
  • Logs are written to ~/bash-logger.log
  • error level logs and above exit with an error code

The colours, logfile, default behavior, and log-level behavior can all be overwritten, see examples.sh for examples.