Add initial files
This commit is contained in:
commit
9a3ac79451
|
|
@ -0,0 +1,9 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2023 Santiago Lo Coco
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
@ -0,0 +1,53 @@
|
|||
# logmiddleware
|
||||
|
||||
`logmiddleware` is a Python library designed for use with FastAPI to simplify the logging of incoming requests and outgoing responses. It includes a middleware component that adds essential information to logs, such as request and response details, and supports debugging features.
|
||||
|
||||
## Features
|
||||
|
||||
- **Middleware for request and response logging:** The library provides a middleware component, `RouterLoggingMiddleware`, to log incoming requests and outgoing responses. It includes features to capture request details, response information, and execution times.
|
||||
|
||||
- **Request ID generation:** Automatically generates a unique request ID for each incoming request. If the request includes an `x-api-request-id` header, it uses that value; otherwise, it generates a new UUID.
|
||||
|
||||
- **Debugging support:** Enables debugging of response bodies through the use of the `api_debug` flag. When enabled, the response body is included in the logs.
|
||||
|
||||
- **JSON logging configuration:** Utilizes the `python-json-logger` library to configure JSON logging. This allows for structured and easily parsable log entries.
|
||||
|
||||
## Installation
|
||||
|
||||
To install the library, use the following pip command:
|
||||
|
||||
```bash
|
||||
pip install logmiddleware
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Setting up middleware
|
||||
|
||||
```python
|
||||
from fastapi import FastAPI
|
||||
from logmiddleware import RouterLoggingMiddleware, logging_config
|
||||
|
||||
# Configure JSON logging
|
||||
logging.config.dictConfig(logging_config)
|
||||
|
||||
app = FastAPI()
|
||||
# Add the middleware to your FastAPI app
|
||||
app.add_middleware(
|
||||
RouterLoggingMiddleware,
|
||||
logger=logging.getLogger(), # Pass your logger instance
|
||||
api_debug=True, # Set to True to enable debugging of response bodies
|
||||
)
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
The library relies on a logging configuration dictionary (`logging_config`) to set up JSON logging. Because of that, it includes a default logging configuration (`logging_config`), which you can import for easy setup. Ensure this configuration is properly set before adding the middleware to your FastAPI app.
|
||||
|
||||
## Contributing
|
||||
|
||||
If you find any issues or have suggestions for improvements, please feel free to open an issue or create a pull request on the [Git repository](https://git.slc.ar/slococo/logmiddleware).
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT license.
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
[build-system]
|
||||
requires = ["hatchling >= 1.13.0"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "logmiddleware"
|
||||
version = "0.0.1"
|
||||
description = "Simplify the logging of incoming requests and outgoing responses."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.8"
|
||||
license = "MIT"
|
||||
authors = [
|
||||
{ name = "Santiago Lo Coco", email = "mail@slococo.com.ar" },
|
||||
]
|
||||
classifiers = [
|
||||
"Intended Audience :: Information Technology",
|
||||
"Intended Audience :: System Administrators",
|
||||
"Operating System :: OS Independent",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python",
|
||||
"Topic :: Internet",
|
||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||
"Topic :: Software Development :: Libraries",
|
||||
"Topic :: Software Development",
|
||||
"Typing :: Typed",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
"Programming Language :: Python :: 3 :: Only",
|
||||
"Programming Language :: Python :: 3.8",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
]
|
||||
dependencies = [
|
||||
"fastapi>=0.103.2",
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://git.slc.ar/slococo/logmiddleware"
|
||||
Repository = "https://git.slc.ar/slococo/logmiddleware"
|
||||
|
||||
Loading…
Reference in New Issue