Logger Manager

LoggerManager is a NamedSingleton to provide logger instances with provided configuration. In this module we have the get_logger function to return a logger instance from this singleton.

With only name argument provided, it will return a stream logger (which only logs to console) and the other arguments will take their default values as logging level info and stream logger format %(name)s - %(levelname)s - %(message)s.

from backend_dev_utils import get_loggerlogger = get_logger(name="my-logger")logger.info("Hello World!")my-logger - INFO - Hello World!

Or, if you provide the argument file_path, the logger will automatically create a logger that logs to file.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import logging

from backend_dev_utils import get_logger


logger = get_logger(
    name="my-logger",
    level=logging.INFO,
    file_path="my-log-file.log",
    file_format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
)

logger.info("Hello World!")

Finally, if you provide the rotating_file_path argument, the output file size will be limited by max_bytes argument, and at most backup_count of files will be created named as log-file.log.1, log-file.log.2 etc. And when all limits are full and it needs to write a new log file, it starts deleting from the oldest one.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import logging

from backend_dev_utils import get_logger


logger = get_logger(
    name="my-logger",
    level=logging.INFO,
    rotating_file_name="my-rotating-log-file.log",
    file_format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
    max_bytes=10000,
    backup_count=5,
)

logger.info("Hello World!")