Adds an unique identifiert to fastapi requests
Project description
sag_py_fastapi_request_id
This library provides a way to identify all log entries that belong to a single request.
What it does
- Provides a middleware to generate a random request id for every request
- Contains a logging filter that adds the request id as field to every log entry
How to use
Installation
pip install sag-py-fastapi-request-id
Add the middleware
Add this middleware so that the request ids are generated:
from sag_py_fastapi_request_id.request_context_middleware import RequestContextMiddleware
from fastapi import FastAPI
app = FastAPI(...)
app.add_middleware(RequestContextMiddleware)
Get the request id
The request id can be accessed over the context
from sag_py_fastapi_request_id.request_context import get_request_id as get_request_id_from_context
request_id = get_request_id_from_context()
This works in async calls but not in sub threads (without additional changes).
See:
- https://docs.python.org/3/library/contextvars.html
- https://kobybass.medium.com/python-contextvars-and-multithreading-faa33dbe953d
Add request id field to logging
It is possible to log the request id by adding a filter.
import logging
from sag_py_fastapi_request_id.request_context_logging_filter import RequestContextLoggingFilter
console_handler = logging.StreamHandler(sys.stdout)
console_handler.addFilter(RequestContextLoggingFilter())
The filter adds the field request_id if it has a value in the context.
How to start developing
With vscode
Just install vscode with dev containers extension. All required extensions and configurations are prepared automatically.
With pycharm
- Install latest pycharm
- Install pycharm plugin BlackConnect
- Install pycharm plugin Mypy
- Configure the python interpreter/venv
- pip install requirements-dev.txt
- pip install black[d]
- Ctl+Alt+S => Check Tools => BlackConnect => Trigger when saving changed files
- Ctl+Alt+S => Check Tools => BlackConnect => Trigger on code reformat
- Ctl+Alt+S => Click Tools => BlackConnect => "Load from pyproject.yaml" (ensure line length is 120)
- Ctl+Alt+S => Click Tools => BlackConnect => Configure path to the blackd.exe at the "local instance" config (e.g. C:\Python310\Scripts\blackd.exe)
- Ctl+Alt+S => Click Tools => Actions on save => Reformat code
- Restart pycharm
How to publish
- Update the version in setup.py and commit your change
- Create a tag with the same version number
- Let github do the rest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sag-py-fastapi-request-id-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0adb4e0097d4374643b913f096d024c6c6f57782f2493df063607b46a7e0e58e |
|
MD5 | c2ad6a8c92ac16da0753448e067c9cec |
|
BLAKE2b-256 | e3b88bf23a05ec1ff57e5da7f857791b4d95e9884645ddc21d3cfa710d713f31 |
Close
Hashes for sag_py_fastapi_request_id-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2571c35e1ba87c2233393d386d29905d13f82763e6e9ce26329ecdcfd95c18fa |
|
MD5 | 117310bc92774c50ba32a9eb94b7d925 |
|
BLAKE2b-256 | 7dfa4811542a522e49e58ab925be582dcd107d9b25e8e78c6ca406bba0976f69 |