feat: Add error logger

Author: GermanMT

.gitignore

@@ -134,3 +134,6 @@ dmypy.json
 
 # Ruff cache
 .ruff_cache
+
+# Logger
+errors.log

README.md

@@ -6,11 +6,11 @@
 
 Related documentation and links about this template.
 
-[FastAPI](https://fastapi.tiangolo.com/)
+[FastAPI](https://fastapi.tiangolo.com/): Modern web framework for building APIs with Python.
 
-[Pydantic](https://pydantic-docs.helpmanual.io/)
+[Pydantic](https://pydantic-docs.helpmanual.io/): Data validation library for Python.
 
-[Motor](https://motor.readthedocs.io/en/stable/): Asynchronous Python driver for MongoDB
+[Motor](https://motor.readthedocs.io/en/stable/): Asynchronous Python driver for MongoDB.
 
 ## Deployment with docker
 

app/controllers/student_controller.py

@@ -17,8 +17,6 @@
 @router.post('/student', response_description='Create student', response_model=StudentModel)
 async def create_student_data(student: StudentModel) -> JSONResponse:
     student_json = jsonable_encoder(student)
-    if student_json['age'] == 3:
-        raise HTTPException(status_code=418, detail="Nope! I don't like 3.")
     new_student = await create_student(student_json)
     return JSONResponse(
         status_code=status.HTTP_201_CREATED,

app/exception_handlers.py

@@ -0,0 +1,35 @@
+import sys
+
+from fastapi import Request
+from fastapi.exception_handlers import http_exception_handler as _http_exception_handler
+from fastapi.exception_handlers import (
+    request_validation_exception_handler as _request_validation_exception_handler,
+)
+from fastapi.exceptions import HTTPException, RequestValidationError
+from fastapi.responses import JSONResponse, PlainTextResponse, Response
+
+from app.logger import logger
+
+
+async def request_validation_exception_handler(request: Request, exc: RequestValidationError) -> JSONResponse:
+    body = await request.body()
+    query_params = request.query_params._dict
+    detail = {"errors": exc.errors(), "body": body.decode(), "query_params": query_params}
+    logger.info(detail)
+    return await _request_validation_exception_handler(request, exc)
+
+
+async def http_exception_handler(request: Request, exc: HTTPException) -> JSONResponse | Response:
+    return await _http_exception_handler(request, exc)
+
+
+async def unhandled_exception_handler(request: Request, exc: Exception) -> PlainTextResponse:
+    host = getattr(getattr(request, "client", None), "host", None)
+    port = getattr(getattr(request, "client", None), "port", None)
+    url = f"{request.url.path}?{request.query_params}" if request.query_params else request.url.path
+    exception_type, exception_value, exception_traceback = sys.exc_info()
+    exception_name = getattr(exception_type, "__name__", None)
+    logger.error(
+        f'{host}:{port} - "{request.method} {url}" 500 Internal Server Error <{exception_name}: {exception_value}>'
+    )
+    return PlainTextResponse(str(exc), status_code=500)

app/logger.py

@@ -0,0 +1,13 @@
+import logging
+
+uvicorn_access = logging.getLogger("uvicorn.access")
+uvicorn_access.disabled = True
+
+logger = logging.getLogger("uvicorn")
+logger.setLevel(logging.getLevelName(logging.DEBUG))
+
+formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+error_file_handler = logging.FileHandler("errors.log")
+error_file_handler.setLevel(logging.DEBUG)
+error_file_handler.setFormatter(formatter)
+logger.addHandler(error_file_handler)

app/main.py

@@ -1,13 +1,17 @@
-from fastapi import FastAPI, Request
-from fastapi.exception_handlers import (
-    http_exception_handler,
-    request_validation_exception_handler,
-)
+from contextlib import asynccontextmanager
+from typing import Any
+
+from fastapi import FastAPI
 from fastapi.exceptions import RequestValidationError
 from starlette.exceptions import HTTPException
 from starlette.middleware.cors import CORSMiddleware
-from starlette.responses import Response
 
+from app.exception_handlers import (
+    http_exception_handler,
+    request_validation_exception_handler,
+    unhandled_exception_handler,
+)
+from app.middleware import log_request_middleware
 from app.router import api_router
 from app.services.populate_service import students_bulkwrite
 
@@ -25,34 +29,29 @@
 [Motor](https://motor.readthedocs.io/en/stable/): Asynchronous Python driver for MongoDB.
 '''
 
+@asynccontextmanager
+async def lifespan(app: FastAPI) -> Any:
+    await students_bulkwrite()
+    yield
+
 app = FastAPI(
     title="FastAPI/MongoDB Template",
     description=DESCRIPTION,
-    version="1.4.0",
+    version="1.5.0",
     contact={
         "name": "Antonio Germán Márquez Trujillo",
         "url": "https://github.com/GermanMT",
         "email": "[email protected]",
-    }
+    },
+    license_info={
+        "name": "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+        "url": "https://www.gnu.org/licenses/gpl-3.0.html",
+    },
+    lifespan=lifespan,
 )
 
 
-@app.exception_handler(HTTPException)
-async def custom_http_exception_handler(request: Request, exc: HTTPException) -> Response:
-    return await http_exception_handler(request, exc)
-
-
-@app.exception_handler(RequestValidationError)
-async def validation_exception_handler(request: Request, exc: RequestValidationError) -> Response:
-    return await request_validation_exception_handler(request, exc)
-
-
-@app.on_event("startup")
-async def startup_event() -> None:
-    await students_bulkwrite()
-
-
-# Set all CORS enabled origins
+app.middleware("http")(log_request_middleware)
 app.add_middleware(
     CORSMiddleware,
     allow_origins=[],
@@ -62,4 +61,9 @@ async def startup_event() -> None:
 )
 
 
+app.add_exception_handler(RequestValidationError, request_validation_exception_handler)
+app.add_exception_handler(HTTPException, http_exception_handler)
+app.add_exception_handler(Exception, unhandled_exception_handler)
+
+
 app.include_router(api_router)

app/middleware.py

@@ -0,0 +1,22 @@
+import http
+import time
+
+from fastapi import Request
+
+from app.logger import logger
+
+
+async def log_request_middleware(request: Request, call_next):
+    url = f"{request.url.path}?{request.query_params}" if request.query_params else request.url.path
+    start_time = time.time()
+    response = await call_next(request)
+    process_time = (time.time() - start_time) * 1000
+    formatted_process_time = f"{process_time:.2f}"
+    host = getattr(getattr(request, "client", None), "host", None)
+    port = getattr(getattr(request, "client", None), "port", None)
+    try:
+        status_phrase = http.HTTPStatus(response.status_code).phrase
+    except ValueError:
+        status_phrase=""
+    logger.info(f'{host}:{port} - "{request.method} {url}" {response.status_code} {status_phrase} {formatted_process_time}ms')
+    return response

app/services/db/database.py

@@ -4,6 +4,7 @@
 
 from app.config import settings
 
+
 @lru_cache
 def get_collection(collection_name: str) -> AsyncIOMotorCollection:
     client = AsyncIOMotorClient(settings.DB_URI)

requirements.txt

@@ -1,5 +1,6 @@
 fastapi==0.115.5
 uvicorn==0.32.0
+email-validator==2.2.0
 pydantic-settings==2.6.1
 motor==3.6.0
 python-dotenv==1.0.1