logging——日志

导读
- 很多程序都有记录日志的需求，并且日志中包含的信息即有正常的程序访问日志，还可能有错误、警告等信息输出，python的logging模块提供了标准的日志接口，你可以通过它存储各种格式的日志，logging的日志可以分为 debug(), info(), warning(), error() and critical()5个级别
```
1 import logging
2 logging.warning("user [alex] attempted wrong password more than 3 times")
3 logging.critical("server is down")
4 
5 
6 #output
7 
8 WARNING:root:user [alex] attempted wrong password more than 3 times
9 CRITICAL:root:server is down
```
  简单用法
日志级别，DEBUG为最低级别

Level	When it’s used
`DEBUG`	Detailed information, typically of interest only when diagnosing problems.
`INFO`	Confirmation that things are working as expected.
`WARNING`	An indication that something unexpected happened, or indicative of some problem in the near future (e.g. ‘disk space low’). The software is still working as expected.
`ERROR`	Due to a more serious problem, the software has not been able to perform some function.
`CRITICAL`	A serious error, indicating that the program itself may be unable to continue running.

写日志文件

1 import logging
2 logging.basicConfig(filename = 'example.log',level = logging.INFO)
3 #创建一个'example.log'日志文件，日志级别为INFO
4 logging.debug('This message should go to the log file')#级别低于INFO，不会写入到日志文件中
5 logging.info('So should this')
6 logging.warning('And this, too')
7 
8 
9 #注意：如果运行多次，则会在之前的记录后面追加记录，不会覆盖原有的记录

View Code

自定义日志格式

%(name)s	Logger的名字
%(levelno)s	数字形式的日志级别
%(levelname)s	文本形式的日志级别
%(pathname)s	调用日志输出函数的模块的完整路径名，可能没有
%(filename)s	调用日志输出函数的模块的文件名
%(module)s	调用日志输出函数的模块名
%(funcName)s	调用日志输出函数的函数名
%(lineno)d	调用日志输出函数的语句所在的代码行
%(created)f	当前时间，用UNIX标准的表示时间的浮点数表示
%(relativeCreated)d	输出日志信息时的，自Logger创建以来的毫秒数
%(asctime)s	字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
%(thread)d	线程ID。可能没有
%(threadName)s	线程名。可能没有
%(process)d	进程ID。可能没有
%(message)s	用户输出的消息

1 import logging
2 logging.basicConfig(filename = 'example.log',
3                     level = logging.INFO,
4                     format='%(asctime)s-%(levelno)s-%(levelname)s-%(pathname)s-%(filename)s %(message)s',
5                     datefmt='%m/%d/%Y %I:%M:%S %p')
6 logging.info('So should this')
7 logging.warning('And this, too')

日志格式代码示例

日志同时输出到文件和屏幕
- 知识储备　　
- 如果想同时把log打印到屏幕和日志文件中，需要了解一点复杂的知识。python使用logging模块记录日志涉及四个主要类，使用官方文档的概括最为合适：
  - logger提供应用程序可以直接使用的接口；
  - handler将（logger创建的）日志记录发送到合适的目的输出；
  - filter提供了细度设备来决定输出哪条日志记录；
  - formatter决定日志记录的最终输出格式
- 功能分析
  - logger：每个程序在输出信息之前都要获得一个logger。logger通常对应了程序的模块名，比如聊天工具的图形界面模块可以这样获得它的Logger:
    - LOG = logging.getLogger("chat.gui")　　
    - 核心模块可以：LOG = logging.getLogger("chat.kernel")
    - 还可以绑定handle和filters
    - Logger.setLevel(lel):指定最低的日志级别，低于lel的级别将被忽略。debug是最低的内置级别，critical为最高 Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增加或删除指定的handler
  - handler：handler对象负责发送相关的信息到指定目的地。Python的日志系统有很多种Handle可以使用。有些Handler可以把信息输出到控制台，有些Handler可以把信息输出到文件，还有些Handler可以把信息发送到网络上。如果觉得不够用，还可以编写自己的Handler。可以通过addHandler()方法添加多个多Handler
  - ```
  1 Handler.setLevel(lel):指定被处理的信息级别，低于lel级别的信息将被忽略
  2 Handler.setFormatter()：给这个handler选择一个格式
  3 Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一个filter对象
```
  每个Logger可以附加多个Handler。接下来我们介绍一些常用的Handler：
  - 1.logging.StreamHandler使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象（file object）输出信息
  - 2.logging.FileHandler 和StreamHandler 类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文
  - 3.logging.handlers.RotatingFileHandler
    这个Handler类似于上面的FileHandler，但是它可以管理文件大小。当文件达到一定大小之后，它会自动将当前日志文件改名，然后创建一个新的同名日志文件继续输出。比如日志文件是chat.log。当chat.log达到指定的大小之后，RotatingFileHandler自动把文件改名为chat.log.1。不过，如果chat.log.1已经存在，会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log，继续输出日志信息。它的函数是：
  - 1 RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])
    其中filename和mode两个参数和FileHandler一样。
    - maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。
    - backupCount用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。
  - 4.logging.handlers.TimedRotatingFileHandler
    这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的函数是：
  - 1 TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
    其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。
    
    interval是时间间隔。
    
    when参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值：
    - S 秒
    - M 分
    - H 小时
    - D 天
    - W 每星期（interval==0时代表星期一）
    - midnight 每天凌晨
- formatter：日志的formatter是个独立的组件，可以跟handler组合
- - 1 import logging 2 3 class IgnoreBackupLogFilter(logging.Filter): 4 """忽略带db backup 的日志""" 5 def filter(self, record): #固定写法 6 return "db backup" not in record.getMessage() 7 8 #1.生成logger对象 9 logger = logging.getLogger("Web") 10 logger.setLevel(logging.DEBUG) 11 #1.1把filter对象添加到logger中 12 logger.addFilter(IgnoreBackupLogFilter()) 13 14 #2.生成handler对象 15 ch = logging.StreamHandler() 16 ch.setLevel(logging.INFO) 17 fh = logging.FileHandler("web.log") 18 fh.setLevel(logging.WARNING) 19 #2.1把handler对象绑定到logger对象 20 logger.addHandler(ch) 21 logger.addHandler(fh) 22 23 #3.生成format对象 24 #3.1把formatter对象绑定handler对象 25 file_formatter = logging.Formatter('%(asctime)s %(message)s') 26 console_formatter = logging.Formatter('%(asctime)s %(message)s') 27 ch.setFormatter(console_formatter) 28 fh.setFormatter(file_formatter) 29 30 logger.debug("test ....") 31 logger.info("test info ....") 32 logger.warning("start to run db backup job ....") 33 logger.error("test error ....")
    
    示例

 1 import logging
 2 from logging import handlers
 3 
 4 logger = logging.getLogger(__name__)
 5 log_file = "timelog.log"
 6 fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)
 7 fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)
 8 formatter = logging.Formatter('%(asctime)s %(module)s:%(lineno)d %(message)s')
 9 fh.setFormatter(formatter)
10 logger.addHandler(fh)

View Code