FastAPI 中的中間件，用於為每個請求生成 UUID 並發送到日志

Question

我正在尋找Fast API 中的中間件，用於為每個請求生成UUID並將其發送到日志。

# To see the logs, run this in python interpreter
# import with_logger
# with_logger.main()

import uuid
from logging import getLogger
import logging.config
from yaml import load, FullLoader
from fastapi import FastAPI
import uvicorn

app = FastAPI()


# @app.middleware("http")
@app.get("/")
def gen_uuid():
    # For every get request generate uuid
    global uuid_var
    uuid_var = uuid.uuid4()
    return uuid_var


log_dict = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'standard': {
            'format': '%(uuid_var)s %(asctime)s %(levelname)-8s %(name)-15s %(message)s -Thread id: %(thread)d  Thread name: %(threadName)s'
        },
    },
    'handlers': {
        'default': {
            'level': 'INFO',
            'formatter': 'standard',
            'class': 'logging.StreamHandler',
        },
        'file_handler': {
            'level': 'INFO',
            'filename': 'mylogfile.log',
            'class': 'logging.FileHandler',
            'formatter': 'standard'
        }
    },
    'loggers': {
        '': {
            'handlers': ['file_handler'],
            'level': 'INFO',
            'propagate': True
        },
    }
}


class ContextFilter(logging.Filter):
    def filter(self, record):
        record.uuid_var = gen_uuid()
        return True


def main():
    logging.config.dictConfig(log_dict)

    handler = logging.StreamHandler()
    handler.formatter = logging.Formatter(
        "%(uuid_var)s %(asctime)s %(levelname)-8s %(name)-15s %(message)s -Thread id: %(thread)d  Thread name: %(threadName)s")
    handler.addFilter(ContextFilter())
    logger = getLogger(__name__)
    logger.addHandler(handler)

    logger.warning(" This is a warning message")

    uvicorn.run(app, host="127.0.0.1", port=8080)

我需要將 uuid 發送到 X-Request-ID 標頭，我將使用 python 日志庫從那里獲取它，例如，

@app.middleware("http")
async def get_x_request_id_header(*, x_request_id: str = Header(None)):
    # return x-request-id header
    return {"X-Request-ID": x_request_id}

我需要一個中間件中的所有這些。 Fast API 中是否已經存在類似這樣的中間件？

我需要在中間件中生成 uuid，例如，

@app.middleware("http")
def gen_uuid():
    # For every get request generate uuid
    global uuid_var
    uuid_var = uuid.uuid4()
    return uuid_var

但無法做到這一點。 我收到錯誤，如 gen_uuid 接受 2 個參數但傳遞 0 個參數

Answer 1

中間件需要兩個參數：request:Request，call_next request是api請求，call_next是處理請求的實際調用，像這樣：

    @app.middleware("http")
async def init_requestvars(request: fastapi.Request, call_next):
    # Customize that SimpleNamespace with hatever you need
    initial_g = types.SimpleNamespace()
    requestvars.request_global.set(initial_g)
    response = await call_next(request)
    return response

Answer 2

我剛剛為此實現了一個中間件。 希望它可能仍然對您有用（或將來遇到此問題的任何其他人）。

這是回購協議： https : //github.com/snok/asgi-correlation-id