我是否需要在python项目中跨模块共享记录器实例?

时间:2017-07-13 10:19:57

标签: python logging flask logrotate

我有一个特定于我的项目的通用记录器实例。它会自动创建并附加2个处理程序(StreamHandlerTimedRotatingFileHandler),并为其预先配置不同的格式等。

logging_formatters = {
    'fmt': "%(asctime)s [%(levelname)8s:%(process)05d] [%(module)10s:%(lineno)03d] (%(name)s) %(message)s",
    'datefmt': "%Y-%m-%d %H:%M:%S"
}
def get_logger(
        application_name=None,
        filename=None,
        *args,
        **kwargs
):
    if not isinstance(application_name, str):
        raise ValueError("Logger class expects a string type application name")

    if filename is None:
        filename = application_name

    if not filename.endswith(".log"):
        filename = filename.split('.')[0] + ".log"

    log_path = kwargs.get('log_path')
    service_name = kwargs.get('service_name', '')
    console_level = kwargs.get('console_level', logging.INFO)
    file_level = kwargs.get('file_level', logging.DEBUG)

    logger = logging.getLogger(application_name)
    if len(logger.handlers) > 0:
        return logger
    # Create 2 handlers, and add them to the logger created
    # ...
    # ...
    # ...

现在,假设我的烧瓶项目结构类似于:

/
- app.py
- settings.py
- dir1/
    - __init__.py
    - mod1.py
- dir2/
    - __init__.py
    - mod2.py

我使用python app.py启动服务器。 app.py本身会导入dir1.mod1dir2.mod2模块。每个模块都创建自己的记录器实例,如下所示:

logger = log_package.get_logger(
    application_name='{}.{}'.format(settings.APPLICATION_NAME, __name__),
    filename=settings.LOG_FILE_NAME,
    service_name=settings.SERVICE_NAME,
)

如果是app.py,则为:

logger = log_package.get_logger(
    application_name='{}.{}'.format(settings.APPLICATION_NAME, 'run'),
    filename=settings.LOG_FILE_NAME,
    service_name=settings.SERVICE_NAME,
)

现在,我面临的问题是; TimedRotatingFileHandler适用于所有子模块(即dir1.mod1dir2.mod2等)但是,来自app.py的日志未被转移到新文件。该特定实例将日志写入与服务启动时相同的文件。例如。如果我在2017-07-11上启动了服务,那么app.py将继续将日志写入LOG_FILE_NAME.log.2017-07-11,而其他模块每天都在翻转(when=midnight)并且正在编写新日志到LOG_FILE_NAME.log

TimedRotatingFileHandler 背后的问题可能不适用于特定文件?我为目录中的所有文件运行了lsof命令,这是输出:

COMMAND   PID   USER   FD   TYPE DEVICE SIZE/OFF   NODE NAME
python  23795 ubuntu    4w   REG  202,1  2680401 150244 /path/to/LOG_FILE_NAME.2017-07-12
python  23795 ubuntu   33w   REG  202,1   397074 150256 /path/to/LOG_FILE_NAME.log

我是否需要在python项目中跨模块共享记录器实例?我认为这不应该是必需的,因为日志模块本身就是线程安全的。

1 个答案:

答案 0 :(得分:1)

TimedRotatingHandler实例不应该写入LOG_FILE_NAME.log以外的文件 - 滚动时会创建LOG_FILE_NAME.2017-07-12等其他文件,不应该保持打开状态

您应确保在进程中只有一个TimedRotatingFileHandler实例用于给定文件名 - 如果您有两个不同的处理程序实例都引用相同的文件名,则可能会出现意外行为(如果一个实例翻转,它会更改它正在使用的文件,但是另一个实例仍然会引用旧文件,并继续写入该文件。

您可能只需将处理程序附加到根记录程序而不是单个模块记录程序,其他记录程序会在默认条件下(记录程序的默认propagate设置未更改)选择这些处理程序。

更新: %(name)s始终提供用于记录调用的记录器的名称,即使处理程序连接到祖先记录器也是如此。如果记录器的propagate设置为False,则不会使用祖先记录器中的处理程序 - 因此您应将propagate保留为其默认值True。< / p>