Loguru日志記錄器的安裝方式

Loguru 一個(gè)能徹底解放你的日志記錄器。

它即插即用，具備多種方式滾動(dòng)日志、自動(dòng)壓縮日志文件、定時(shí)刪除等功能。

除此之外，多線(xiàn)程安全、高亮日志、日志告警等功能也不在話(huà)下。

下面就給大家介紹一下這個(gè)強(qiáng)大工具的基本使用方法。

Loguru 安裝方式很簡(jiǎn)單，打開(kāi)終端輸入：

pip install loguru

即可完成安裝。

1.即開(kāi)即用

如果你需要輸出 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!")

這樣就會(huì)在當(dāng)前運(yùn)行的文件夾下生成 file_當(dāng)前時(shí)間.log 的日志文件：

2.滾動(dòng)日志與壓縮

使用 Loguru 我們可輕易地實(shí)現(xiàn)滾動(dòng)日志。

按時(shí)間滾動(dòng)

比如按時(shí)間滾動(dòng)，我們只需要在 logger.add 參數(shù)中添加一個(gè) rotation 參數(shù)：

from loguru import logger
logger.add("file_2.log", rotation="12:00") # 每天12:00會(huì)創(chuàng)建一個(gè)新的文件
logger.debug("That's it, beautiful and simple logging!")

這樣，如果當(dāng)前時(shí)間過(guò)了這個(gè)設(shè)定的時(shí)間，它就會(huì)生成一個(gè)新的日志文件。如果沒(méi)有則使用原來(lái)的日志文件：

如圖所示，過(guò)了設(shè)定的時(shí)間，則將原來(lái)的 file_2.log 重命名，并添加一個(gè)新的 file_2.log 文件。

按大小滾動(dòng)

除了按時(shí)間滾動(dòng)日志外，Loguru 還可以按日志大小滾動(dòng)：

from loguru import logger
logger.add("file_1.log", rotation="1 MB") # 滾動(dòng)大日志文件
logger.debug("That's it, beautiful and simple logging!")

這樣，一旦日志文件大小超過(guò) 1 MB 就會(huì)產(chǎn)生新的日志文件。

壓縮日志

如果你不想刪除原有日志文件，Loguru 還支持將日志直接壓縮：

from loguru import logger
logger.add("file_Y.log", compression="zip") # 壓縮日志

3.其他特性

自定義顏色

Loguru 是支持自定義顏色的，如果你不喜歡它默認(rèn)的顏色，可以這么改：

logger.add(sys.stdout, colorize=True, format="< green >{time}< /green > < level >{message}< /level >")

類(lèi)似于HTML標(biāo)簽 標(biāo)簽中間的文字將會(huì)被標(biāo)記為綠色。

多進(jìn)程安全

Loguru 默認(rèn)情況下是線(xiàn)程安全的，但它不是多進(jìn)程安全的。不過(guò)如果你需要多進(jìn)程/異步記錄日志，它也能支持，只需要添加一個(gè) enqueue 參數(shù)：

logger.add("somefile.log", enqueue=True)

支持Backtrace

對(duì)于日志而言，沒(méi)有錯(cuò)誤堆棧的日志是沒(méi)有靈魂的。Loguru 允許顯示整個(gè)堆棧信息來(lái)幫助你發(fā)現(xiàn)問(wèn)題（包括變量）。

比如下面這個(gè)例子：

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)

日志將會(huì)是這樣的：

非常清晰明了。

郵件告警

Loguru 可以和強(qiáng)大的郵件通知模塊 notifiers 庫(kù)結(jié)合使用，以在程序意外失敗時(shí)接收電子郵件，或發(fā)送許多其他類(lèi)型的通知。

import notifiers

params = {
    "username": "you@gmail.com",
    "password": "abc123",
    "to": "dest@gmail.com"
}

# 初始化時(shí)發(fā)送一封郵件
notifier = notifiers.get_notifier("gmail")
notifier.notify(message="The application is running!", **params)

# 發(fā)生Error日志時(shí)，發(fā)郵件進(jìn)行警報(bào)
from notifiers.logging import NotificationHandler

handler = NotificationHandler("gmail", defaults=params)
logger.add(handler, level="ERROR")

這樣配置之后，每次產(chǎn)生 Error 日志，程序都會(huì)自動(dòng)向你的郵箱發(fā)送告警，真的極其方便。

除了這些特性外，Loguru 還支持與 Python 原生的 Logging 模塊兼容使用，你可以將原始的標(biāo)準(zhǔn)日志記錄器記錄的所有信息轉(zhuǎn)移到Loguru中。