天天看点
返回

【python】内置模块-logging-记录日志相关概念两种记录日志的方式

文章目录

  • 相关概念
    • 支持的日志等级
  • 两种记录日志的方式
    • logging模块级别的函数
    • logging日志系统的四个组件
      • Logger类
      • handler类
      • Formater类
      • Filter类

官方文档：https://docs.python.org/3/library/logging.html

相关概念

支持的日志等级

日志等级 描述
DEBUG 最详细的日志信息，典型应用场景是 问题诊断
INFO 信息详细程度仅次于DEBUG，通常只记录关键节点信息，用于确认一切都是按照我们预期的那样进行工作
WARNING 当某些不期望的事情发生时记录的信息（如，磁盘可用空间较低），但是此时应用程序还是正常运行的
ERROR 由于一个更严重的问题导致某些功能不能正常运行时记录的信息
CRITICAL 当发生严重错误，导致应用程序不能继续运行时记录的信息

两种记录日志的方式

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.exception(msg, *args, **kwargs)

         		创建一条严重级别为error的日志记录,并添加上exception信息

    logging.log(level, *args, **kwargs)

         		创建一条严重级别为level的日志记录

    logging.basicConfig(**kwargs)

         		对root logger进行一次性配置
    其中args参数为包含变量消息中的变量,
    • 示例：

      logging.warning('%s is %d years old.', 'Tom', 10)
    • 结果：

      WARNING:root:Tom is 10 years old.
  • logging.baseConfig()函数参数说明
    参数 说明
    filename 指定日志输出目标文件的文件名（可以写文件名也可以写文件的完整的绝对路径，写文件名日志放执行文件目录下，写完整路径按照完整路径生成日志文件），指定该设置项后日志信心就不会被输出到控制台了
    filemode 指定日志文件的打开模式，默认为’a’。需要注意的是，该选项要在filename指定时才有效
    format 指定日志格式字符串，即指定日志输出时所包含的字段信息以及它们的顺序
    datefmt 指定日期/时间格式。需要注意的是，该选项要在format中包含时间字段%(asctime)s时才有效
    level 指定日志的日志级别
    stream 指定日志输出目标stream，如sys.stdout、sys.stderr以及网络stream。需要说明的是，stream和filename不能同时提供，否则会引发 ValueError异常
    style Python 3.2中新添加的配置项。指定format格式字符串的风格，可取值为’%’、’{‘和’$’，默认为’%’
    handlers Python 3.3中新添加的配置项。该选项如果被指定，它应该是一个创建了多个Handler的可迭代对象，这些handler将会被添加到root logger
    需要说明的是：filename、stream和handlers这三个配置项只能有一个存在，不能同时出现2个或3个，否则会引发ValueError异常
  • logging模块中定义好的可以用于format格式字符串说明
    字段/属性名称 使用格式 描述
    asctime

    %(asctime)s

         		将日志的时间构造成可读的形式，默认情况下是‘2016-02-08 12:00:00,123’精确到毫秒
    name

    %(name)s

         		所使用的日志器名称，默认是’root’，因为默认使用的是 rootLogger
    filename

    %(filename)s

         		调用日志输出函数的模块的文件名； pathname的文件名部分，包含文件后缀
    funcName

    %(funcName)s

         		由哪个function发出的log， 调用日志输出函数的函数名
    levelname

    %(levelname)s

         		日志的最终等级（被filter修改后的）
    message

    %(message)s

         		日志信息， 日志记录的文本内容
    lineno

    %(lineno)d

         		当前日志的行号， 调用日志输出函数的语句所在的代码行
    levelno

    %(levelno)s

         		该日志记录的数字形式的日志级别（10, 20, 30, 40, 50）
    pathname

    %(pathname)s

         		完整路径 ，调用日志输出函数的模块的完整路径名，可能没有
    process

    %(process)s

         		当前进程， 进程ID。可能没有
    processName

    %(processName)s

         		进程名称，Python 3.1新增
    thread

    %(thread)s

         		当前线程,线程ID。可能没有
    threadName

    %(thread)s

         		线程名称
    module

    %(module)s

         		调用日志输出函数的模块名， filename的名称部分，不包含后缀即不包含文件后缀的文件名
    created

    %(created)f

         		当前时间，用UNIX标准的表示时间的浮点数表示； 日志事件发生的时间–时间戳，就是当时调用time.time()函数返回的值
    relativeCreated

    %(relativeCreated)d

         		输出日志信息时的，自Logger创建以来的毫秒数； 日志事件发生的时间相对于logging模块加载时间的相对毫秒数
    msecs

    %(msecs)d

         		日志事件发生事件的毫秒部分。logging.basicConfig()中用了参数datefmt，将会去掉asctime中产生的毫秒部分，可以用这个加上
  • 示例 
import logging

LOG_FORMAT = "%(asctime)s %(name)s %(levelname)s %(pathname)s %(message)s "  # 配置输出日志格式
DATE_FORMAT = '%Y-%m-%d  %H:%M:%S %a '  # 配置输出时间的格式，注意月份和天数不要搞乱了
logging.basicConfig(
    level=logging.DEBUG,
    format=LOG_FORMAT,
    datefmt=DATE_FORMAT,
    filename=r'tst.log'
)
logging.debug("msg1")
logging.info("msg2")
logging.warning("msg3")
logging.error("msg4")
logging.critical("msg5")

logging日志系统的四个组件

  • 组件说明
    组件名称 对应类 功能
    日志器 Logger 提供了应用程序可一直使用的接口
    处理器 Handler 将logger创建的日志记录发送到合适的目的输出
    过滤器 Filter 提供了更细粒度的控制工具来决定输出哪条日志记录，丢弃哪条日志记录
    格式器 Formatter 日志记录的最终输出格式
  • 关系描述
    • 日志器（logger）需要通过处理器（handler）将日志信息输出到目标位置，如：文件、sys.stdout、网络等；
    • 不同的处理器（handler）可以将日志输出到不同的位置；
    • 日志器（logger）可以设置多个处理器（handler）将同一条日志记录输出到不同的位置；
    • 每个处理器（handler）都可以设置自己的过滤器（filter）实现日志过滤，从而只保留感兴趣的日志；
    • 每个处理器（handler）都可以设置自己的格式器（formatter）实现同一条日志以不同的格式输出到不同的地方。

Logger类

  • 常用配置方法
    方法 说明

    Logger.setLevel()

         		设置日志器将会处理的日志消息的最低严重级别

    Logger.addHandler()

     和

    Logger.removeHandler()

         		为该logger对象添加 和 移除一个handler对象

    Logger.addFilter()

     和

    Logger.removeFilter()

         		为该logger对象添加 和 移除一个filter对象
  • 常用创建日志方法
    方法 说明

    Logger.debug()

     ,

    Logger.info()

     ,

    Logger.warning()

     ,

    Logger.error()

     ,

    Logger.critical()

     ,

    Logger.exception()

         		创建一个与它们的方法名对应等级的日志记录

    Logger.log()

         		需要获取一个明确的日志level参数来创建一个日志记录
  • logger对象获取方式
    • 通过logger类实例化方法创建一个示例

    • logging.getLogger()

       ：常用

handler类

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’信息的出现。

Formater类

Formater对象用于配置日志信息的最终顺序、结构和内容

  • 可直接实例化该类实用
  • 继承该类做扩展

Filter类

Filter可以被Handler和Logger用来做比level更细粒度的、更复杂的过滤功能

更过详细内容详见官方文档

Python logging logger Handler 日志
上一篇: Dubbo-Exchanger基本介绍ExchangerHeaderExchangerExchangersExchangeChannel-交换层通道接口HeaderExchangeChannelExchangeClient-交换层客户端接口HeaderExchangeClientExchangeServerHeaderExchangeServer
下一篇: jmeter---http授权管理器

继续阅读