Logging#

Logger#

当在import logging的时候就创建了全局的单例logging.root，之后通过logging.getlogger()获得的所有logger都是root的子logger。logger的层级也是用name字段来区分的。 logging模块创建的所有的logger对象全部是全局单例的，通过name字段区分，所以说完全不需要logger的传递，在所有的模块直接gerlogger你想要的logger就行了，包括logging对象本身就是root logger,随便在哪import了就直接用，包括配置，你可以在刚开始就把后面可能会用到的logger给get出来然后先配置好，然后在别的模块直接调用就行了。这个设计有个问题，就是你要接管别的库的logger，必须要知道他们内置的logger的name，只能去文档查了，大部分库都会有logging板块的，比如uvicorn，这个设计很奇葩，我最开始用这个感觉也太奇葩了点，所以说可以用更现代化的loguru。

Handler #

控制输出位置的，输出到哪里都行，用docker的话还是统一放到stdout就行了。

Formatter #

可以把logrecord的字段通过格式字符串（有点像c的那种），输出成你想要的字符串。

Filter #

可以在这里对进入这个过滤器的LogRecord进行逻辑处理，包括增加字段，检查字段过滤等等。

LogRecord #

logger.info(msg)函数发射的日志记录本体，他会通过一个个logger向上传递，里面有着很多字段，具体看这个表，通过这个，再在formatter可以控制输出格式和字段。

架构网络#

logger和handler是多对多的，并且一个logger可以有多个handler。handler和filter也是多对多的，并且一个handler可以连上多个filter顺序执行，filter和logger也是多对多的。filter在handler上和在logger上的处理的LogRecord作用域不同。handler和formatter是多对一的。

工程实践#

配置#

工程上我们会在项目启动的刚开始载入下面这个配置的字典来，配置日志系统，通过logging.config.dictConfig(dict)来加载这个字典

1
class TraceIDFilter(logging.Filter):
2
    def filter(self, record):
3
        record.trace_id = trace_id_var.get()
4
        return True
5
LOGGING_CONFIG = {
6
    "version": 1,
7
    "disable_existing_loggers": False,
8
    "formatters": {
9
        "standard_format": {
10
            "format": "%(levelname)-8s | %(asctime)s | %(name)s | %(trace_id)s | %(message)s",
11
        },
12
        "systemd_format": {
13
            "format": "%(levelname)-8s | %(asctime)s | %(name)s | %(message)s",
14
        },
15
    },
16
    "filters": {
17
        "trace_filter": {"()": "app.core.logging_config.TraceIDFilter"},#这个过滤器实际上就是让所有的LogRecord经过TraceIDFilter这个函数统一处理加上trace_id这个字段
18
    },
19
    "handlers": {
20
        "console": {
21
            "class": "logging.StreamHandler",
22
            "formatter": "standard_format",
23
            "filters": ["trace_filter"],
24
            "stream": "ext://sys.stdout",
25
        },
26
        "uvicorn_output": {
27
            "class": "logging.StreamHandler",
28
            "formatter": "systemd_format",
29
            "stream": "ext://sys.stdout",
30
        },
31
    },
32
    "loggers": {
33
        "": {  #""表示根logger
34
            "handlers": ["console"],
35
            "level": "INFO",
36
        },
37
        "uvicorn.access": {
38
            "handlers": [], #覆盖uvicorn原生的logging，让他统一传到uvicorn节点输出
39
            "propagate": True,
40
        },
41
        "uvicorn.error": {
42
            "handlers": [],  #覆盖uvicorn原生的logging，让他统一传到uvicorn节点输出
43
            "propagate": True,
44
        },
45
        "uvicorn": {
46
            "handlers": ["uvicorn_output"],  # 统一输出，并不传到root节点
47
            "propagate": False,
48
        },
49
    },
50
}