前言:
现时看官们对“python日志分析框架”大致比较重视,同学们都需要知道一些“python日志分析框架”的相关资讯。那么小编在网摘上网罗了一些对于“python日志分析框架””的相关知识,希望咱们能喜欢,各位老铁们一起来了解一下吧!更优雅的 Python 日志解决方案 loguru
Loguru是一个旨在为Python带来愉悦的日志记录库。
官方文档:
loguru 封装脚本
#!/usr/bin/python# -*- coding: utf-8 -*-# pip install loguruimport sysfrom loguru import loggerdef get_logger(log_file=None): """ 日志规则 :param log_file:日志文件名,如为None,则不写入日志文件 :return: """ # 清除之前所有的设置,包括终端打印的设置 logger.remove(handler_id=None) # 添加终端日志输出 logger.add( sink=sys.stdout, level='INFO', # 设置日志最低级别,如果为INFO,则DEBUG日志则不会显示 format="<light-green>{time:YYYY-MM-DD HH:mm:ss}</light-green> | " # 时间,高亮绿显示 "<level>{level:>8}:</level> " # 等级 "<level>{message}</level>", # 日志内容 ) # 如果需要写入文件,则传入文件路径 if log_file: logger.add( sink=log_file, # serialize=True, # 序列化为 json,以 json 格式显示日志的每一行 encoding='utf-8', # 避免中文乱码 rotation="50 MB", # 日志文件大小超过50MB则创建新日志文件 level='DEBUG', # 设置日志最低级别,默认DEBUG format="{time:YYYY-MM-DD HH:mm:ss} | " # 时间 "{level:<8} | " # 等级 "{process.name}:{process.id} | " # 进程名:进程ID "{thread.name}:{thread.id} | " # 线程名:线程ID "{name}.{module}.{function}:{line} - " # 模块名.方法名 "<level>{message}</level>", # 日志内容 ) return loggermy_logger = get_logger('loguru.log')def my_func(): my_logger.debug('这是一个debug级别的信息') my_logger.info('这是一个info级别的信息') my_logger.success('这是一个success级别的信息') my_logger.warning('这是一个warning级别的信息') try: with open('test.log') as f: f.readlines() except: logger.exception('打开文件报错') my_logger.error('这是一个error级别的信息') my_logger.critical('这是一个critical级别的信息')if __name__ == '__main__': my_func()
loguru 详细介绍add 参数说明sink: 用来确定日志的输出路径,sink的选择如下:sink可以传入一个file对象,例如sys.stderr或者open('file.log','w')都可以;sink可以直接传入一个str字符串或者pathlib.Path对象,其实就是代表文件路径的,如果识别到是这种类型,它会自动创建对应路径的日志文件并将日志数据输入进去;sink可以是一个方法,可以自行定义输出实现;sink还可以是一个自定义的类。具体的实现规范可以参见官方文档;level: 标志日志的级别,低于该级别的日志将不会输出,如下图,值越小的日志级别越低级别值方法TRACE5logger.trace()DEBUG10logger.debug()INFO20logger.info()SUCCESS25logger.success()WARNING30logger.warning()ERROR40logger.error()CRITICAL50logger.critical()format: 格式化输出日志信息取值作用elapsed从程序开始经过的时间差exception格式化异常(如果有),否则为Noneextra用户绑定的属性字典(参见bind())file进行日志记录调用的文件function进行日志记录调用的函数level用于记录消息的严重程度line源代码中的行号message记录的消息(尚未格式化)module进行日志记录调用的模块name进行日志记录调用的__name__process进行日志记录调用的进程名thread进行日志记录调用的线程名time发出日志调用时的可感知的本地时间rotation: 设置日志的生成大小、生成时间、保存最长时间等retention: 指定日志保留时长,通常,一些久远的日志文件,需要周期性的去清除,避免日志堆积,浪费存储空间compression: 配置文件压缩格式,比如使用 zip 文件格式保存serialize: 希望输出类似于Json-line格式的结构化日志,可以通过 serialize 参数,将日志信息序列化的json格式写入log 文件,最后可以将日志文件导入类似于MongoDB、ElasticSearch 中用作后续的日志分析仅输出到命令行
# pip install logurufrom loguru import loggerlogger.debug('这是一个debug级别的信息')logger.info('这是一个info级别的信息')logger.warning('这是一个warning级别的信息')logger.error('这是一个error级别的信息')logger.critical('这是一个critical级别的信息')终端日志输出
loguru 默认以时间,级别,函数名,模块名,行号,信息的顺序来输出日志。
同时输出到文件
from loguru import logger# 输出日志到文件(下图日志文件上部分)# logger.add('loguru.log')# 自定义格式输出到日志格式,在 add 中配置的格式只对写入日志文件的内容生效,命令行仍不变(下图日志文件下部分)logger.add('loguru.log', format='[{time}] [{level}]: {message}')logger.debug('这是一个debug级别的信息')logger.info('这是一个info级别的信息')logger.warning('这是一个warning级别的信息')logger.error('这是一个error级别的信息')logger.critical('这是一个critical级别的信息')日志文件记录
如没使用路径 'loguru.log' ,则会在脚本所在目录创建日志文件。也可以在日志路径中添加时间:
logger.add('loguru_{time}.log', format='[{time}] [{level}]: {message}')# 则会生成类似 loguru_2023-02-13_19-45-41_059677.log 的日志文件
format中的{time}修改为{time:YYYY-MM-DD HH:mm:ss},那么时间会自动处理成2023-02-13 20:16:09
日志转存/保留/压缩
用了 loguru 还可以非常方便地使用 rotation 配置,比如想一天输出一个日志文件,或者文件太大了自动分隔日志文件,可以直接使用 add 方法的 rotation 参数进行配置:
# 日志文件转存logger.add("file_1.log", rotation="500 MB") # 当日志文件超过 500MB 时自传转存logger.add("file_2.log", rotation="12:00") # 每天中午创建新的日志文件logger.add("file_3.log", rotation="1 week") # 每一周创建日志文件# 日志文件清理logger.add("file_X.log", retention="10 days") # 自动清理10天之前的日志文件# 日志文件压缩logger.add("file_Y.log", compression="zip") # 使用zip压缩日志文件日志格式化
Loguru 更喜欢更优雅和强大的{}格式化而不是% ,日志记录函数实际上等效于 str.format()。
logger.debug('这是一个debug级别的信息,数据1:{},数据2:{data2}', 'qwe', data2=100)# 2023-02-13 19:59:43.671 | DEBUG | __main__:<module>:8 - 这是一个debug级别的信息,数据1:qwe,数据2:100在线程或主线程中捕获异常用法1
是否遇到程序意外崩溃,而在日志文件中没有看到任何内容?是否注意到线程中发生的异常没有被记录?可以使用catch()装饰器/上下文管理器解决这个问题,该管理器确保任何错误都被正确地传播到日志记录器。
from loguru import loggerlogger.add('loguru.log', format='[{time}] [{level}]: {message}')@logger.catchdef my_function(x, y, z): # 异常捕获 return 1 / (x + y + z)my_function(1, 0, -1)终端日志输出日志文件loguru.log记录用法2
针对exception, Loguru也有专门的分类,且可以很方便的定位到引发错误的行。
from loguru import loggerlogger.add('loguru.log')try: if test: print('test')except NameError: logger.exception('异常')那么在终端和日志文件中将出现下方的异常捕获自定义颜色
如果终端兼容,Loguru会自动为日志添加颜色。可以自定义定义自己喜欢的样式。
import sysfrom loguru import logger# logger 默认包含终端打印功能,清除终端打印功能logger.remove(handler_id=0)# 清除之前所有的设置,包括终端打印的设置# logger.remove(handler_id=None)# 添加自定义的终端打印logger.add(sys.stdout, colorize=True, format="<green>{time:YYYY-MM-DD HH:mm:ss}</green> <level>{message}</level>")logger.info('这是一个info级别的信息')logger.warning('这是一个warning级别的信息')如果不添加logger.remove(handler_id=0),则一条日志会输出两行,因为默认有终端打印功能。清除默认的终端打印功能后正常。不同级别分别记录
将warning以及warning以上级别的log,打印到屏幕同时也记录到文件,warning以下的级别只打印不记录文件。
# 清除之前所有的设置,包括终端打印的设置logger.remove(handler_id=None)cmd_log = logger.add(sys.stdout) #终端打印file_log = logger.add("loguru.log" , level="WARNING") # 文件保存,最低记录级别为WARNINGlogger.info("info日志,打印到终端,不保存到文件")logger.error("error日志,打印到终端,且保存到文件")配置日志过滤规则
我们通过实现自定义方法error_only,判断日志级别,当日志级别为ERROR,返回TRUE,我们在add方法设置filter参数时,设置为error_only,即可过滤掉ERROR以外的所有日志 。
from loguru import loggerdef error_only(record): """ 若日志级别为ERROR, 输出TRUE """ return record["level"].name == "ERROR"# ERROR以外级别日志被过滤掉logger.add("loguru.log", filter=error_only)logger.warning('这是一个warning级别的信息')logger.error('这是一个error级别的信息')logger.critical('这是一个critical级别的信息')同一个项目不同模块日志
import sysfrom loguru import loggerlogger.remove(handler_id=None)cmd_log = logger.add(sys.stdout) # 添加终端打印# 日志文件,在filter中设置仅针对record name == "module1"的实例化对象。file_log_module1 = logger.add("module1.log", level='INFO', filter=lambda record: record["extra"].get("name") == "module1", enqueue=True)# 日志文件,在filter中设置仅针对record name == "module2"的实例化对象。file_log_module2 = logger.add("module2.log", level='INFO', filter=lambda record: record["extra"].get("name") == "module2", enqueue=True)bind_log_module1 = logger.bind(name="module1")bind_log_module2 = logger.bind(name="module2")bind_log_module1.info("打印+保存 module1.log")bind_log_module2.info("打印+保存 module2.log")# 以上执行后,会输出# 2023-02-13 20:54:47.625 | INFO | __main__:<module>:27 - 打印+保存 module1.log# 2023-02-13 20:54:47.627 | INFO | __main__:<module>:28 - 打印+保存 module2.log# 同时module1.log中记录# 2023-02-13 20:54:47.625 | INFO | __main__:<module>:27 - 打印+保存 module1.log# module2.log中记录# 2023-02-13 20:54:47.627 | INFO | __main__:<module>:28 - 打印+保存 module2.log
enqueue=True:支持异步且线程和多进程安全。默认情况下,添加到 logger 中的日志信息都是线程安全的。但这并不是多进程安全的,可以通过添加 enqueue 参数来确保日志完整性。 如果想要在异步任务中使用日志记录的话,也是可以使用同样的参数来保证的。并且通过 complete() 来等待执行完成。
标签: #python日志分析框架