Loguru--日志记录神器

于 2024-07-01 22:52:26 发布
阅读量1k 收藏 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
关注
专栏目录
Python日志库Loguru教程（最人性化的Python日志模块）
The best way to predict the future is to invent it.
06-09 1643
Loguru的基本使用介绍。 python自带的logging模块，需要完成复杂的配置才能很好的使用，基本生产环境都需要进行二次包装。 loguru专门梳理了这方面的问题，可以通过简单直接的配置完成你的需求。
Loguru，一个 Python 日志神器
最新发布
小鸿的博客
06-06 175
一个简单的库，也许能够开启我们的智慧之门， 一个普通的方法，也许能在危急时刻挽救我们于水深火热， 一个新颖的思维方式，也许能激发我们无尽的创造力， 一个独特的技巧，也许能成为我们的隐形盾牌…… 神奇的 Python 库之旅，第 8 章
Python日志记录库——loguru
酒酿小圆子呀～
02-27 6302
在 Python 中用到日志记录，那就不可避免地会用到内置的 logging标准库。虽然logging 库采用的是模块化设计，你可以设置不同的 handler 来进行组合，但是在配置上通常较为繁琐；而且如果不是特别处理，在一些多线程或多进程的场景下使用 logging还会导致日志记录会出现错乱或是丢失的情况。Python 日志记录工具logging标准库logging的替代品是loguru，loguru使用起来就简单的多。
Python logging库
u010170039的博客
04-29 1523
Python logging库1. logging 简介2. Basic logging Tutorial2.1 使用logging 屏幕打印2.2 使用logging 保存文件2.3 多个模块loggingAdvanced Logging TutorialReference 1. logging 简介 logging是一种跟踪某些软件运行时发生的事件的方法。 软件开发人员可以将logging添加到他们的代码中，以表明某些事件已经发生。 这个事件可以由打印信息描述，该信息中可以包含变量。 开发者也可以赋予事
Loguru — Python 记录日志居然能这么强大而简单？
Python实用宝典网
03-04 1484
Loguru一个能彻底解放你的日志记录器。它即插即用，具备多种方式滚动日志、自动压缩日志文件、定时删除等功能。除此之外，多线程安全、高亮日志、日志告警等功能也不在话下。下面就给大家介绍一...
swift-WPLogOutputer离线日志打印神器
08-15
《Swift-WPLogOutputer：离线日志打印神器》 在iOS开发过程中，日志输出是调试程序、排查问题的重要手段。然而，当Xcode未运行或者在真机上进行离线调试时，我们往往难以获取到实时的日志信息，这给开发者带来了...
尚硅谷公开课第37季-模块化打包神器--webpack
07-22
教程名称： 尚硅谷公开课第37季-模块化打包神器--webpack 资源太大，传百度网盘了，链接在附件中，有需要的同学自取。
必备神器->MYSQL高版本提权工具-V 2011
01-19
必备神器->MYSQL高版本提权工具-V 2011
资源搜索神器软件-混合网盘搜索神器-混合盘.zip
09-02
资源搜索神器软件_混合网盘搜索神器_混合盘
Python-Logbook一个很酷的logging库用来替换Python内置logging库
08-10
Logbook-一个很酷的logging库,用来替换Python 内置logging库
Python-daiquiri轻松设置基本的日志功能的Python库
08-10
daiquiri -- 轻松设置基本的日志功能的Python库
Python日志库logging总结(最全的版本)
Chelseady的博客
09-02 3217
转自：https://cloud.tencent.com/developer/article/1354396 1、日志级别 Python 标准库 logging 用作记录日志，默认分为六种日志级别（括号为级别对应的数值），NOTSET（0）、DEBUG（10）、INFO（20）、WARNING（30）、ERROR（40）、CRITICAL（50）。我们自定义日志级别时注意不要和默认的日志...
python 日志模块loguru
cxm19830125的专栏
03-06 197
1.封装类 from loguru import logger import os import time import sys class logHandle: def __init__(self): self.apath = os.path.abspath(os.path.dirname(__file__)) parent = os.path.dirname(os.path.realpath(__file__)) garder = os.pa...
Loguru基础教程
JarvisGreat的博客
12-18 528
Python模块之Loguru基础教程 # Author=Hanosn from loguru import logger # 打印不同类型的日志 logger.debug("debug message") logger.info("info level message") logger.warning("warning level message") logger.critical("critical level message") # 日志格式和存入日志级别 logger.add("test.lo
Python日志库logging
qq_40671063的博客
10-08 1171
Python日志库logging
Python日志库logging总结-可能是目前为止将logging库总结的最好的一篇文章
大帅的博客
06-13 835
Python的longing模块就是为了记录日志使用的，而且是线程安全的，以为着使用它完全不用担心因日志模块的异常导致程序崩溃。 1. logging模块的简单使用 import logging logging.basicConfig( level=logging.DEBUG, format="%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s", # 日志的格式 datefmt=" %Y-%
Python方便又强大的日志记录器——loguru
qq_40985985的博客
03-11 2456
Python方便又强大的日志记录器——loguru
Python好用的日志模块
qq_36355119的博客
09-21 3249
一个比较好用的日志模块——————基于文件大小切分，只保留固定个数日志文件 import os import logging import logging.handlers def init_logger(log_file): dir_path = os.path.dirname(log_file) try: if not os.path.exists(dir_...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值