asgi-request-duration 1.0.6

A asgi middleware to measure the request duration

ASGI Request Duration ⏱️

ASGI Request Duration is a middleware for ASGI applications that measures the duration of HTTP requests and integrates this information into response headers and log records. This middleware is designed to be easy to integrate and configure, providing valuable insights into the performance of your ASGI application.

Note: If you find this project useful, please consider giving it a star ⭐ on GitHub. This helps prioritize its maintenance and development. If you encounter any typos, bugs 🐛, or have new feature requests, feel free to open an issue. I will be happy to address them.

Table of Contents 📚

1. Features ✨
2. Installation 🛠️
3. Usage 🚀
   1. Middleware 🧩
   2. Logging Filter 📝
   3. Configuration ⚙️
   4. Middleware Configuration 🔧
   5. Logging Filter Configuration 🔍
4. Examples 📖
   1. Example with Starlette 🌟
5. Contributing 🤝
6. License 📜

Features ✨

• Measure the duration of each HTTP request.
• Add the request duration to response headers.
• Integrate the request duration into log records.
• Configurable header name and precision.
• Exclude specific paths from timing.

Installation 🛠️

You can install the package using pip:

pip install asgi-request-duration

Usage 🚀

Middleware 🧩

To use the middleware, add it to your ASGI application:

from asgi_request_duration.middleware import RequestDurationMiddleware
from starlette.applications import Starlette

app = Starlette()
app.add_middleware(RequestDurationMiddleware)

Logging Filter 📝

To use the logging filter, configure your logger to use the RequestDurationFilter:

import logging
from asgi_request_duration.filters import RequestDurationFilter

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger("myapp")
logger.addFilter(RequestDurationFilter())

Configuration ⚙️

Middleware Configuration 🔧

You can configure the middleware by passing parameters to the RequestDurationMiddleware:

• excluded_paths: List of paths to exclude from timing.
• header_name: The name of the header to store the request duration.
• precision: The precision of the recorded duration.
• skip_validate_header_name: Flag to skip header name validation.
• skip_validate_precision: Flag to skip precision validation.
• time_granularity: Specifies the unit of time measurement (default: Seconds).

Example:

app.add_middleware(
    RequestDurationMiddleware,
    excluded_paths=["^/health/?$"],
    header_name="x-request-duration",
    precision=3,
    skip_validate_header_name=False,
    skip_validate_precision=False,
    time_granularity=TimeGranularity.MILLISECONDS,
)

Logging Filter Configuration 🔍

You can configure the logging filter by passing parameters to the RequestDurationFilter:

• context_key: The key to retrieve the request duration context value.
• default_value: The default value if the request duration context key is not found.

Example:

logger.addFilter(RequestDurationFilter(context_key="request_duration", default_value="-"))

Examples 📖

Here is a complete example of how to use the middleware with the Starlette framework. For more examples and detailed usage, please refer to the examples folder in the repository.

Example with Starlette 🌟

from asgi_request_duration import RequestDurationMiddleware, TimeGranularity
from starlette.applications import Starlette
from starlette.requests import Request
from starlette.responses import JSONResponse
from starlette.routing import Route
from uvicorn import run


async def info_endpoint(request: Request) -> JSONResponse:
    return JSONResponse({"message": "info"})

async def excluded_endpoint(request: Request) -> JSONResponse:
    return JSONResponse({"message": "excluded"})

routes = [
    Route("/info", info_endpoint, methods=["GET"]),
    Route("/excluded", excluded_endpoint, methods=["GET"]),
]

app = Starlette(routes=routes)
app.add_middleware(
    RequestDurationMiddleware,
    excluded_paths=["/excluded"],
    header_name="x-request-duration",
    precision=4,
    skip_validate_header_name=False,
    skip_validate_precision=False,
    time_granularity=TimeGranularity.MILLISECONDS,
)

if __name__ == "__main__":
    run(app, host='127.0.0.1', port=8000)

Contributing 🤝

Contributions are welcome! Please refer to the CONTRIBUTING.md file for guidelines on how to contribute to this project.

License 📜

This project is licensed under the GNU GPLv3 License. See the LICENSE file for more details.