Logging¶
get_formatter(log_format='plain', formatter_str=None, use_colors=False, access_log=False)
¶
Build a formatter from a predefined name or a custom format string.
Source code in aloha/logger/logger.py
get_logger(logger_name=None, level=logging.DEBUG, **kwargs)
¶
Get a configured logger instance.
Creates or retrieves a logger by name and sets it up with file and stream handlers.
Accepts string and integer logging levels. If logger_name is None,
configures the root logger.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
level
|
Logging level (int or str, default: DEBUG) |
DEBUG
|
|
logger_name
|
str | None
|
Logger name (default: the root logger) |
None
|
kwargs
|
Additional keyword arguments passed to setup_logger |
{}
|
Returns:
| Type | Description |
|---|---|
Logger
|
Configured logger instance |
Source code in aloha/logger/logger.py
JsonFormatter
¶
Bases: Formatter
Format log records as JSON objects.
Source code in aloha/logger/logger.py
PlainFormatter
¶
Bases: Formatter
Format plain logs with an optional Uvicorn-style colored level prefix.
Source code in aloha/logger/logger.py
StackInfoFilter
¶
Bases: Filter
Capture the calling stack for records above INFO when it was not supplied.
Source code in aloha/logger/logger.py
get_formatter(log_format='plain', formatter_str=None, use_colors=False, access_log=False)
¶
Build a formatter from a predefined name or a custom format string.
Source code in aloha/logger/logger.py
get_logger(logger_name=None, level=logging.DEBUG, **kwargs)
¶
Get a configured logger instance.
Creates or retrieves a logger by name and sets it up with file and stream handlers.
Accepts string and integer logging levels. If logger_name is None,
configures the root logger.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
level
|
Logging level (int or str, default: DEBUG) |
DEBUG
|
|
logger_name
|
str | None
|
Logger name (default: the root logger) |
None
|
kwargs
|
Additional keyword arguments passed to setup_logger |
{}
|
Returns:
| Type | Description |
|---|---|
Logger
|
Configured logger instance |
Source code in aloha/logger/logger.py
setup_logger(logger, level=logging.DEBUG, logger_name=None, module=None, formatter_str=None, log_format=None, log_format_file='json', log_format_stream='plain', stream=None, access_log=False)
¶
Set up a logger with file and stream handlers.
Configures the logger with: - A multi-process safe daily rotating file handler - A console stream handler - A standard log format
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
logger
|
Logger
|
Logger instance to set up |
required |
level
|
int
|
Logging level (default: DEBUG) |
DEBUG
|
logger_name
|
str | None
|
Name of the logger (optional) |
None
|
module
|
str | None
|
Module name for log file naming (optional) |
None
|
formatter_str
|
str | None
|
Custom log format string (optional) |
None
|
log_format
|
str | None
|
Deprecated format override for both file and stream |
None
|
log_format_file
|
str
|
Predefined format for the file handler |
'json'
|
log_format_stream
|
str
|
Predefined format for the console handler |
'plain'
|
stream
|
TextIO | None
|
Console output stream (defaults to stderr) |
None
|
access_log
|
bool
|
Use the access-log format and omit the source location |
False
|
Source code in aloha/logger/logger.py
MultiProcessSafeDailyRotatingFileHandler
¶
Bases: BaseRotatingHandler
Similar with logging.TimedRotatingFileHandler, while this one is
- Multi process safe
- Rotate at midnight only
- Utc not supported
Source code in aloha/logger/handler.py
close()
¶
Closes the stream.