python logging模块

Posted 2021-02-15 zt0903

logging模块很多程序都有记录日志的需求，并且日志中包含的信息即有正常的程序访问日志，还可能有错误、警告等信息输出，python的logging模块提供了标准的日志接口，你可以通过它存储各种格式的日志，

logging的日志可以分为 debug(), info(), warning(), error() and critical()5个级别
CRITICAL = 50
FATAL = CRITICAL
ERROR = 40
WARNING = 30
WARN = WARNING
INFO = 20
DEBUG = 10
NOTSET = 0

import logging
 
logging.warning("user [alex] attempted wrong password more than 3 times")
logging.critical("server is down")
 
#输出
WARNING:root:user [alex] attempted wrong password more than 3 times
CRITICAL:root:server is down

# 把日志写入文件

import logging

logging.basicConfig(filename="logger_file.log",level=logging.DEBUG)     # 将级别大于DEBUG的日志写入文件

logging.basicConfig(filename="logger_file.log",
                    format=‘%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s‘,
                    datefmt="%Y %m %d %H:%M:%S",
                    level=logging.DEBUG)# 自定义日志格式

logging.debug("这是一条debug信息") 
logging.info("这是一条info信息") 
logging.warning("这是一条warning信息") # 不设置级别的话默认之输出warning级别以上的 
logging.error("这是一条error信息") 
logging.critical("这是一条critical信息")

日志同时输出到屏幕和文件

logger提供了应用程序可以直接使用的接口；
handler将(logger创建的)日志记录发送到合适的目的输出；
filter提供了细度设备来决定输出哪条日志记录；
formatter决定日志记录的最终输出格式。

logger

每个程序在输出信息之前都要获得一个Logger。Logger通常对应了程序的模块名，比如聊天工具的图形界面模块可以这样获得它的Logger：
LOG=logging.getLogger(”chat.gui”)
而核心模块可以这样：
LOG=logging.getLogger(”chat.kernel”)

Logger.setLevel(lel):指定最低的日志级别，低于lel的级别将被忽略。debug是最低的内置级别，critical为最高
Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增加或删除指定的handler
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()：可以设置的日志级别

handler

handler对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台，有些Logger可以把信息输出到文件，还有些 Handler可以把信息发送到网络上。如果觉得不够用，还可以编写自己的Handler。可以通过addHandler()方法添加多个多handler
Handler.setLevel(lel):指定被处理的信息级别，低于lel级别的信息将被忽略
Handler.setFormatter()：给这个handler选择一个格式
Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一个filter对象

每个Logger可以附加多个Handler。接下来我们就来介绍一些常用的Handler：
1) logging.StreamHandler
使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。它的构造函数是：
StreamHandler([strm])
其中strm参数是一个文件对象。默认是sys.stderr

2) logging.FileHandler
和StreamHandler类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是：
FileHandler(filename[,mode])
filename是文件名，必须指定一个文件名。
mode是文件的打开方式。参见Python内置函数open()的用法。默认是’a‘，即添加到文件末尾。

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并不会被更名，而是被删除。

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 每天凌晨

filter 固定格式：

class IgnoreBackupLogFilter(logging.Filter):
    """忽略带db backup 的日志"""
    def filter(self, record): #固定写法
        return   "db backup" not in record.getMessage()

import logging
# 同时输出到屏幕和文件，并支持filter

# Filter
class Ignoreinfologfilter(logging.Filter):     # 定义一个filter条件
    def filter(self, record):
        return "warning" not in record.getMessage()


# streamHandler&FileHandler                     # 创建 streamhandler 和 filehandler
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
fh = logging.FileHandler("logger_file",encoding="utf-8")
# fh.setLevel(logging.WARNING)

# formatter                                     # 设置formatter 并加入到streamhandler 和 filehandler
formatter = logging.Formatter("%(asctime)s %(name)s %(levelname)s %(message)s")
ch.setFormatter(formatter)
fh.setFormatter(formatter)

# logger                                       # 创建一个logger对象
logger = logging.getLogger("logger")
logger.setLevel(logging.DEBUG)                  # 设置logger对象级别
logger.addHandler(ch)                          # 将streamhandler加入logger
logger.addHandler(fh)                          # 将filehandler加入logger
logger.addFilter(Ignoreinfologfilter())        # 将filter 加入logger

logger.debug("这是一条debug信息")
logger.info("这是一条info信息")
logger.warning("这是一条warning信息")
logger.error("这是一条error信息")
logger.critical("这是一条critical信息")

# 文件自动截断
import logging
from logging import handlers                            # 导入logging里的handles模块
logger = logging.getLogger(__name__)
fh1 = handlers.RotatingFileHandler(filename="time_log.log", mode="a", maxBytes=100,
                                   backupCount=5,encoding="utf-8",delay=False)       # 定义一个以文件大小自动截断的handles
# fh2 = handlers.TimedRotatingFileHandler(filename="time_log.log", when="h",
#                                         interval=1, backupCount=5,encoding="utf-8",
#                                         delay=False,atTime=None,utc=False)          # 定义一个以时间自动截断的handles
formatter = logging.Formatter("%(asctime)s-%(name)s-%(lineno)d-%(message)s")
fh1.setFormatter(formatter)
# fh2.setFormatter(formatter)


logger.addHandler(fh1)
# logger.addHandler(fh2)


logger.debug("这是一条debug信息")
logger.info("这是一条info信息")
logger.warning("这是一条warning信息")
logger.error("这是一条error信息")
logger.critical("这是一条critical信息")

import logging
 def my_log():     logger = logging.getLogger("mysql.log")     sh = logging.StreamHandler()     sh.setLevel(logging.ERROR)     formatter = logging.Formatter("%(asctime)s-%(name)s-%(lineno)d-%(message)s")     sh.setFormatter(formatter)     logger.addHandler(sh)     return loggermy_log().error("run one")my_log().error("run two")my_log().error("run three")

"""
实际上logger = logging.getLogger(‘mysql.log‘)在执行时，没有每次生成一个新的logger，而是先检查内存中是否存在一个叫做‘mysql.log’的logger对象，存在则取出，不存在则新建。
实例化的logger对象具有‘handlers’这样一个属性来存储 Handler
logger.handlers最初是一个空列表，执行‘logger.addHandler(ch)’添加个‘StreamHandler’，输出一条日志
在第二次被调用时，logger.handlers已经存在一个‘StreamHandler’，再次执行‘logger.addHandler(ch)’就会再次添加一个‘StreamHandler’，此时的logger有两个个‘StreamHandler’，输出两条重复的日志
在第三次被调用时，logger.handlers已经存在两个‘StreamHandler’，再次执行‘logger.addHandler(ch)’就会再次添加一个，此时的logger有三个‘StreamHandler’，输出三条重复的日志
"""
# 解决办法
# 1. 改名换姓,将logger对象名添加到函数参参数中
import logging
def my_log(name):
    logger = logging.getLogger(name)
    sh = logging.StreamHandler()
    sh.setLevel(logging.ERROR)
    formatter = logging.Formatter("%(asctime)s-%(name)s-%(lineno)d-%(message)s")
    sh.setFormatter(formatter)
    logger.addHandler(sh)
    return logger


my_log("my_sql1").error("run one")
my_log("my_sql2").error("run two")
my_log("my_sql3").error("run three")
# 2.及时清理
import logging
def my_log():
    logger = logging.getLogger("my_sql.log")
    logger.handlers.clear()
    ch = logging.StreamHandler()
    ch.setLevel(logging.ERROR)
    formatter = logging.Formatter("%(asctime)s-%(name)s-%(message)s")
    ch.setFormatter(formatter)
    logger.addHandler(ch)
    return logger


my_log().error("run one")
my_log().error("run two")
my_log().error("run three")
# 3.用前判断
import logging
def my_log():
    logger = logging.getLogger("my_sql.log")
    if not logger.handlers:
        ch = logging.StreamHandler()
        ch.setLevel(logging.ERROR)
        formatter = logging.Formatter("%(asctime)s-%(name)s-%(message)s")
        ch.setFormatter(formatter)
        logger.addHandler(ch)
    return logger


my_log().error("run one")
my_log().error("run two")
my_log().error("run three")