14 - Log日志

LOG

• https://www.cnblogs.com/yyds/p/6901864.html
• 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（封装了其他组件）
  • logging四大组件直接制定

2.1 logging模块级别的日志

• 使用以下几个函数

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

• logging.basicConfig(**kwargs) 对root logger进行一次性配置

  • 只在第一次调用的时候起作用
  • 不配置logger则使用默认值
    • 输出：sys.stderr
    • 级别：WARING以上级别
    • 格式：level:log_name:content

• 案例 01

• logging.basicConfig()参数

    - filename:指定日志输出目标文件的文件名，指定该设置项后日志信心就不会被输出到控制台了
    - filemode:指定日志文件的打开模式，默认为'a'。需要注意的是，该选项要在filename指定时才有效
    - format:指定日志格式字符串，即指定日志输出时所包含的字段信息以及它们的顺序。logging模块
        定义的格式字段下面会列出。
    - 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异常。

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

import logging
LOG_FORMAT = "%(asctime)s====%(levelname)s+++++%(message)s"
logging.basicConfig(filename="tulingxueyuan.log", level=logging.DEBUG, format=LOG_FORMAT)
# 设置级别最低为DEBUG，否则为WARNING
# 无显示可以把filename删除
logging.warning("This is a warning log.")
logging.debug("This is a debug log.")
# 另外一种写法
logging.log(logging.WARNING,"This is a warning log.")
logging.log(logging.DEBUG,"This is a debug log.")

2.1logging模块的处理流程

• 四大组件
  • 日志器（Logger）：产生日志的一个借口
  • 处理器（Handler）：把产生的日志发送到相应的目的地
  • 过滤器（Filter）：更精细的控制哪些日志输出
  • 格式器（Formatter）：对输出信息进行格式化

- logger
    - 产生一个日志
    - 操作
        - Logger.setLevel()：设置日志器将会处理的日志消息的最低严重级别
        - Logger.addHandler()和Logger.removeHandler()：为logge对象添加和移除
        - 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）要求将所有级别的所有日志都写入磁盘文件中

2）all.log文件中记录所有的日志信息，日志格式为：日期和时间 - 日志级别 - 日志信息

3）error.log文件中单独记录error及以上级别的日志信息。日志格式为：日期和时间 - 日志级别 - 文件名[：行号] - 日志信息

4）要求all.log在每天凌晨进行日志切割

分析

1）要记录所有级别的日志，因此日志器的有效level需要设置为最低级别--DEBUG

2）日志需要被发送到两个不同的目的地，因此需要为日志设置两个handler；另外，两个目的地都是磁盘文件，因此这两个handler都是与FileHandler

3）all.log要求按照时间进行日志切割，因此他需要用logging.handlers.TinedRotatingFileHandler；而error.log没有要求日志切割

4）两个日志文件的格式不同，因此需要对这两个handler分别设置格式器

# 定义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')