函数和常用模块【day06】：logging模块（八）

时间：2022-12-06 04:07:07

本节内容

1、简述

2、简单用法

3、复杂日志输出

4、handler详解

5、控制台和文件日志共同输出

一、简述

　　很多程序都有记录日志的需求，并且日志中包含的信息即有正常的程序访问日志，还可能有错误，警告等信息输出，python的logging模块提供了标准的日志接口，你可以通过它存储各种格式的日志，logging的日志可以分为debug，info，warning，error和critical 5个级别，下面我们就来看看这个日志模块logging怎么用

二、简单用法

1、简单用法

说明：日志级别有五个，分别是：debug，info，warning，error和critical，其中debug级别最低，critical级别最高，级别越低，打印的日志等级越多。

1
2
3
4
5
6
7
8
9
10
11
12
import logging
 
logging.debug("logging debug")
logging.info("logging info")
logging.warning("user [zhangqigao] attempted wrong password more than 3 times")
logging.error("logging error")
logging.critical("logging critical")
 
#输出
WARNING:root:user [zhangqigao] attempted wrong password more than 3 times
ERROR:root:logging error
CRITICAL:root:logging critical

注：从上面可以看出，一个模块默认的日志级别是warning

2、日志级别

看一下这几个日志级别分别代表什么意思，如表：

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.

3、日志写入文件

1
2
3
4
5
6
7
8
9
10
11
import logging
 
logging.basicConfig(filename="catalina.log",level=logging.INFO) #输入文件名，和日志级别
#---日志输出---
logging.debug("logging debug")
logging.info("logging info")
logging.warning("logging warning")
 
#输出到文件中的内容
INFO:root:logging info
WARNING:root:logging warning

注： 这句中的level=loggin.INFO意思是，把日志纪录级别设置为INFO，也就是说，只有比日志是INFO或比INFO级别更高的日志才会被纪录到文件里，所以debug日志没有记录，如果想记录，则级别设置成debug也就是level=loggin.DEBUG

4、加入日期格式

说明：感觉上面的日志格式忘记加上时间啦，日志不知道时间怎么行呢，下面就来加上

1
2
3
4
5
6
7
8
9
10
11
12
13
logging.basicConfig(filename="catalina.log",
                    level=logging.INFO,
                    format='%(asctime)s %(module)s:%(levelname)s %(message)s', #格式请见第5点内容
                    datefmt='%m/%d/%Y %H:%M:%S %p') #需要加上format和datefmt
 
#----日志内容-----
logging.debug("logging debug")
logging.info("logging info")
logging.warning("logging warning")
 
#文件输出
04/11/2017 14:20:22 PM logging_mod:INFO logging info
04/11/2017 14:20:22 PM logging_mod:WARNING logging warning

5、 format的日志格式

%(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、简介

python使用logging模块记录日志涉及的四个主要类：

①logger：提供了应用程序可以直接使用的接口。

②handler：将(logger创建的)日志记录发送到合适的目的输出。

③filter：提供了细度设备来决定输出哪条日志记录。

④formatter：决定日志记录的最终输出格式。

2、logger

①每个程序在输出信息之前都需要获得一个logger。logger通常对应了程序的模块名，比如聊天工具的图形界面模块可以这样获得它的logger：

1
logger = logging.getLogger("chat.gui")

核心模块可以这样写：

1
logger = logging.getLogger("chat.kernel")

②logger.setLevel(lel)

说明：指定最低的日志级别，低于lel的级别将被忽略(debug是最低的内置级别，critical为最高)

1
logger.setLevel(logging.DEBUG)  #设置级别为debug级别

③Logger.addFilter(filt)、Logger.removeFilter(filt)

说明：添加或删除指定的filter

④logger.addHandler(hdlr)、logger.removeHandler(hdlr)

说明：增加或删除指定的handler

1
2
3
logger.addHandler(ch)#添加handler
 
logger.removeHandler(ch) #删除handler

⑤Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()

说明：可以设置的日志级别

1
2
3
4
5
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')

④获取handler个数

1
2
3
4
5
handler_len = len(logger.handlers)
print(handler_len)
 
#输出
1

3、hander

　　handler对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台，有些Logger可以把信息输出到文件，还有些 Handler可以把信息发送到网络上。如果觉得不够用，还可以编写自己的Handler。可以通过addHandler()方法添加多个多handler 。

①Handler.setLevel(lel)

说明：指定被处理的信息级别，低于lel级别的信息将被忽略。

1
2
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

②Handler.setFormatter()

说明：给这个handler选择一个格式

1
2
3
ch_formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") #生成格式
 
ch.setFormatter(ch_formatter) #设置格式

③Handler.addFilter(filt)、Handler.removeFilter(filt)

说明：新增或删除一个filter对象

四、handler详解

1、logging.StreamHandler

说明：使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息，也就是屏幕输出。

它的构造函数是：StreamHandler([strm])，其中strm参数是一个文件对象，默认是sys.stderr。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
import logging
 
logger = logging.getLogger("TEST-LOG")
logger.setLevel(logging.DEBUG)
 
ch = logging.StreamHandler() #创建一个StreamHandler对象
ch.setLevel(logging.DEBUG) #设置输出StreamHandler日志级别
 
ch_formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
ch.setFormatter(ch_formatter)  #设置时间格式
logger.addHandler(ch)
 
# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')
 
#输出
2017-04-11 16:42:49,764 - TEST-LOG - DEBUG - debug message
2017-04-11 16:42:49,764 - TEST-LOG - INFO - info message
2017-04-11 16:42:49,764 - TEST-LOG - WARNING - warn message
2017-04-11 16:42:49,765 - TEST-LOG - ERROR - error message
2017-04-11 16:42:49,765 - TEST-LOG - CRITICAL - critical message

2、logging.FileHandler

说明：和StreamHandler类似，用于向一个文件输出日志信息，不过FileHandler会帮你打开这个文件。

它的构造函数是：FileHandler(filename[,mode])。filename是文件名，必须指定一个文件名。mode是文件的打开方式。参见Python内置函数open()的用法。默认是’a'，即添加到文件末尾。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import logging
 
#create logging
logger = logging.getLogger("TEST-LOG")
logger.setLevel(logging.DEBUG)
 
fh = logging.FileHandler("debug.log",encoding="utf-8") #日志输出到debug.log文件中
fh.setLevel(logging.INFO) #设置FileHandler日志级别
 
fh_formatter = logging.Formatter("%(asctime)s %(module)s:%(levelname)s %(message)s")
 
fh.setFormatter(fh_formatter)
 
logger.addHandler(fh)
 
# 'application' code
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')
 
#输出到文件中
2017-04-11 17:09:50,035 logging_screen_output:INFO info message
2017-04-11 17:09:50,035 logging_screen_output:WARNING warn message
2017-04-11 17:09:50,035 logging_screen_output:ERROR error message
2017-04-11 17:09:50,035 logging_screen_output:CRITICAL critical message

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，继续输出日志信息。

它的构造函数是：RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])，其中filename和mode两个参数和FileHandler一样。

maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。

backupCount用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import logging
from logging import handlers  #需要导入handlers
 
logger = logging.getLogger(__name__)
log_file = "timelog.log"
 
#按文件大小来分割，10个字节，保留个数是3个
fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)
formatter = logging.Formatter('%(asctime)s %(module)s:%(lineno)d %(message)s')
fh.setFormatter(formatter)
logger.addHandler(fh)
 
logger.warning("test1")
logger.warning("test12")
logger.warning("test13")
logger.warning("test14")

4、logging.handlers.TimedRotatingFileHandler

说明：这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。

它的构造函数是：TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])，其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。

interval是时间间隔。when参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值：①S：秒②M：分③H：小时④D：天⑤W ：每星期（interval==0时代表星期一）⑥midnight：每天凌晨

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import logging
from logging import handlers
import time
 
logger = logging.getLogger(__name__)
log_file = "timelog.log"
#按时间来分割文件，按5秒一次分割，保留日志个数是3个
fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)
formatter = logging.Formatter('%(asctime)s %(module)s:%(lineno)d %(message)s')
fh.setFormatter(formatter)
logger.addHandler(fh)
 
logger.warning("test1")
time.sleep(2)
logger.warning("test12")
time.sleep(2)
logger.warning("test13")
time.sleep(2)
logger.warning("test14")
logger.warning("test15")

五、控制台和文件日志共同输出

需要什么样的输出，只需要添加相应的handler就ok了。

1、逻辑图

函数和常用模块【day06】：logging模块（八）

2、代码如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
import logging
 
#create logging
logger = logging.getLogger("TEST-LOG")
logger.setLevel(logging.DEBUG)
 
#屏幕handler
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
 
#文件handler
fh = logging.FileHandler("debug.log",encoding="utf-8")
fh.setLevel(logging.INFO)
#分别创建输出日志格式
ch_formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
fh_formatter = logging.Formatter("%(asctime)s %(module)s:%(levelname)s %(message)s")
#设置handler的输出格式
ch.setFormatter(ch_formatter)
fh.setFormatter(fh_formatter)
#添加handler
logger.addHandler(ch)
logger.addHandler(fh)
 
# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')

注：如果添加时间分割或者文件大小分割，再添加handler即可。添加方式请见第4节中的3、4点。

相关文章