python fastapi + uvicorn 记录日志的最佳实践，结合nb_log

原创已于 2024-01-16 13:59:41 修改

· 6.7k 阅读

4 ·

版权

文章标签：

#fastapi

于 2022-09-06 20:02:00 首次发布

本文档展示了如何在FastAPI应用中结合uvicorn和nb_log库来实现日志记录，特别是针对请求URL和参数的记录。通过定制logging.config.dictConfig，配置控制台和文件日志，包括多进程安全的日志切割。示例代码详细说明了如何设置日志格式、处理器和handler，确保uvicorn的日志在控制台和文件中都有详细记录。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

python fastapi + uvicorn 记录日志的最佳实践，要记录对fastapi什么时候请求了什么url和入参，只需要记录uvicorn命名空间的日志就可以了。

文章使用nb_log 五彩日志来记录web后台的控制台日志 + 多进程安全切割的文件日志。

为什么不能nb_log.get_logger提前设置好相关命名空间的日志formatter和handlers呢?因为他是在函数内部里面运行的
D:\ProgramData\Miniconda3\Lib\site-packages\uvicorn\config.py 函数内部中logging.config.dictConfig配置的,所以需要传递log_config

fastapiweb222.py  文件内容。

from pathlib import Path

from fastapi import FastAPI
import nb_log

app = FastAPI()


@app.get("/")
async def hello_world():
    return "Hello, World!"


LOG_FILE_PATH = '/pythonlogs'
LOGGING_CONFIG: dict = {
    "version": 1,
    "disable_existing_loggers": False,
    "formatters": {
        "default": {
            "()": "uvicorn.logging.DefaultFormatter",
            "fmt": "%(asctime)s %(levelprefix)s %(message)s",  # 这里日志格式加了时间显示
            "use_colors": False,
        },
        "access": {
            "()": "uvicorn.logging.AccessFormatter",
            "fmt": '%(name)s %(asctime)s %(levelprefix)s %(client_addr)s - "%(request_line)s" %(status_code)s',
            # 这里日志格式加了时间显示
        },
    },
    "handlers": {
        "default": {
            "formatter": "default",
            "class": "logging.StreamHandler",
            "stream": "ext://sys.stderr",
        },
        # "default_file": {
        #     "formatter": "default",
        #     "class": "nb_log.handlers.ConcurrentRotatingFileHandler",  # 注意这里是多进程安全切割日志
        #     'filename': Path(LOG_FILE_PATH) / 'uvicorn_default.log',
        #     'maxBytes': 1000 * 1000 * 100,
        #     'backupCount': 3,
        # },
        "default_file": {
            "formatter": "default",
            "class": "nb_log.handlers.BothDayAndSizeRotatingFileHandler",  # 注意这里是多进程安全切割日志
            'file_name': 'uvicorn_default.log',
            'log_path': LOG_FILE_PATH,
            'max_bytes': 1000 * 1000 * 1000,
            'back_count': 10,

        },

        "access": {
            "formatter": "access",
            "class": "nb_log.handlers.ColorHandler",  # 这里用了nb_log的彩色控制台handler。
        },
        # "access_file": {
        #     "formatter": "access",
        #     "class": "nb_log.handlers.ConcurrentRotatingFileHandler",  # 注意这里是多进程安全切割日志
        #     'filename': Path(LOG_FILE_PATH) / 'uvicorn_access.log',
        #     'maxBytes': 1000 * 1000 * 100,
        #     'backupCount': 3,
        # },
        "access_file": {
            "formatter": "access",
             "class": "nb_log.handlers.BothDayAndSizeRotatingFileHandler",  # 注意这里是多进程安全切割日志
            'file_name': 'uvicorn_access.log',
            'log_path': LOG_FILE_PATH,
            'max_bytes': 1000 * 1000 * 1000,
            'back_count': 10,
        },
    },
    "loggers": {
        "uvicorn": {"handlers": ["default", "default_file"], "level": "INFO"},
        "uvicorn.error": {"level": "INFO"},
        "uvicorn.access": {"handlers": ["access", "access_file"], "level": "INFO", "propagate": False},
    },
}

if __name__ == "__main__":
    import uvicorn

    uvicorn.run('nb_http_client.tests.fastapi_server:app', host="0.0.0.0", port=8008, workers=2,log_config=LOGGING_CONFIG)

控制台截图：

文件日志截图：