Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 2.49 KB

doc.md

File metadata and controls

107 lines (76 loc) · 2.49 KB

Global Variables

Log Levels:

  • LOG_LVL_DEBUG = 0
  • LOG_LVL_INFO = 10
  • LOG_LVL_WARNING = 20
  • LOG_LVL_ERROR = 30
  • LOG_LVL_CRITICAL = 40

Log Colors:

  • LOG_CLR_DEBUG = Cyan
  • LOG_CLR_INFO = White
  • LOG_CLR_WARNING = Yellow
  • LOG_CLR_ERROR = Red
  • LOG_CLR_CRITICAL = Bright Red

Default Settings:

  • CURRENT_LOG_LVL = LOG_LVL_INFO
  • DEFAULT_LOG_DST = 1 (stdout)
  • DATE_FMT = "%Y-%m-%d %H:%M:%S"

Functions

log

Purpose:
Logs a message if the current logging level is less than or equal to the provided log level.

Parameters:

  1. lvl: The numeric log level of the message (LOG_LVL_DEBUG, LOG_LVL_INFO, etc.).
  2. msg: The message to log.
  3. dst (Optional): The file descriptor to log to (default: stdout).

Behavior:

  • Logs the message to the specified destination if CURRENT_LOG_LVL <= lvl.
  • The log message is color-coded and includes a timestamp.

Example:

log $LOG_LVL_WARNING "This is a warning!"  
log $LOG_LVL_DEBUG "This is debug information" 2  # Logs to stderr

set_log_lvl

Purpose:
Sets the current logging level based on a string input.

Parameters:

  • string_lvl: The log level to set. Must be one of the following:
    • "debug"
    • "info"
    • "warning"
    • "error"
    • "critical"

Behavior:

  • Updates the CURRENT_LOG_LVL variable to match the corresponding numeric log level.
  • If an invalid level is passed, no changes are made, and the function exits silently.

Example:

set_log_lvl "debug"

log_lvl_to_color

Purpose:
Converts a numeric log level to its corresponding color code.

Parameters:

  • log_lvl: The numeric log level.

Returns:

  • The color code associated with the provided log level.

Behavior:

  • Prints the appropriate color code for the given log level to stdout.

Example:

color=$(log_lvl_to_color $LOG_LVL_WARNING)  
echo "$color"  # Outputs: Yellow

Notes

  1. Custom Timestamps:

    • Modify the DATE_FMT variable to customize the timestamp format.
    • Set DATE_FMT="" to remove timestamps from log messages.

  2. Error Handling:

    • Ensure all numeric log levels and color codes are correctly defined.

  3. Default Destination:

    • If dst is not specified, logs are sent to stdout by default.