Python日志处理loguru

python内置logging需要配置繁琐的信息，loguru更加简洁而且内置了日志显示格式，其使用了better-exceptions包。

1 输出日志到文件中

from cmreslogging.handlers import CMRESHandler
from loguru import logger
from pathlib import Path

basepath = Path(__file__).parent.parent
logpath = basepath.joinpath('./logs').resolve()  # 获得文件夹的绝对路径
if not logpath.exists(): #  日志文件夹不存在就新建
    logpath.mkdir()
# 通过as_posix转换成str类型可与字符串相加并且将windows路径中的的 \转成unix的/
logger.add(logpath.as_posix() + './test1.log', format="{time:HH:mm:ss:SSSS} | {module} line:{line} {function} |{level} | {message}", level="INFO",encoding='utf-8')
logger.info('test message')

添加add

add方法类似于logging中的logger.addHandler, 其暴露了非常丰富的参数来实现Handler的配置，详细文档。

• format中可以设置相应的格式，通常使用默认值
• level中设置日志的级别
• rotation可以设置以哪种方式切分日志文件，如“100MB”、“1 week”
• rentation可以设置文件的保留时间，如“7 days”
• compression可以配置文件的压缩格式，如“zip”格式
• sink是最重要的参数，可以传入不同的数据类型。

• sink可以传入file句柄，sys.stderr 或者 open('file.log', 'w') 都可以
• sink可以传入字符串或者pathlib.Path对象，如果代表文件路径会自动创建相应路径的日志文件
• sink可以是logging模块的Handler，如FileHandler、StreamHandler等，这就可以实现自定义的Handler配置

add函数源码

移除sink

通过给remove方法传递add方法返回的对象， 可以删除add方法添加的sink，这里的remove并不是删除test2.log文件，而是停止向该文件输出日志，需要需要继续记录日志则需要重新add日志文件。

t = logger.add('test2.log')
logger.info('test2')
logger.remove(t)
#logger.add('test3.log')  需要重新add文件才能记录 newtest2
logger.info('newtest2')

traceback记录

通过logger.catch修饰器实现traceback的记录

@logger.catch
def my_function(x, y, z):
    # An error? It's caught anyway!
    return 1 / (x + y + z)

---

2 将日志输出到Elaticsearch

在某些场景下需要将日志输出到Elaticsearch中，可以使用Kibana可视化地分析日志信息

from cmreslogging.handlers import CMRESHandler
from loguru import logger
es_handler = CMRESHandler(hosts=[{'host': 'localhost', 'port': 9200}],
                          # 可以配置对应的认证权限
                          auth_type=CMRESHandler.AuthType.NO_AUTH,
                          es_index_name='test',  # 不需要提前创建Index
                          # 一个月分一个 Index,默认为按照每天分Index,示例:test-2020.12.02
                          index_name_frequency=CMRESHandler.IndexNameFrequency.MONTHLY,
                          # 额外增加环境标识
                          es_additional_fields={'environment': 'dev'}
                          )

• sink参数传入CMRESHandler的一个对象，不过目前index必须带有时间，也就是说es中的index是es_index_name+index_name_frequency,其中index不需要提前创建也不需要设置mapping，字段都是内置好的，还是很方便的。

可视化分析

• 可以用Kibana做可视化分析，还没试验过

---

3 将日志分别输入到Elaticsearch和文件中

出乎意料的简单，如果想要将日志分别输出到es和文件中，只需要分别add就行了，在其他文件中记录日志只需要导入logger便可。

logger.add('20201203.log')
logger.add(es_handler)

参考

• loguru github
• 崔庆才博客