Python之日志使用（logging）

2019-10-29  本文已影响0人  老苏GO

一、日志相关概念

日志是一种可以追踪某些软件运行时所发生事情的方法。软件开发人员可以向代码中调用日志记录相关的方法来表明发生了某些事情。一个事件可以用一个可包含可选变量数据的消息来描述。此外，事件也有重要性的概念，这个重要性也可以被称为严重级别(level).

1.日志的作用

通过log的分析，可以方便用户了解系统或软件、应用的运行情况；如果你的应用log足够丰富，也可以分析以往用户的操作行为、类型喜好、地域分布或其他更多信息；如果一个应用的log同时分了多个级别，那么可以轻易地分析得到该应用的健康状况，及时发现问题并快速定位、解决问题，补救损失。
简单来讲，我们通过记录和分析日志可以了解一个系统或软件程序运行情况是否正常，也可以在应用程序出现故障时快速定位问题。比如，做运维的同学，在接收到报警或各种问题反馈后，进行问题排查时通常都会先去看各种日志，大部分问题都可以在日志中找到答案。再比如，做开发的童鞋，可以通过IDE控制台上输出的各种日志进行程序调试。对于运维老司机或者有经验的开发人员，可以快速的通过日志定位问题的根源。可见，日志是非常重要的。
日志的作用主要有以下3点：

如果应用的日志信息足够详细和丰富，还可以用来作用户行为分析，如：分析用户的操作行为、类型喜好、地域分布以及其他更多的信息，由此可以实现改进业务、提高商业利益。

2.日志的等级

我们先来思考下面的两个问题：

在软件开发阶段或部署开发环境时，为了尽可能详细的查看应用程序的运行状态来保证上线后的稳定性，我们可能需要把该应用程序所有的运行日志全部记录下来进行分析，这是非常耗费机器性能的。当应用程序正式发布或在生产环境部署应用程序时，我们通过只需要记录应用程序的异常信息、错误信息等，这样既可以减小服务器的I/O压力，也可以避免我们在排查故障时淹没在日志的海洋里。那么，怎样才能在不改动应用程序代码的情况下实现在不同的环境记录不同详细程度的日志呢？这就是日志等级的作用了，我们通过配置文件指定我们需要的日志等级就可以了。

不同的应用程序所定义的日志等级可能会有所差别，分的详细点的会包含以下几个等级：

3.日志字段信息与日志格式

本节开始问题提到过，一条日志信息对应的是一个事件的发生，而一个事件通常包括以下几个内容：

上面这些都是一条日志记录中可能包含的字段信息，当然还可以包括一些其他信息，如进程ID、进程名称、线程ID、线程名称等。日志格式就是用来定义一条日志记录中包含哪些字段的，且日志格式通常都是可以自定义的。
说明：
输出一条日志时，日志内容和日志级别是需要开发人员明确指定的。对于其他字段信息，只需要是否显示在日志中就可以了。

二、logging模块简介

logging模块定义的函数和类为应用程序和库的开发实现了一个灵活的事件日志系统。logging模块是python的一个标准库模块，由标准库模块提供日志记录API的关键好处是所有python模块都可以使用这个日志记录功能。所有，你的应用日志可以将你自己的日志信息与来自第三方模块的信息整合起来。

1.logging模块的日志级别

logging模块默认定义了以下几个日志等级，它允许开发人员自定义其他日志级别，但是这是不被推荐的，尤其是在开发供别人使用的库时，因为这会导致日志级别的混乱。
日志等级(level)描述
DEBUG：最详细的日志信息，典型应用场景是问题诊断
INFO：信息详细程度仅次于DEBUG，通常只记录关键节点信息，用于确认一切都是按照我们预期的那样进行工作
WARNING：当某些不期望的事情发生时记录的信息(如，磁盘可用空间较低)，但是此时应用程序还是正常运行的
ERROR：由于一个更严重的问题导致某些功能不能正常运行时记录的信息
CRITICAL：当发生严重错误，导致应用程序不能继续运行时继续的信息
开发应用程序或部署开发环境时，可以使用DEBUG或INFO级别的日志获取尽可能详细的日志信息来进行开发或部署调试；应用上线或部署生产环境时，应该使用WARNING或ERROR或CRITICAL级别的日志来降低机器的I/O压力和提高获取错误日志信息的效率。日志级别的指定通常都是在应用程序的配置文件中进行指定的。
说明：

2.logging模块的使用方式介绍

logging模块提供了两种记录日志的方式：

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)函数用于指定“要记录的日志级别”、“日志格式”、“日志输出位置”、“日志文件的打开模式”等信息，其他几个都是用于记录各个级别日志的函数。

logging模块的四大组件

组件及说明
loggers：提供应用程序代码直接使用的接口
handlers：用于将日志记录发送到指定的目的位置
filters：提供更细粒度的日志过滤功能，用于决定哪些日志记录将会被输出(其他的日志记录将会被忽略)
formatters：用于控制日志信息的最终输出格式
说明： logging模块提供的模块级别的那些函数实际上也是通过这几个组件的相关实现类来记录日志的，只是在创建这些类的实例时设置了一些默认值。

三、使用logging提供的模块级别的函数记录日志

回顾下前面提到的几个重要信息：

1.最简单的日志输出

先来试着分别输出一条不同日志级别的日志记录：

import logging

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.")

输出结果：

WARNING:root:This is a warning log.
ERROR:root:This is a error log.
CRITICAL:root:This is a critical log.

2.那么问题来了

问题1：为什么前面两条日志没有被打印出来？

这是因为logging模块提供的日志记录函数所使用的日志器设置的日志级别是WARNING，因此只有WARNING级别的日志记录以及大于它的级别的日志记录被输出了，而小于他的则被丢弃了。

问题2：打印出来的日志信息中各字段表示什么意思？为什么会这样输出?

上面输出结果中每行日志记录的各个字段含义分别是：
日志级别：日志器名称：日志内容
之所以这样输出，是因为logging模块提供的日志记录函数所使用的日志器设置的日志格式默认是BASIC_FORMAT，其值为：
''%(levelname)s:%(name)s:%(message)s"

问题3：如何将日志记录输出到文件中，而不是打印到控制台

因为在logging模块提供的日志记录函数所使用的日志器设置的处理器所指定的日志输出位置默认为：
sys.stderr

问题4：我是怎么知道这些的？

查看这些日志记录函数的实现代码，可以发现：当我们没有提供任何配置信息的时候，这些函数都会去调用logging.basicConfig(kwargs)方法，且不会向该方法传递任何参数。继续查看basicConfig()方法的代码就可以找到上面这些问题的答案了。

问题5：怎么修改这些默认设置呢？

在我们调用这些日志记录函数之前，手动调用一下basicConfig()方法，把我们想设置的内容以参数的形式传递进去就可以了。

3.logging.basicConfig()函数说明

该方法用于为logging日志系统做一些基本配置，方法定义如下：
logging.basicConfig(**kwargs)
该函数可接收的关键字参数如下：
filename：指定日志输出目标文件的文件名，指定该设置项后日志信息就不会被输出到控制台了
filemode：指定日志文件的打开模式，默认为a，需要注意的是，该选项要在filename指定时才有效
format：指定日志格式字符串，即指定日志输出时所包含的字段信息以及他们的顺序。logging模块定义的格式字段下面会列出。
datefmt：指定日期/时间格式。需要注意的是，该选项要在format中包含时间字段%(asctime)s时才有效
level：指定日志器的日志级别
stream：指定日志输出目标stream，如sys.stdout、sys.stderr以及网络stream。需要说明的是，stream和filename不能同时提供，否则会引发ValueError异常
style：python3中新添加的配置项。指定format格式字符串的风格，可取%{$，默认为%
handlers：python3中新添加的配置项。该选项如果被指定，它应该是一个创建了多个handler的可迭代对象，这些handler将会被添加到root logger*。需要说明的是：filename、stream和handlers这三个配置项只能有一个存在，不能同时出现两个以上，否则会引发ValueError异常。

4.logging模块定义的格式字符串字段

我们来列举一下logging模块中定义好的可以用于format格式字符串中字段有哪些：
字段/属性名称-使用格式-描述
asctime：%(asctime)s：日志事件发生的时间--人类可读时间，如：2003-07-08 16:59:59,896
created：%(created)f：日志事件发生的时间--时间戳，就是当时调用time.time()函数返回的值
relativeCreated: %(relatedCreated)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：进程名称，python3.1新增
thread：%(thread)d：线程ID
threadName: %(threadName)s：线程名称

5.经过配置的日志输出

先简单配置下日志器的日志级别

logging.basicConfig(level=logging.DEBUG)

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.")

输出结果：

DEBUG:root:This is a debug log.
INFO:root:This is a info log.
WARNING:root:This is a warning log.
ERROR:root:This is a error log.
CRITICAL:root:This is a critical log.

所有等级的日志信息都被输出了，说明配置生效了。
在配置日志器日志级别的基础上，再配置下日志输出目标文件和日志格式

LOG_FORMAT = "%(asctime)s - %(levelname)s - %(message)s"
logging.basicConfig(filename='my.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.")

此时会发现控制台中已经没有输出日志内容了，但是在python代码文件的相同目录下回生成一个名为'my.log'的日志文件，该文件中的内容为：

2017-05-08 14:29:53,783 - DEBUG - This is a debug log.
2017-05-08 14:29:53,784 - INFO - This is a info log.
2017-05-08 14:29:53,784 - WARNING - This is a warning log.
2017-05-08 14:29:53,784 - ERROR - This is a error log.
2017-05-08 14:29:53,784 - CRITICAL - This is a critical log.

在上面的基础上，我们再来设置下日期/时间格式

LOG_FORMAT = "%(asctime)s - %(levelname)s - %(message)s"
DATE_FORMAT = "%m/%d/%Y %H:%M:%S %p"

logging.basicConfig(filename='my.log', level=logging.DEBUG, format=LOG_FORMAT, datefmt=DATE_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.")

此时会在my.log日志文件中看到如下输出内容：

05/08/2017 14:29:04 PM - DEBUG - This is a debug log.
05/08/2017 14:29:04 PM - INFO - This is a info log.
05/08/2017 14:29:04 PM - WARNING - This is a warning log.
05/08/2017 14:29:04 PM - ERROR - This is a error log.
05/08/2017 14:29:04 PM - CRITICAL - This is a critical log.

掌握了上面的内容之后，已经能够满足我们平时开发中需要的日志记录功能。

6.其他说明

几个要说明的内容：

LOG_FORMAT = "%(asctime)s - %(levelname)s - %(user)s[%(ip)s] - %(message)s"
DATE_FORMAT = "%m/%d/%Y %H:%M:%S %p"

logging.basicConfig(format=LOG_FORMAT, datefmt=DATE_FORMAT)
logging.warning("Some one delete the log file.", exc_info=True, stack_info=True, extra={'user': 'Tom', 'ip':'47.98.53.222'})

输出结果：

05/08/2017 16:35:00 PM - WARNING - Tom[47.98.53.222] - Some one delete the log file.
NoneType
Stack (most recent call last):
  File "C:/Users/wader/PycharmProjects/LearnPython/day06/log.py", line 45, in <module>
    logging.warning("Some one delete the log file.", exc_info=True, stack_info=True, extra={'user': 'Tom', 'ip':'47.98.53.222'})

四、logging模块日志流处理流程

在介绍logging模块的高级用法之前，很有必要对logging模块所包含的重要组件以及其工作流程做个全面、简要的介绍，这有助于我们更好的理解我们所写的代码（将会触发什么样的操作）。

1.logging日志模块四大组件

在介绍logging模块的日志流处理之前，我们先来介绍下logging模块的四大组件：
日志器 Logger：提供了应用程序可一直使用的接口
处理器 Handler：将logger创建的日志记录发送到合适的目的输出
过滤器 Filter：提供了更细粒度的控制工具来决定输出哪条日志记录，丢弃哪条日志记录
格式器 Formatter：决定日志记录的最终输出格式

logging模块就是通过这些组件来完成日志处理的，上面所使用的logging模块级别的函数也是通过这些组件对应的类来实现的。
这些组件之间的关系描述：

简单点说就是：日志器（logger）是入口，真正干活儿的是处理器（handler），处理器（handler）还可以通过过滤器（filter）和格式器（formatter）对要输出的日志内容做过滤和格式化等处理操作。

2.logging日志模块相关类及其常用方法介绍

下面介绍与logging四大组件相关的类：Logger，Handler，Filter，Formatter
Logger类
Logger对象有3个任务要做：

那么，怎样得到一个Logger对象呢？一种方式是通过Logger类的实例化方法创建一个Logger类的实例，但是我们通常都是使用第二种方式--logging.getLogger()方法。
logging.getLogger()方法有一个可选参数name，该参数表示将要返回的日志器的名称标识，如果不提供该参数，则其值为root。若以相同的name参数值多次调用getLogger()方法，将会返回指向同一个logger对象的引用。
关于logger的层级结构与有效等级的说明：

上一篇下一篇

猜你喜欢

热点阅读