Skip to content

opensourcecorp/ezlog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ezlog - Simple unstructured logging for Bash

ezlog provides an interface for simple logging in bash programs. It contains functions named log-<level>, where <level> is a log level name.

Example log output in a terminal that supports colors

Log levels

Multiple levels are supported, and can be toggled with the EZLOG_LEVEL environment variable, either using the level name or its corresponding code number:

Log level name Log level code Corresponding log function
fatal 1 log-fatal
error 2 log-error
warn 3 log-warn
info 4 log-info
debug 5 log-debug

To completely disable logging, set EZLOG_LEVEL=0 (or really, just anything less than 1). It must be set though, because an unset EZLOG_LEVEL will default to the info level.

ANSI color output

ezlog defaults to printing colored output. It will try to determine if your terminal supports color output or not, though:

Example log output in a terminal that supports colors

Example log output in a terminal that supports no colors

How to use

The recommended way to get ezlog & use the library is by way of bashpack:

source "$(bashpack mainpath 'https://github.com/opensourcecorp/ezlog')"

Then, the log-* functions will be available to use in your scripts.

Realistically, you can get ezlog however you want though -- the lowest-common denominator is to just clone this repo locally, and source the src/main.sh file.

Developing

Developing ezlog requires bash, the bats testing framework, and the shellcheck linter.

About

Simple unstructured logging for Bash

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published