Log

[nemchik]

Fixes #485

Proposed Changes

1. Add log functions so that we have different levels of logging, automatic formatting (colors), timestamps, and logging happens to the console (based on user defined verbosity) and a log file (regardless of verbosity - although we can consider user defined verbosity here as well)
2. Any output that the user should see (almost all echo calls) should use the log functions
3. Allow the user to define verbosity for the console output (default to full verbosity and allow users to lower it with a variable)

Log Functions Added

• fatal will display a fatal message (red background, white text) AND will exit 1. Always displayed regardless of LOG_LEVEL
• error will display an error message (red text). Always displayed regardless of LOG_LEVEL
• warn will display a warn message (yellow text). Always displayed regardless of LOG_LEVEL
• notice will display a notice message (green text). Always displayed regardless of LOG_LEVEL
• info will display an info message (blue text). Only displays if 'LOG_LEVELis set toVERBOSE`
• debug will display a debug message (blue text). Only displays if 'LOG_LEVELis set toDEBUG`
• trace will display a trace message (blue text). Only displays if 'LOG_LEVELis set toTRACE`

All messages (regardless of LOG_LEVEL are output to the LOG_FILE

Readiness Checklist

• Label as breaking if this is a large fundamental change
• Label as either automation, bug, documentation, enhancement, infrastructure, or performance

Remaining Tasks

• Replace all lines that currently produce loggable output with log functions (so the log file is used)
• Add the code to allow setting the verbosity level
• • Default to full verbosity (output everything)
• • Replace existing notice calls with info calls as needed
• Document the new user facing variables

[admiralAwkbar]

Looks good

[zkoppert]

hey just checking in, Can you check off the boxes that you completed in the description.

[nemchik]

hey just checking in, Can you check off the boxes that you completed in the description.

Done, and added one last task unless anyone looks through this sooner and finds something else that should be adjusted.

I figure we may over time move around what is output as fatal, error, warn, notice, info, debug, and trace. Speaking of, I'll document in the OP a little about each of them.

[nemchik]

Ok, documentation is added. This should be ready to merge.

[zkoppert]

Looks good to me!