python logging模块详解及其日志定时清理方式

目录

• python logging模块及日志定时清理
• 1.创建logger对象
• 2.logging.basicConfig常用样式
• 3.常用handlers的使用
• StreamHandler
• FileHandler
• NullHandler
• WatchedFileHpythonandler
• RotatingFileHandler
• TimedRotatingFileHandler
• 其他handler
• handler参数配置
• 总结

python logging模块及日志定时清理

1.创建logger对象

logger = logging.getLogger(log_name) # 传入logger名字

2.logging.编程客栈basicConfig常用样式

logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                    datefmt='%a, %d %b %Y %H:%M:%S',
                    filename='./Log/test_log.log',
                    filemode='a')

日志等级说明：

• DEBUG：程序调试bug时使用
• INFO：程序正常运行时使用
• WARNING：程序未按预期运行时使用，但并不是错误，如:用户登录密码错误
• ERROR：程序出错误时使用，如:IO操作失败
• CRITICAL：特别严重的问题，导致程序不能再继续运行时使用，如:磁盘空间为空，一般很少使用

日志等级从低到高的顺序是: DEBUG < INFO < WARNING < ERROR < CRITICAL

3.常用handlers的使用

StreamHandler

流handler——包含在logging模块中的三个handler之一。

能够将日志信息输出到sys.stdout, sys.stderr 或者类文件对象（更确切点，就是能够支持write()和flush()方法的对象）。

只有一个参数：

class logging.StreamHandler(stream=None)

日志信息会输出到指定的stream中，如果stream为空则默认输出到sys.stderr。

FileHandler

logging模块自带的三个handler之一。继承自StreamHandler。将日志信息输出到磁盘文件上。

构造参数：

class logging.FileHandler(filename, mode='a', encoding=None, delay=False)

模式默认为append，delay为true时，文件直到emit方法被执行才会打开。默认情况下，日志文件可以无限增大。

NullHandler

空操作handler，logging模块自带的三个handler之一。没有参数。

WatchedFileHandler

位于logging.handlers模块中。用于监视文件的状态，如果文件被改变了，那么就关闭当前流，重新打开文件，创建一个新的流。由于newsyslog或者logrotate的使用会导致文件改变。

这个handler是专门为linux/Unix系统设计的，因为在Windows系统下，正在被打开的文件是不会被改变的。

参数和FileHandler相同：

class logging.handlers.WatchedFileHandler(filename, mode='a', encoding=None, delay=False)

RotatingFileHandler

位于logging.handlers支持循环日志文件。

class logging.handlers.RotatingFileHandler(filename, mode='a', maxBytes=0, backupCount=0, encoding=None, delay=0)

参数maxBytes和backupCount允许日志文件在达到maxBytes时rollover.当文件大小达到或者超过maxBytes时，就会新创建一个日志文件。

上述的这两个参数任一一个为0时，rollover都不会发生。也就是就文件没有maxBytes限制。backupcount是备份数目，也就是最多能有多少个备份。

当前的日志文件大小超过设定的maxBytes时会将当前的日志文件名例a.log后面加上.1的后缀，如a.log.1，并新建一个a.log文件来记录日志信息。

TimedRotatingFileHandler

定时循环日志handler，位于logging.handlers，支持定时生成新日志文件。

class logging.handlers.TimedRotatingFileHandler(filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False)

参数when决定了时间间隔的类型，参数interval决定了多少的时间间隔。

如when=‘D’，interval=2，就是指两天的时间间隔，backupCount决定了能留几个日志文件。

超过数量就会丢弃掉老的日志文件。whejsn的参数决定了时间间隔的类型。

其他handler

SocketHandler、DatagramHandler、SysLogHandler、NtEventHandler、SMTPHandler、MemoryHandler、HTTPHandler

这些handler都不怎么常用，所以具体介绍就请参考官方文档 其他handlers

handler参数配置

如：

class logging.handlers.TimedRotatingFileHandler(filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False)

• when：是一个字符串，用于描述滚动周期的基本单位，字符串的值及意义如下（不区分大小写）：

• interval: 滚动周期，单位有when指定，比如：when=’D’,interval=1，表示每天产生一个日志文件，且清理匹配到的过期文件；
• backupCount: 表示日志文件的保留个数；
• delay:延迟文件创建，直到第一次调用emit()方法创建日志文件
• atTime:在指定的时间（datetime.time格式）创建日志文件。

删除日志文件设置：

# suffix设置，会生成文件名为xxx.2022-02-10.log
log_file_handler.suffix = "%Y-%m-%d.log"  
# extMatch是编译好正则表达式，用于匹配日志文件名后缀,需要注意的是suffix和extMatch一定要匹配的上，如果不匹配，过期日志不会被删除。
log_file_handler.extMatch = re.compile(r"^\d{4}-\d{2}-\d{2}.log$")

suffix和extMatch的格式要相对应,Year-4位,m-2位 以此类推

举例：

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] -- %(remote_addr)s -- requested -- %(url)s -- %(levelname)s -- %(process)s -- %(thread)s -- %(module)s -- %(funcName)s -- %(lineno)d -- %(message)s --\n__________"))

添加到日志处理对象集合

my_logging.addHandler(handle)

关闭日志收集器

my_logging.removeHandler(handler)

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程客栈(www.devze.com)。