Loguru 安装方式很简单,打开终端输入:
1、即开即用
在Loguru中,如果你需要输出 debug 日志到终端,可以这么做:
- from loguru import logger
- logger.debug("That's it, beautiful and simple logging!")
如果你需要把日志输出到文件,只需要这样:
- from loguru import logger
- logger.add("file_{time}.log")
- logger.debug("That's it, beautiful and simple logging!")
2、滚动日志与压缩
按时间滚动
比如按时间滚动,我们只需要在 logger.add 参数中添加一个 rotation 参数:
- from loguru import logger
- logger.add("file_2.log", rotation="12:00")
- # 每天12:00会创建一个新的文件
- logger.debug("That's it, beautiful and simple logging!")
按大小滚动
除了按时间滚动日志外,Loguru 还可以按日志大小滚动:
- from loguru import logger
- logger.add("file_1.log", rotation="1 MB")
- # 滚动大日志文件
- logger.debug("That's it, beautiful and simple logging!")
这样,一旦日志文件大小超过 1 MB 就会产生新的日志文件。
压缩日志
如果你不想删除原有日志文件,Loguru 还支持将日志直接压缩:
- from loguru import logger
- logger.add("file_Y.log", compression="zip") # 压缩日志
3、其他特性
自定义颜色
Loguru 是支持自定义颜色的,如果你不喜欢它默认的颜色,可以这么改:
- logger.add(sys.stdout, colorize=True, format="{time} {message}")
类似于HTML标签
标签中间的文字将会被标记为绿色。
多进程安全
Loguru 默认情况下是线程安全的,但它不是多进程安全的。不过如果你需要多进程/异步记录日志,它也能支持,只需要添加一个 enqueue 参数:
- logger.add("somefile.log", enqueue=True)
支持Backtrace
对于日志而言,没有错误堆栈的日志是没有灵魂的。Loguru 允许显示整个堆栈信息来帮助你发现问题(包括变量)。
比如下面这个例子:
- logger.add("out.log", backtrace=True, diagnose=True) # Caution, may leak sensitive data in prod
- def func(a, b):
- return a / b
- def nested(c):
- try:
- func(5, c)
- except ZeroDivisionError:
- logger.exception("What?!")
- nested(0)
非常清晰明了。
邮件告警
Loguru 可以和强大的邮件通知模块 notifiers 库结合使用,以在程序意外失败时接收
电子邮件,或发送许多其他类型的通知。
- import notifiers
- params = {
- "username": "you@gmail.com",
- "password": "password",
- "to": "dest@gmail.com"
- }
- # 初始化时发送一封邮件
- notifier = notifiers.get_notifier("gmail")
- notifier.notify(message="The application is running!", **params)
- # 发生Error日志时,发邮件进行警报
- from notifiers.logging import NotificationHandler
- handler = NotificationHandler("gmail", defaults=params)
- logger.add(handler, level="ERROR")
这样配置之后,每次产生 Error 日志,程序都会自动向你的邮箱发送告警,真的极其方便。
除了这些特性外,Loguru 还支持与 Python 原生的 Logging 模块兼容使用,你可以将原始的标准日志记录器记录的所有信息转移到Loguru中。