Loguru--日志记录神器

最新推荐文章于 2024-07-19 16:36:18 发布
最新推荐文章于 2024-07-19 16:36:18 发布
阅读量919 收藏 8
点赞数 24
分类专栏： 日志记录 文章标签： python 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Xiao20000101/article/details/140111945
版权

Loguru：更为优雅、简洁的Python 日志管理模块

1、安装

  • 使用 pip 安装即可，Python 3 版本的安装如下：
pip3 install loguru

2、使用

（1）简单使用

我们直接通过导入loguru 封装好的logger 类的实例化对象，不需要手动创建 logger，直接进行调用不同级别的日志输出方法：

在生产环境中，常常在不同场景下使用不用的日志类型，用于处理各种问题。 每种类型的日志有一个整数值，表示日志层级，我们成为log level no。 loguru提供了七层日志层级，或者说七种日志类型：

  • TRACE (5): 用于记录程序执行路径的细节信息，以进行诊断。
  • DEBUG (10): 开发人员使用该工具记录调试信息。
  • INFO (20): 用于记录描述程序正常操作的信息消息。
  • SUCCESS (25): 类似于INFO，用于指示操作成功的情况。
  • WARNING (30): 警告类型，用于指示可能需要进一步调查的不寻常事件。
  • ERROR (40): 错误类型，用于记录影响特定操作的错误条件。
  • CRITICAL (50): 严重类型，用于记录阻止核心功能正常工作的错误条件。
from loguru import logger

class TestLoggerView(APIView):
    def get(self, request):
        logger.trace("This is trace message.")
        logger.debug('This is debug information')
        logger.info('This is info information')
        logger.success("This is success message.")
        logger.warning('This is warn information')
        logger.error('This is error information')
        logger.critical("This is critical message.")
        return Response('测试日志')

在这里插入图片描述

请注意，上述输出不包括TRACE级别的日志信息。这是因为Loguru默认使用DEBUG作为其最低日志级别，导致任何严重性低于DEBUG的日志信息都会被忽略。

（2）更改默认级别

如果您想更改默认级别，可以使用下面所示的add()方法的级别参数：

import sys
from loguru import logger

logger.remove(0)
logger.add(sys.stderr, level="INFO")

remove()方法被首先调用，以删除默认处理程序的配置（其ID为0）。然后，add()方法向记录器添加一个新处理程序。该处理程序将记录到标准错误，只记录INFO或更高级别的日志。

我们也可以自定义一个新的类型的日志，并赋予新的日志level no。但是默认的日志level已经够我们使用了，这里就不介绍了。

3、自定义输出日志的格式

（1）普通自定义

在日常使用中，如果默认的输出内容不够，我们也可以自定义日志的输出内容和格式，可以通过add()方法中的格式选项对Loguru生成的日志记录进行重新格式化。

Loguru 中的每条日志记录都是一个 Python 字典，其中包含其时间戳、日志级别等数据，可以使用loguru提供的格式化指令，包括或重新排列每条信息，如下所示：

import sys
from loguru import logger

logger.remove(0)
logger.add(sys.stderr, format="{time} | {level} | {message}")

logger.debug("Happy logging with Loguru!")

（2）json格式输出

除此之外，Loguru还通过其序列化选项支持JSON格式的结构化日志。这样就可以让我们以JSON格式输出日志，机器可以很容易地解析和分析它，因为每条记录中的信息将以键/值对的形式提供。

import sys
from loguru import logger

logger.remove(0)
logger.add(sys.stderr, format="{time:MMMM D, YYYY > HH:mm:ss!UTC} | {level} | {message}", serialize=True)
logger.debug("Happy logging with Loguru!")

json格式的输出：

在这里插入图片描述

4、将日志写入日志文件

（1）简单使用

  • logger 默认采用 sys.stderr 标准错误输出将日志输出到控制台中，假如想要将日志同时输出到其他的位置，比如日志文件，此时我们只需要使用一行代码即可实现。
  • 例如，将日志信息输出到 luffy1.log 文件中，可以这么写：
from loguru import logger

logger.add("D:\PyCharm 2023.2.1\workspace\luffy_api\logs\luffy1.log",rotation="500MB", encoding="utf-8", enqueue=True, retention="10 days")

logger.info('This is info information')
  • 控制台输出

在这里插入图片描述

  • luffy1.log

在这里插入图片描述

（2）使用add函数配置为一个文件

当add函数配置为一个文件时，add方法提供了更多选项来自定义日志文件的处理方式：

  • rotate：指定关闭当前日志文件并创建新文件的条件。此条件可以是 int、datetime 或 str，建议使用 str，因为它更易于阅读。
    • 如果是整数值，它对应于当前文件在创建新文件之前允许保留的最大字节数。
    • 如果是datetime.timedelta 值时，它指示每次旋转的频率，而 datetime.time 指定每个旋转应在一天中发生的时间。
    • 如果是str值，这是上述类型的变体。
  • retention：指定在从文件系统中删除每个日志文件之前如何保留日志。
  • compression：如果设置此选项，日志文件将转换为指定的压缩格式。
  • delay：如果设置为 True，则新日志文件的创建将延迟到推送第一条日志消息。
  • mode， buffering， encoding： 这些参数将被传递给 Python 的 open（） 函数，该函数决定了 Python 将如何打开日志文件。

（3）add函数的其它参数

  • sink：为记录器生成的每条记录指定目的地。默认情况下，它设置为 sys.stderr。
  • level：指定记录器的最低日志级别。
  • format：用于为日志定义自定义格式。
  • filter：用于确定一条记录是否应该被记录。
  • colorize: 采用布尔值并确定是否应启用终端着色。
  • serialize：如果设置为 True，则日志记录以 JSON 格式呈现。
  • backtrace：确定异常跟踪是否应该延伸到捕获错误的点之外，以便于调试。 诊断：确定变量值是否应显示在异常跟踪中。您应该在生产环境中将其设置为 False 以避免泄露敏感信息。
  • diagnose: 确定变量值是否应在异常跟踪中显示。在生产环境中应将其设置为 False，以避免泄露敏感信息。
  • enqueue：启用此选项会将日志记录放入队列中，以避免多个进程记录到同一目的地时发生冲突。
  • catch：如果在记录到指定的接收器时发生意外错误，您可以通过将此选项设置为 True 来捕获该错误。错误将打印到标准错误。

5、将不同类型的日志记录到不同的文件中（add函数中的filter参数）

在上面的配置中，我们讲到，可以使用add函数来配置最小的日志级别，如果我们需要把不同的日志输出到不同的文件中，我们需要使用到filter参数：

import sys
from loguru import logger

def level_filter(level):
    def is_level(record):
        return record["level"].name == level
    return is_level

logger.remove(0)
logger.add("./logs/app.log", filter=level_filter(level="WARNING"))

还可以使用lambda函数直接配置filter参数，一个完整的例子：

from loguru import logger

# 设置不同级别的日志输出文件
logger.add("debug.log", level="DEBUG", rotation="10 MB", filter=lambda record: record["level"].name == "DEBUG")
logger.add("info.log", level="INFO", rotation="10 MB", filter=lambda record: record["level"].name == "INFO")
logger.add("warning.log", level="WARNING", rotation="10 MB", filter=lambda record: record["level"].name == "WARNING")
logger.add("error.log", level="ERROR", rotation="10 MB", filter=lambda record: record["level"].name == "ERROR")
logger.add("critical.log", level="CRITICAL", rotation="10 MB", filter=lambda record: record["level"].name == "CRITICAL")

# 输出不同级别的日志消息
logger.debug("This is a debug message")
logger.info("This is an info message")
logger.warning("This is a warning message")
logger.error("This is an error message")
logger.critical("This is a critical message")

6、异常定位并记录

loguru还提供了非常方便的异常定位功能，可以直接使用catch闭包，然后把抛出异常的位置记录到日志中。

from loguru import logger

logger.add(sink='log.log')

@logger.catch
def my_function(x, y, z):
    return 1 / (x + y + z)

res = my_function(0,0,0)

输出如下：

> File "/var/folders/kb/0pw_yx2n75z8mlyzjk3mwlwc0000gn/T/ipykernel_85315/1609034425.py", line 9, in <module>
    res = my_function(0,0,0)
          └ <function my_function at 0x7fcce2170670>

  File "/var/folders/kb/0pw_yx2n75z8mlyzjk3mwlwc0000gn/T/ipykernel_85315/1609034425.py", line 7, in my_function
    return 1 / (x + y + z)
                │   │   └ 0
                │   └ 0
                └ 0

ZeroDivisionError: division by zero

7、loguru配置模版

folder_ = "./log/"
prefix_ = "polaris-"
rotation_ = "10 MB"
retention_ = "30 days"
encoding_ = "utf-8"
backtrace_ = True
diagnose_ = True

# 格式里面添加了process和thread记录，方便查看多进程和线程程序
format_ = '<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | <level>{level: <8}</level> ' \
            '| <magenta>{process}</magenta>:<yellow>{thread}</yellow> ' \
            '| <cyan>{name}</cyan>:<cyan>{function}</cyan>:<yellow>{line}</yellow> - <level>{message}</level>'

# 这里面采用了层次式的日志记录方式，就是低级日志文件会记录比他高的所有级别日志，这样可以做到低等级日志最丰富，高级别日志更少更关键
# debug
logger.add(folder_ + prefix_ + "debug.log", level="DEBUG", backtrace=backtrace_, diagnose=diagnose_,
            format=format_, colorize=False,
            rotation=rotation_, retention=retention_, encoding=encoding_,
            filter=lambda record: record["level"].no >= logger.level("DEBUG").no)

# info
logger.add(folder_ + prefix_ + "info.log", level="INFO", backtrace=backtrace_, diagnose=diagnose_,
            format=format_, colorize=False,
            rotation=rotation_, retention=retention_, encoding=encoding_,
            filter=lambda record: record["level"].no >= logger.level("INFO").no)

# warning
logger.add(folder_ + prefix_ + "warning.log", level="WARNING", backtrace=backtrace_, diagnose=diagnose_,
            format=format_, colorize=False,
            rotation=rotation_, retention=retention_, encoding=encoding_,
            filter=lambda record: record["level"].no >= logger.level("WARNING").no)

# error
logger.add(folder_ + prefix_ + "error.log", level="ERROR", backtrace=backtrace_, diagnose=diagnose_,
            format=format_, colorize=False,
            rotation=rotation_, retention=retention_, encoding=encoding_,
            filter=lambda record: record["level"].no >= logger.level("ERROR").no)

# critical
logger.add(folder_ + prefix_ + "critical.log", level="CRITICAL", backtrace=backtrace_, diagnose=diagnose_,
            format=format_, colorize=False,
            rotation=rotation_, retention=retention_, encoding=encoding_,
            filter=lambda record: record["level"].no >= logger.level("CRITICAL").no)

logger.add(sys.stderr, level="CRITICAL", backtrace=backtrace_, diagnose=diagnose_,
            format=format_, colorize=True,
            filter=lambda record: record["level"].no >= logger.level("CRITICAL").no)
Xiao20000101
关注
  • 24
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
Loguru，一个 Python 日志神器
小鸿的博客
06-06 711
一个简单的库，也许能够开启我们的智慧之门， 一个普通的方法，也许能在危急时刻挽救我们于水深火热， 一个新颖的思维方式，也许能激发我们无尽的创造力， 一个独特的技巧，也许能成为我们的隐形盾牌…… 神奇的 Python 库之旅，第 8 章
Loguru — Python 记录日志居然能这么强大而简单？
cainiao_python的博客
04-17 441
Loguru一个能彻底解放你的日志记录器。它即插即用，具备多种方式滚动日志、自动压缩日志文件、定时删除等功能。除此之外，多线程安全、高亮日志、日志告警等功能也不在话下。下面就给大家介绍一下这个强大工具的基本使用方法。Loguru 安装方式很简单，打开终端输入：pipinstallloguru即可完成安装。1.即开即用在Loguru中，如果你需要输出 debug 日志...
loguru Python日志
KHOST的博客
11-01 683
安装 这个库的安装方式很简单，直接使用 pip 就可以，我使用 Python 3 版本，安装命令如下： pip3 install loguru 小试牛刀 安装完毕之后，我们就可以使用了，最简单的使用方式： from loguru import logger logger.debug('this is a debug message') 无需任何配置，即取即用。上例是打印一条 debug 级别的日志，输出结果如下： 2021-03-16 22:17:23.640 | DEBUG |
一文掌握python第三方日志模块loguru
qq_38120851的博客
06-28 573
日志神器loguru，loguru 是一个现代的 Python 日志记录库，它旨在提供比标准 logging 模块更简洁、强大和灵活的体验。loguru 通过简化配置、提升性能和增加一些高级功能，如日志文件的自动滚动、颜色化的终端输出等，使得日志处理变得更加高效和愉快。
【Python宝典】强大又简单的记录日志的神器——Loguru
liaozp88的博客
04-04 901
Loguru 一个能彻底解放你的日志记录器。它即插即用，具备多种方式滚动日志、自动压缩日志文件、定时删除等功能。除此之外，多线程安全、高亮日志、日志告警等功能也不在话下。下面就给大家介绍一下这个强大工具的基本使用方法。Loguru 安装方式很简单，打开终端输入：即可完成安装。我们的文章到此就结束啦，如果你喜欢今天的Python 实战教程，请持续关注徐浪老师大讲堂。
flask日志和gunicorn日志合并
studyeboy的专栏
03-01 3083
logging logging框架中主要有四个部分组成： Loggers：可供程序直接调用的接口 Handlers：决定将日志记录分配至正确的目的地 Filters：提供更细粒度的日志是否输出的判断 Formatters：制定最终记录打印的格式布局 logging是作为一个模块被引入的。logging.debug用的是logging模块的方法。logger是用logging.getLogger()生成的，是一个日志对象，logger.debug调用的是logger这个日志对象的方法。在下面的例子中log
一款零配置 python 日志管理神器，安装即用
Python数据挖掘
07-02 563
写了很多年的python日志都是使用内置的logging模块来完成的，使用时都需要经过繁琐的配置。有时候，还可能出现丢失日志的情况，直到loguru的出现。loguru真的是十分的简单的，安装之后直接导入到python代码块中即可直接使用。喜欢记得收藏、关注、点赞。注：技术交流，解惑答疑、资料代码，文末获取1. 安装环境我们还是按照pip的方式来进行安装，默认使用清华大学的镜像站。pip install loguru -i https://pypi.tuna.tsinghua.edu.cn/simple安装
再见Logging ! Python 记录日志该换这个了！
cainiao_python的博客
05-07 342
Loguru一个能彻底解放你的日志记录器。它即插即用，具备多种方式滚动日志、自动压缩日志文件、定时删除等功能。除此之外，多线程安全、高亮日志、日志告警等功能也不在话下。下面就给大家介绍一下这个强大工具的基本使用方法。Loguru 安装方式很简单，打开终端输入：pipinstallloguru即可完成安装。1.即开即用在Loguru中，如果你需要输出 debug 日志...
如何通过pynput与日志记录实现键盘、鼠标的监听行为？
梦在硅谷的博客
11-10 932
此项功能的实现主要是使用了多线程、键盘/鼠标事件监听，最后通过NLTK语言的处理，从而反向推出电脑的操作记录等信息。业务逻辑并不复杂，我们一起来看看吧！ 【阅读全文】 安装相关的第三方库，一是关于监听的处理、二是关于日志的记录模块、三是关于简单的线程处理模块。 1、安装pynput库监控键盘、鼠标事件 2、安装日志处理 将相关的模块导入到代码块中。 # 鼠标键盘监控 from pynput import keyboard, mouse # 日志处理 from loguru import logger
swift-WPLogOutputer离线日志打印神器
08-15
《Swift-WPLogOutputer：离线日志打印神器》 在iOS开发过程中，日志输出是调试程序、排查问题的重要手段。然而，当Xcode未运行或者在真机上进行离线调试时，我们往往难以获取到实时的日志信息，这给开发者带来了...
ytdlp-interface下载神器
10-14
ytdlp-interface下载神器
SCI-HUB文献查找神器
11-07
SCI-HUB文献查找神器是一款专为科研人员设计的软件，主要功能是帮助用户查询和下载SCI（科学引文索引）收录的学术论文。这款神器解决了许多学者在研究过程中遇到的找文献难、下载受限的问题，尤其对于那些需要广泛...
Bakery - GPU Lightmappe 1.9烘焙神器
03-02
Bakery - GPU Lightmappe 1.9烘焙神器 Bakery是一个高端的，流程完善的GPUlightmapper，大大的优化现有的烘焙流程。 ☆注意:需要现代的NvidiaGPU(6xx或更新)和64位Windows(7或更高)。 ☆不支持AMD，不支持mac。 ☆...
python游戏-表白神器
10-24
python游戏-表白神器 仿抖音表白神器 import sys import cfg import random import pygame from tkinter import Tk, messagebox class Button(pygame.sprite.Sprite): def __init__(self, x, y, width, height, ...
华为od机试真题 — 代表团坐车(Python)
学习,你不是一个人在战斗 ～ 961302305（QQ,微信）
07-17 564
【华为od机试真题 】代表团坐车(Python) 某组织举行会议，来了多个代表团同时到达，接待处只有一辆汽车可以同时接待多个代表团，为了提高车辆利用率，请帮接待员计算可以坐满车的接待方案输出方案数量。
【Python如何将字符串连接在一起并使用`join()`方法】
最新发布
qq_36253366的博客
07-19 134
方法是字符串对象的方法，而不是列表或元组等序列类型的方法。因此，你需要先指定一个用作分隔符的字符串，然后调用这个字符串的。方法将字符串连接在一起，你需要首先确保这些字符串被存储在一个序列类型中（如列表或元组），然后调用这个序列的。方法是一个字符串方法，它用于将序列（如列表、元组等）中的元素以指定的字符连接生成一个新的字符串。列表中的所有字符串元素使用空格作为分隔符连接成一个新的字符串。方法，并将你想要作为分隔符的字符串作为参数传递给。方法，并将包含要连接字符串的序列作为参数传递。
Python每日一题：回文数
xiongxiaoxuan的博客
07-16 264
回文数是指正序（从左向右）和倒序（从右向左）读都是一样的整数。例如，121 是回文，而 123 不是。给你一个整数 x ，如果 x 是一个回文整数，返回 true；否则，返回 false。解释：从左向右读, 为 -121。从右向左读, 为 121-。因此它不是一个回文数。先将整数x转化为字符串形式，判断x和它的反转形态是否完全相等。解释：从右向左读, 为 01。需注意：True和False首字母大写！提示：-231
【Python 中的内存管理有哪些优缺点】
qq_36253366的博客
07-19 191
Python中的内存管理是一个复杂而高效的系统，它通过自动化和抽象化的方式极大地简化了程序员的内存管理负担，但同时也存在一些潜在的缺点。
文献管理神器-zotero
10-10
Zotero是一款非常强大的文献管理工具。它可以帮助您轻松保存、组织和引用各种类型的文献资料，包括期刊文章、书籍、报告、网页等。下面是一些关于Zotero的重要特点： 1. 文献收集：Zotero可以将您在网络上找到的文献资料保存到个人库中，只需点击一下即可自动提取文献信息，并将完整的参考文献添加到您的库中。 2. 组织管理：Zotero允许您创建文件夹和子文件夹，将文献资料进行分类和整理。您可以使用标签、关键词等元数据进行进一步的组织和筛选。 3. 引用管理：Zotero与主流的文献引用风格（如APA、MLA、Chicago等）兼容，并且可以根据您需要的引用格式自动为您生成参考文献列表和引用标注。 4. 协作共享：Zotero支持多用户协作，您可以与其他人分享您的文献库，并进行实时协作编辑和评论。 5. 插件扩展：Zotero提供了丰富的插件和扩展程序，可以方便地与浏览器、文字处理软件（如Word、Google Docs等）进行集成，提升您的工作效率。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值