Skip to main content

Simple middleware for FastAPI to generate log entries on all requests

Project description

fastapi-route-logger

Basic middleware to log requests made to routes in FastAPI applications.

Installation

pip install fastapi-route-logger-middleware

Usage

The component is FastAPI middleware.

app.add_middleware(RouteLoggerMiddleware)

Additional arguments can be provided, when needed:

  • logger - The Logger instance to use. Defaults to the default logger (logging.getLogger(__name__)).
  • skip_routes - A list of strings that represent the start of routes that should not be logged. Default is an empty list. This is a "begins with" type match so an entry of "/health" will block the routes /health/check and /healthcheck.
  • skip_regexes - A list of regex strings that will be matched against routes that should not be logged. Default is an empty list. This uses compiled regexes and matches against the entire path. An entry of ".*/health" will not log the routes /health and /api/1.0/health.

The sample-site in the code repository contains a sample FastAPI site with this middleware integrated. Check the included readme for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page