FastAPI logging - APIRoute, Middleware

😅 필자가 개인적으로 공부하고 남기는 것이기 때문에 정보가 미흡할 수 있습니다. 잘못된 내용이 있을경우 지적해주신다면 감사히 받겠습니다.

FastAPI에서 API Request와 Response를 로그로 남겨야 했다.
FastAPI로 logging하는 방법은 대표적으로 2가지가 존재한다.

• Middleware
• APIRoute

이번 글은 이 둘을 이용해 log를 남기는 방법을 공유하고자 한다.

1. Middleware

1. Middleware란?

Middleware는 애플리케이션의 HTTP 요청 및 응답을 처리하는 과정 중간에 개입하여 추가적인 로직을 수행하는 소프트웨어 컴포넌트다. FastAPI는 Middleware패턴으로 구성되어있다. API호출 전과 후에 하나의 콜백함수가 실행되고 API로 요청을 넘긴다. 이때 이 콜백함수는 Request와 Response의 처리 과정에 사용자 정의 로직을 수행할 수 있도록 도와준다.

2. FastAPI Middleware를 활용한 로깅

FastAPI에서 제공하는 Middleware를 사용하여 API Request와 Response의 로그를 남기는 방법은 아래와 같다.

from fastapi import FastAPI, Response, Request
from starlette.background import BackgroundTask
from typing import Dict, Any
import logging

app = FastAPI()
# 로그 파일에 작성 (생각보다 로그로 서버가 자주 터지더라구요..ㅎ)
logging.basicConfig(filename='info.log', level=logging.DEBUG)

def log_info(req_body, res_body):
    logging.info(req_body)
    logging.info(res_body)

@app.middleware('http')
async def some_middleware(request: Request, call_next):
    req_body = await request.body()
    response = await call_next(request)

    res_body = b''
    async for chunk in response.body_iterator:
        res_body += chunk

    task = BackgroundTask(log_info, req_body, res_body)
    return Response(content=res_body, status_code=response.status_code,
                    headers=dict(response.headers), media_type=response.media_type, background=task)


@app.post('/')
def main(payload: Dict[Any, Any]):
    return {"Hello": "World"}
    

3. 코드 💻

• some_middleware: Request와 Response에 대한 로그를 기록하는 미들웨어 클래스
• logger: uvicorn 로거를 설정하여 로그 레벨을 INFO로 지정
• BackgroundTask: API 성능에 영향을 주지 않기위해 응답을 먼저 보내주고 백그라운드에서 나머지 작업을 수행

4. 결과

Middleware를 사용하면 Request가 엔드포인트에 도달하기 전에 중간 처리를 할 수 있고 엔드포인트가 반환한 Response가 클라이언트에게 전달되기 전에 중간 처리를 할 수 있다.

위의 코드를 실행하면 FastAPI 애플리케이션이 실행되면서 Request와 Response에 대한 로그가 출력된다.

APIRoute

1. APIRoute란?

APIRoute는 FastAPI에서 엔드포인트를 더 세부적으로 제어할 수 있게 해주는 클래스이다. 이 클래스를 사용하면 엔드포인트의 동작을 더욱 유연하게 정의하고 커스터마이징할 수 있다.

from fastapi import FastAPI, HTTPException, APIRouter, Request, Depends
from fastapi.responses import JSONResponse
import logging

app = FastAPI()
router = APIRouter()

# 로깅을 위한 함수 정의
def custom_logger(request: Request, response: JSONResponse, logger: logging.Logger = Depends()):
    logger.info(f"Request: {request.method} {request.url}")
    logger.info(f"Response: {response.status_code}")
    return response

# APIRoute를 사용한 엔드포인트 정의
@router.get("/", response_class=JSONResponse, dependencies=[Depends(custom_logger)])
async def read_root():
    return {"Hello": "World"}

# FastAPI 애플리케이션에 APIRouter 등록
app.include_router(router, prefix="/api")

# 로거 설정
logger = logging.getLogger("uvicorn")
logger.setLevel(logging.INFO)

3. 코드

• custom_logger: Request와 Response에 대한 로그를 기록하는 함수
• response_class: 엔드포인트의 응답 클래스를 지정

4. 결과

위의 코드를 실행하면 FastAPI 애플리케이션이 실행되면서 APIRoute를 사용한 엔드포인트에 대한 Request와 Response에 대한 로그가 출력된다.

특히 APIRoute를 활용하면 엔드포인트에 대한 로깅을 더욱 세밀하게 조절할 수 있고, 각 엔드포인트마다 다른 로깅 로직을 적용할 수 있다.