LogHelper.add_file_handler#
- LogHelper.add_file_handler(log_file, fh_format='%(asctime)s [%(name)-40.40s] [%(levelname)-8.8s] %(message)s', datetime_format='%d-%m-%Y %H:%M:%S', log_level=10, json_format=False)[source]#
Add custom file handler to the logger.
- Parameters:
log_file (PathLike | FileHandler) –
If given output log messages to a file. This can be either: - a path to a file, which will create a new file handler with
default settings
- an existing
logging.FileHandlerinstance (or subclass e.g.
logging.handlers.RotatingFileHandlerorlogging.handlers.TimedRotatingFileHandler), which will be used directly.
- an existing
fh_format (str) – A string defining a custom formatting to use for the StreamHandler(). Defaults to “%(asctime)s [%(name)-40.40s] [%(levelname)-8.8s] %(message)s”.
datetime_format (str) – The datetime format to use when logging to the console. Defaults to “%d-%m-%Y %H:%M:%S”
log_level (int) – The logging level to give to the FileHandler.
json_format (bool) – If False (default) write plain text records. If True write JSON records.
- Return type:
None
See also