Skip to content

NightKey/smdb-logger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Server monitoring Discord Bot Logger

This is a logger used by the Server Monitoring Discord Bot and every module created for it by me.

Possible log formats:

  • [COUNTER] [LEVEL]: DATA{END}
  • [COUNTER] [FILE_NAME->METHOD_1->...->CALLER]: DATA{END}
  • [COUNTER] [METHOD_1->...->CALLER]: DATA{END}

Available log levels:

  • TRACE
  • DEBUG
  • INFO
  • WARNING
  • ERROR
  • HEADER

Options:

Variable name Description Default value
log_file_name The name of the log file None
log_folder The path of the folder to save the log file Current Directory
clear Clears the log file every time it's initialized False
level Sets the minimum level for the logger to show INFO
log_to_console Sets to log to console too True
storage_life_extender_mode Limits the writes to the file by caching the data False
max_logfile_size Limits the size of one log file in MB -1 (No limit)
max_logfile_lifetime Limits the time a log file can live (except the currently used one) -1 (No limit)
__print Callable for consol logging stdout.write
__error Callable for consol error logging. None sets to be __print stderr.write
use_caller_name Use the caller's name in consol logging instead of the level False
use_file_names Use the file name whe using the caller name or not True
use_log_name Use the log file name to differenciate between multiple loggers on console False
level_only_valid_for_console Sets to log the unwanted levels but don't display them in console False
log_disabled Disables logging to everywhere, and disables warning about silent logging False

Additional info

The consol logging uses colors for the different levels to be more recognisable at a glance. It also supports headers, after which it indents the logs to add some structure.

TRACE

  • #00E6E5

DEBUG

  • #E600E5

INFO

  • #0BFF00

WARNING

  • #FEFF00

ERROR

  • #FF0000

HEADER

  • #4182B7

Available methods

get_buffer()

Return sthe buffer's content in a list, if the logger is set to use buffers.

flush_buffer()

Forces a writes of the buffer to the log file.

set_level(level)

Sets the loggers leve to be used from this point onwards.

set_folder(folder)

Sets the loggers folder to be used from thi point. It also runs the basic validation on the inputed path.

log(level, data, counter = str(datetime.now()), end = "\n")

Creates a log entry with the given level.

header(data, counter = str(datetime.now()), end = "\n")

Creates a HEADER level log entry.

trace(data, counter = str(datetime.now()), end = "\n")

Creates a TRACE level log entry.

debug(data, counter = str(datetime.now()), end = "\n")

Creates a DEBUG level log entry.

warning(data, counter = str(datetime.now()), end = "\n")

Creates a WARNING level log entry.

info(data, counter = str(datetime.now()), end = "\n")

Creates a INFO level log entry.

error(data, counter = str(datetime.now()), end = "\n")

Creates a ERROR level log entry.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published