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}
If the caller name is shown and the caller was the body of the file, a line number will be shown instead.
Available log levels:
- TRACE
- DEBUG
- INFO
- WARNING
- ERROR
- EXCEPTION
- 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_caller_chain_size | Limits the maximum size of the call chain shown | -1 (No limit) |
| 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) |
| out | The standard output TextIO. | stdout |
| err | The standard error TextIO. If set to None 'out' will be used | stderr |
| 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 | Setting this will log the unwanted levels but will not display them in console | False |
| log_disabled | Disables logging to everywhere, and disables warning about silent logging | False |
| enable_file | Enables log file if a name is provided | True |
| enable_color | Enables coloring of the console log. If NO_COLOR environment variable is set, this will be ignored | True |
Additional info
The consol logging uses colors for the different levels to be more recognizable 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 | EXCEPTION
#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: LEVEL)
Sets the loggers leve to be used from this point onwards.
set_folder(folder: str)
Sets the loggers folder to be used from thi point. It also runs the basic validation on the inputed path.
log(level: LEVEL, data: str, counter: str | None = str(datetime.now()), end: str = "\n", only_console: bool = False)
Creates a log entry with the given level.
The 'only_console' argument will remove the log from logfile, and only display the 'data' with the correct coloring.
header(data: str, counter: str | None = str(datetime.now()), end: str = "\n", only_console: bool = False)
Creates a HEADER level log entry.
heartbeat(self, data: str, counter: str | None = str(datetime.now()), end: str = "\n")
Creates a TRACE level log entry. Will only show up in console.
trace(data: str, counter: str | None = str(datetime.now()), end: str = "\n", only_console: bool = False)
Creates a TRACE level log entry.
debug(data: str, counter: str | None = str(datetime.now()), end: str = "\n", only_console: bool = False)
Creates a DEBUG level log entry.
warning(data: str, counter: str | None = str(datetime.now()), end: str = "\n", only_console: bool = False)
Creates a WARNING level log entry.
info(data: str, counter: str | None = str(datetime.now()), end: str = "\n", only_console: bool = False)
Creates a INFO level log entry.
error(data: str, exception: Exception | None = None counter: str | None = str(datetime.now()), end: str = "\n", only_console: bool = False)
Creates a ERROR level log entry.
exception(exception: Exception)
Creates an EXCEPTION level log entry. This will only print the exception as a traceback.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
smdb_logger-1.5.2.tar.gz
(10.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file smdb_logger-1.5.2.tar.gz.
File metadata
- Download URL: smdb_logger-1.5.2.tar.gz
- Upload date:
- Size: 10.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b16d2499f8f910bfc1c0d501b10732a1e8af9562f6fb7d64c90618edfff1596a
|
|
| MD5 |
898e911786412deb7a7e037bcced147a
|
|
| BLAKE2b-256 |
5e43bf5b2a6bdd030eb6578c470f16ad09c60f964ae96d9719afd744296b0253
|
File details
Details for the file smdb_logger-1.5.2-py3-none-any.whl.
File metadata
- Download URL: smdb_logger-1.5.2-py3-none-any.whl
- Upload date:
- Size: 10.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6fde10cfee9188a63f49e3a6cb34cc3d96bb12d3d23a23cb4372b1deab5b3590
|
|
| MD5 |
7ad47cd6b2cae32202c4bd5dc43c81ca
|
|
| BLAKE2b-256 |
6fa6194fa31c2d6d345d2574682665f3662cd83b7a9f5c9db7636fbe08ec664c
|
