Python - 日志处理(logging模块)

举报
ruochen 发表于 2021/03/25 20:54:32 2021/03/25
【摘要】 Python - 日志处理(logging模块)

LOG

1. 日志相关概念

  • 日志
  • 日志的级别(level)
    • 不同的用户关注不同的程序信息
    • DEBUG
    • INFO
    • NOTICE
    • WARNING
    • ERROR
    • CRITICAL
    • ALERT
    • EMERGENCY
  • IO 操作=>不要太频繁
  • LOG的作用
    • 调试
    • 了解软件的运行情况
    • 分析定位问题
  • 日志信息
    • time
    • 地点
    • level
    • 内容
  • 成熟的第三方
    • log4j
    • log4php
    • logging

2. logging 模块

  • 日志级别
    • 级别可自定义
    • DEBUG
    • INFO
    • WARNING
    • ERROR
    • CRITICAL
  • 初始化/写日志实例需要指定级别,只有当级别等于或高于指定级别才被记录
  • 使用方式
    • 直接使用logging(封装了其他组件)
    • logging四大组件直接定制

2.1 logging 模块级别的日志

  • 使用以下几个函数

    • logging.debug(msg, *args, **kwargs) 创建一条严重级别为DEBUG的日志记录
    • logging.info(msg, *args, **kwargs) 创建一条严重级别为INFO的日志记录
    • logging.warning(msg, *args, **kwargs) 创建一条严重级别为WARNING的日志记录
    • logging.error(msg, *args, **kwargs) 创建一条严重级别为ERROR的日志记录
    • logging.critical(msg, *args, **kwargs) 创建一条严重级别为CRITICAL的日志记录
    • logging.log(level, *args, **kwargs) 创建一条严重级别为level的日志记录
    • logging.basicConfig(**kwargs) 对root logger进行一次性配置
  • logging.basicConfig(**kwargs) 对root logger进行一次性配置

    • 只在第一次调用的时候起作用
    • 不配置logger则使用默认值
      • 输出:sys.stderr
      • 级别:WARNING
      • 格式:level:log_name:content
    • 案例: 01.py
    import logging
    
    LOG_FORMAT = "%(asctime)s=====%(levelname)s+++++%(message)s"
    
    logging.basicConfig(filename="ruochen.log", level=logging.DEBUG, format=LOG_FORMAT)
    
    logging.debug("This is a debug log.")
    logging.info("This is a info log.")
    logging.warning("This is a warning log.")
    logging.error("This is a error log.")
    logging.critical("This is a critical log.")
    
    
    # 另外一种写法
    logging.log(logging.DEBUG, "This is a debug log.")
    logging.log(logging.INFO, "This is a info log.")
    logging.log(logging.WARNING, "This is a warning log.")
    logging.log(logging.ERROR, "This is a error log.")
    logging.log(logging.CRITICAL, "This is a critical log.")
    
    # ruochen.log
    DEBUG:root:This is a debug log.
    INFO:root:This is a info log.
    WARNING:root:This is a warning log.
    ERROR:root:This is a error log.
    CRITICAL:root:This is a critical log.
    DEBUG:root:This is a debug log.
    INFO:root:This is a info log.
    WARNING:root:This is a warning log.
    ERROR:root:This is a error log.
    CRITICAL:root:This is a critical log.
    2019-07-01 09:51:01,181=====DEBUG+++++(message)s
    2019-07-01 09:51:01,181=====INFO+++++(message)s
    2019-07-01 09:51:01,181=====WARNING+++++(message)s
    2019-07-01 09:51:01,181=====ERROR+++++(message)s
    2019-07-01 09:51:01,181=====CRITICAL+++++(message)s
    2019-07-01 09:51:01,181=====DEBUG+++++(message)s
    2019-07-01 09:51:01,181=====INFO+++++(message)s
    2019-07-01 09:51:01,181=====WARNING+++++(message)s
    2019-07-01 09:51:01,182=====ERROR+++++(message)s
    2019-07-01 09:51:01,182=====CRITICAL+++++(message)s
    2019-07-01 09:52:24,155=====DEBUG+++++This is a debug log.
    2019-07-01 09:52:24,155=====INFO+++++This is a info log.
    2019-07-01 09:52:24,155=====WARNING+++++This is a warning log.
    2019-07-01 09:52:24,155=====ERROR+++++This is a error log.
    2019-07-01 09:52:24,155=====CRITICAL+++++This is a critical log.
    2019-07-01 09:52:24,155=====DEBUG+++++This is a debug log.
    2019-07-01 09:52:24,156=====INFO+++++This is a info log.
    2019-07-01 09:52:24,156=====WARNING+++++This is a warning log.
    2019-07-01 09:52:24,156=====ERROR+++++This is a error log.
    2019-07-01 09:52:24,156=====CRITICAL+++++This is a critical log.
    
    • format 参数

      asctime %(asctime)s 日志事件发生的时间–人类可读时间,如:2003-07-08 16:49:45,896
      created %(created)f 日志事件发生的时间–时间戳,就是当时调用time.time()函数返回的值
      relativeCreated %(relativeCreated)d 日志事件发生的时间相对于logging模块加载时间的相对毫秒数(目前还不知道干嘛用的)
      msecs %(msecs)d 日志事件发生事件的毫秒部分
      levelname %(levelname)s 该日志记录的文字形式的日志级别(‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’, ‘CRITICAL’)
      levelno %(levelno)s 该日志记录的数字形式的日志级别(10, 20, 30, 40, 50)
      name %(name)s 所使用的日志器名称,默认是’root’,因为默认使用的是 rootLogger
      message %(message)s 日志记录的文本内容,通过 msg % args计算得到的
      pathname %(pathname)s 调用日志记录函数的源码文件的全路径
      filename %(filename)s pathname的文件名部分,包含文件后缀
      module %(module)s filename的名称部分,不包含后缀
      lineno %(lineno)d 调用日志记录函数的源代码所在的行号
      funcName %(funcName)s 调用日志记录函数的函数名
      process %(process)d 进程ID
      processName %(processName)s 进程名称,Python 3.1新增
      thread %(thread)d 线程ID
      threadName %(thread)s 线程名称

2.2 logging 模块的处理流程

  • 四大组件

    • 日志器(Logger):产生日志的一个接口
    • 处理器(Handler):把产生的日志发送到相应的目的地
    • 过滤器(Filter):更精细的控制哪些日志输出
    • 格式器(Formatter):对输出信息进行格式化
  • logger

    • 产生一个日志
    • 操作
      Logger.setLevel() 设置日志器将会处理的日志消息的最低严重级别
      Logger.addHandler() 和 Logger.removeHandler() 为该logger对象添加 和 移除一个handler对象
      Logger.addFilter() 和 Logger.removeFilter() 为该logger对象添加 和 移除一个filter对象
      Logger.debug: 产生一条debug级别的日志,同理,info,error,等
      Logger.exception(): 创建类似于Logger.error的日志消息
      Logger.log():获取一个明确的日志level参数类创建一个日志记录
    • 如何得到一个logger对象
      • 实例化
      • logging.getLogger()
  • Handler

    • 吧log发送到指定位置

    • 方法

      • setLevel
      • setFormat
      • addFilter,removeFilter
    • 不需要直接使用,Handler是基类

        logging.StreamHandler 	将日志消息发送到输出到Stream,如std.out, std.err或任何file-like对象。
        logging.FileHandler 	将日志消息发送到磁盘文件,默认情况下文件大小会无限增长
        logging.handlers.RotatingFileHandler 	将日志消息发送到磁盘文件,并支持日志文件按大小切割
        logging.hanlders.TimedRotatingFileHandler 	将日志消息发送到磁盘文件,并支持日志文件按时间切割
        logging.handlers.HTTPHandler 	将日志消息以GET或POST的方式发送给一个HTTP服务器
        logging.handlers.SMTPHandler 	将日志消息发送给一个指定的email地址
        logging.NullHandler 	该Handler实例会忽略error messages,通常被想使用logging的library开发者使用来避免'No handlers could be found for logger XXX'信息的出现。
      
  • Format类

    • 直接实例化
    • 可以继承Format添加特殊内容
    • 三个参数
    • 直接实例化
    • 可以继承Format添加特殊内容
    • 三个参数
      • fmt:指定消息格式化字符串,如果不指定该参数则默认使用message的原始值
      • datefmt:指定日期格式字符串,如果不指定该参数则默认使用"%Y-%m-%d %H:%M:%S"
      • style:Python 3.2新增的参数,可取值为 ‘%’, ‘{‘和 ‘$’,如果不指定该参数则默认使用’%’
  • Filter类

    • 可以按Handler和Logger使用
    • 控制传递过来的信息的具体内容
    • 案例02.py
    # 02.py
    '''
    
    1. 需求
    
    现在有以下几个日志记录的需求
    
        1) 要求将所有级别的所有日志都写入磁盘文件
        2) all.log 文件中记录所有的日志信息,日志格式为:日期和时间 - 日志级别 - 日志信息
        3) error.log文件中单独记录error及以上级别的日志信息,日志格式为:日期和时间 - 日志级别 - 文件名[:行号] - 日志信息
        4) 要求all.log在每天凌晨进行日志切割
    '''
    
    import logging
    import logging.handlers
    import datetime
    
    # 定义logger
    logger = logging.getLogger("mylogger")
    logger.setLevel(logging.DEBUG)
    
    # 为两个不同的文件设置不同的Handler
    rf_handler = logging.handlers.TimedRotatingFileHandler("all.log", when='midnight', interval=1, backupCount=7, atTime=datetime.time(0, 0, 0, 0))
    rf_handler.setFormatter(logging.Formatter("%(asctime)s - &(levelname)s - %(message)s"))
    
    f_handler = logging.FileHandler("error.log")
    f_handler.setLevel(logging.ERROR)
    f_handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(filename)s[:%(lineno)d] - %(message)s"))
    
    # 把相应的处理器组装到logger上
    logger.addHandler(rf_handler)
    logger.addHandler(f_handler)
    
    logger.debug('debug message')
    logger.info('info message')
    logger.warning('warning message')
    logger.error('error message')
    logger.critical('critical message')
    
    # all.log
    2019-07-01 10:48:06,878 - &(levelname)s - debug message
    2019-07-01 10:48:06,878 - &(levelname)s - info message
    2019-07-01 10:48:06,878 - &(levelname)s - warning message
    2019-07-01 10:48:06,879 - &(levelname)s - error message
    2019-07-01 10:48:06,879 - &(levelname)s - critical message
    
    # error.log
    2019-07-01 10:48:06,879 - ERROR - 02.py[:36] - error message
    2019-07-01 10:48:06,879 - CRITICAL - 02.py[:37] - critical message
    
【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。