#PYTHON 之 LOG 日志


  • logging
  • logging模块提供模块级别的函数记录日志
  • 包括四大组件

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(封装了其他组件)
  • loging四大组件直接定制

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
import logging

    LOG_FORMAT = "%(asctime)s=====%(levelname)s++++++%(message)s"

    logging.basicConfig(filename="tulingxueyuan.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.")

输出到tulingxueyuan.log：

python 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 线程名称

字段/属性名称

使用格式

描述

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中产生的毫秒部分，可以用这个加上

2.1 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添加特殊内容
  • 三个参数
  • fmt：指定消息格式化字符串，如果不指定该参数则默认使用message的原始值
  • datefmt：指定日期格式字符串，如果不指定该参数则默认使用"%Y-%m-%d %H:%M:%S"
  • style：Python 3.2新增的参数，可取值为 ‘%’, ‘{‘和 ‘$’，如果不指定该参数则默认使用’%’
  • Filter类
  • 可以被Handler和Logger使用
  • 控制传递过来的信息的具体内容
  • 案例02
1. 需求

    现在有以下几个日志记录的需求：

    1）要求将所有级别的所有日志都写入磁盘文件中
    2）all.log文件中记录所有的日志信息，日志格式为：日期和时间 - 日志级别 - 日志信息
    3）error.log文件中单独记录error及以上级别的日志信息，日志格式为：日期和时间 - 日志级别 - 文件名[:行号] - 日志信息
    4）要求all.log在每天凌晨进行日志切割

    2. 分析

    1）要记录所有级别的日志，因此日志器的有效level需要设置为最低级别--DEBUG;
    2）日志需要被发送到两个不同的目的地，因此需要为日志器设置两个handler；另外，两个目的地都是磁盘文件，因此这两个handler都是与FileHandler相关的；
    3）all.log要求按照时间进行日志切割，因此他需要用logging.handlers.TimedRotatingFileHandler; 而error.log没有要求日志切割，因此可以使用FileHandler;
    4）两个日志文件的格式不同，因此需要对这两个handler分别设置格式器；
    '''

    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')

error.log文件：

python log 配置路径_日志记录_02


all.log文件：

python log 配置路径_日志记录_03