asgi-logging-middleware 0.2.0

ASGI middleware for logging HTTP requests and responses. Fork of asgi-logger.

asgi-logging-middleware

Overview

This project was created as a fork of asgi-logger project.

ASGI logging middleware logs HTTP request/response data in a configurable format, similar to how web servers like Nginx or Apache log requests. Initially it was created as an alternative for the uvicorn access logger.

Primarily the middleware is targeted at Starlette and FastAPI applications, but it can be used with any ASGI application.

Installation

pip install asgi-logging-middleware

Usage

If you're using it with uvicorn, remember that you need to erase the handlers from uvicorn's logger that is writing the access logs. To do that, just:

logging.getLogger("uvicorn.access").handlers = []

Below you can see an example with FastAPI, but you can use it with any other ASGI application:

from fastapi import FastAPI
from fastapi.middleware import Middleware
from asgi_logging_middleware import AccessLoggerMiddleware

app = FastAPI(middleware=[Middleware(AccessLoggerMiddleware)])


@app.get("/")
async def home():
    return "Hello world!"

In case you want to add a custom format to the access logs, you can do it using the format parameter on the AccessLoggerMiddleware:

AccessLoggerMiddleware(app, format="%(s)s")

For now you can verify the possible format values here. The documentation will be available soon.

License

This project is licensed under the terms of the MIT license.