当前位置 博文首页 > Python的logging模块基本用法

    Python的logging模块基本用法

    作者:何雨龙 时间:2021-02-19 18:37

    在服务器部署时,往往都是在后台运行。当程序发生特定的错误时,我希望能够在日志中查询。因此这里熟悉以下 logging 模块的用法。

    logging 模块定义了报告错误和状态信息的标准 API。

    logging 的组件

    日志系统有 4 个相互交互的组件。我们需要使用 Logger 实例来向日志添加信息。触发日志会创建一个 LogRecord,用于内存中存储信息。Logger 可能有很多 Handler 对象,用于接收和处理日志记录。Handler 使用 Formatter 来输出日志记录。

    向文件输入日志

    大多数应用都是把日志输入到文件。使用 basicConfig() 函数可以设置默认的 handler,让日志输入到文件。

    #!/usr/bin/env python
    # -*- coding: utf-8 -*-
    import logging
    
    LOG_FILENAME = 'log.txt'
    logging.basicConfig(
      filename=LOG_FILENAME,
      level=logging.DEBUG,
    )
    
    logging.debug('hello logging!')
    
    with open(LOG_FILENAME, 'rt') as f:
      body = f.read()
    
    print('FILE: ')
    print(body)

    运行脚本后输出如下:

    FILE:
    DEBUG:root:hello logging!

    日志文件的循环

    要让每次程序运行时,生成一个新的文件,需要向 basicConfig() 传一个值为 w 的 filemode 参数。还有一个更方便的方法,就是使用 RotatingFileHandler,可以同时自动创建文件和保存旧文件。

    #!/usr/bin/env python
    # -*- coding: utf-8 -*-
    import glob
    import logging.handlers
    
    LOG_FILENAME = 'log.txt'
    
    my_logger = logging.getLogger('SpecificLogger')
    my_logger.setLevel(logging.DEBUG)
    
    # Add the log message handler to the logger
    handler = logging.handlers.RotatingFileHandler(
      LOG_FILENAME,
      maxBytes=20,
      backupCount=5,
    )
    my_logger.addHandler(handler)
    
    # Log some messages
    for i in range(20):
      my_logger.debug(f'i = {i}')
    
    # See what files are created
    log_files = glob.glob(f'{LOG_FILENAME}*')
    for filename in sorted(log_files):
      print(filename)

    运行脚本后输出如下:

    log.txt
    log.txt.1
    log.txt.2
    log.txt.3
    log.txt.4
    log.txt.5

    可以返现,log.txt 存储的都是最新的内容,logging 会自动地对这些文件进行重命名。 

    信息显示的级别

    logging 有不同的日志级别。

    级别(level) 值(value)
    CRITICAL 50
    ERROR 40
    WARNING 30
    INFO 20
    DEBUG 10
    UNSET 0

    日志可以只在某一级别之上的情况才会触发。

    #!/usr/bin/env python
    # -*- coding: utf-8 -*-
    import logging
    import sys
    
    level = int(sys.argv[1])
    logging.basicConfig(
      level=level
    )
    
    logging.debug('debug message')
    logging.info('info message')
    logging.warning('warning message')
    logging.error('error message')
    logging.critical('critical message')
    $ python logging_level.py 10
    DEBUG:root:debug message
    INFO:root:info message
    WARNING:root:warning message
    ERROR:root:error message
    CRITICAL:root:critical message
    $ python logging_level 40
    ERROR:root:error message
    CRITICAL:root:critical message

    命名 logging 实例

    #!/usr/bin/env python
    # -*- coding: utf-8 -*-
    import logging
    
    logging.basicConfig(
      level=logging.WARNING
    )
    
    logger1 = logging.getLogger('package1.module1')
    logger2 = logging.getLogger('package2.module2')
    
    logger1.warning('hello 1')
    logger2.warning('hello 2')

    运行脚本后输出:

    WARNING:package1.module1:hello 1
    WARNING:package2.module2:hello 2

    js
    下一篇:没有了