# beans_logging_fastapi
[](https://choosealicense.com/licenses/mit)
[](https://github.com/bybatkhuu/module.fastapi-logging/actions/workflows/2.build-publish.yml)
[](https://github.com/bybatkhuu/module.fastapi-logging/releases)
[](https://pypi.org/project/beans-logging-fastapi)
[](https://docs.conda.io/en/latest/miniconda.html)
`beans_logging_fastapi` is a middleware for FastAPI to log HTTP access.
It is based on **'beans-logging'** package.
## Features
- **Logger** based on **'beans-logging'** package
- **FastAPI** HTTP access logging **middleware**
---
## Installation
### 1. Prerequisites
- **Python (>= v3.8)**
- **PyPi (>= v23)**
### 2. Install beans-logging-fastapi package
Choose one of the following methods to install the package **[A ~ F]**:
**A.** [**RECOMMENDED**] Install from **PyPi**
```sh
# Install or upgrade package:
pip install -U beans-logging-fastapi
```
**B.** Install latest version from **GitHub**
```sh
# Install package by git:
pip install git+https://github.com/bybatkhuu/module.fastapi-logging.git
```
**C.** Install from **pre-built release** files
1. Download **`.whl`** or **`.tar.gz`** file from **releases** - <https://github.com/bybatkhuu/module.fastapi-logging/releases>
2. Install with pip:
```sh
# Install from .whl file:
pip install ./beans_logging_fastapi-[VERSION]-py3-none-any.whl
# Or install from .tar.gz file:
pip install ./beans_logging_fastapi-[VERSION].tar.gz
```
**D.** Install from **source code** by building package
```sh
# Clone repository by git:
git clone https://github.com/bybatkhuu/module.fastapi-logging.git beans_logging_fastapi
cd ./beans_logging_fastapi
# Install python build tool:
pip install -U pip build
# Build python package:
python -m build
_VERSION=$(./scripts/get-version.sh)
# Install from .whl file:
pip install ./dist/beans_logging_fastapi-${_VERSION}-py3-none-any.whl
# Or install from .tar.gz file:
pip install ./dist/beans_logging_fastapi-${_VERSION}.tar.gz
```
**E.** Install with pip editable **development mode** (from source code)
```sh
# Clone repository by git:
git clone https://github.com/bybatkhuu/module.fastapi-logging.git beans_logging_fastapi
cd ./beans_logging_fastapi
# Install with editable development mode:
pip install -e .
```
**F.** Manually add to **PYTHONPATH** (not recommended)
```sh
# Clone repository by git:
git clone https://github.com/bybatkhuu/module.fastapi-logging.git beans_logging_fastapi
cd ./beans_logging_fastapi
# Install python dependencies:
pip install -r ./requirements.txt
# Add current path to PYTHONPATH:
export PYTHONPATH="${PWD}:${PYTHONPATH}"
```
## Usage/Examples
To use `beans_logging_fastapi`:
### **FastAPI**
[**`configs/logger.yml`**](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/examples/configs/logger.yml):
```yaml
logger:
app_name: "fastapi-app"
level: "TRACE"
use_diagnose: false
stream:
use_color: true
use_icon: false
format_str: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{level_short:<5}</level> | <w>{name}:{line}</w>]: <level>{message}</level>"
std_handler:
enabled: true
file:
logs_dir: "./logs"
rotate_size: 10000000 # 10MB
rotate_time: "00:00:00"
backup_count: 90
log_handlers:
enabled: true
format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {level_short:<5} | {name}:{line}]: {message}"
log_path: "{app_name}.std.all.log"
err_path: "{app_name}.std.err.log"
json_handlers:
enabled: true
use_custom: false
log_path: "json/{app_name}.json.all.log"
err_path: "json/{app_name}.json.err.log"
intercept:
auto_load:
enabled: true
only_base: false
ignore_modules: []
include_modules: []
mute_modules: ["uvicorn.access"]
extra:
http_std_debug_format: '<n>[{request_id}]</n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
http_std_msg_format: '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
http_file_enabled: true
http_file_format: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
http_file_tz: "localtime"
http_log_path: "http/{app_name}.http.access.log"
http_err_path: "http/{app_name}.http.err.log"
http_json_enabled: true
http_json_path: "json.http/{app_name}.json.http.access.log"
http_json_err_path: "json.http/{app_name}.json.http.err.log"
```
[**`.env`**](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/examples/.env):
```sh
ENV=development
DEBUG=true
BEANS_LOGGING_DISABLE_DEFAULT=false
BEANS_LOGGING_CONFIG_PATH="./configs/logger.yml"
BEANS_LOGGING_LOGS_DIR="./logs"
```
[**`logger.py`**](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/examples/logger.py):
```python
from beans_logging import Logger, LoggerLoader
from beans_logging_fastapi import (
add_http_file_handler,
add_http_file_json_handler,
http_file_format,
)
logger_loader = LoggerLoader()
logger: Logger = logger_loader.load()
def _http_file_format(record: dict) -> str:
_format = http_file_format(
record=record,
msg_format=logger_loader.config.extra.http_file_format,
tz=logger_loader.config.extra.http_file_tz,
)
return _format
if logger_loader.config.extra.http_file_enabled:
add_http_file_handler(
logger_loader=logger_loader,
log_path=logger_loader.config.extra.http_log_path,
err_path=logger_loader.config.extra.http_err_path,
formatter=_http_file_format,
)
if logger_loader.config.extra.http_json_enabled:
add_http_file_json_handler(
logger_loader=logger_loader,
log_path=logger_loader.config.extra.http_json_path,
err_path=logger_loader.config.extra.http_json_err_path,
)
```
[**`main.py`**](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/examples/main.py):
```python
from typing import Union
from contextlib import asynccontextmanager
import uvicorn
from dotenv import load_dotenv
from fastapi import FastAPI, HTTPException
from fastapi.responses import RedirectResponse
load_dotenv()
from beans_logging_fastapi import (
HttpAccessLogMiddleware,
RequestHTTPInfoMiddleware,
ResponseHTTPInfoMiddleware,
)
from logger import logger, logger_loader
from __version__ import __version__
@asynccontextmanager
async def lifespan(app: FastAPI):
logger.info("Preparing to startup...")
logger.success("Finished preparation to startup.")
logger.info(f"API version: {__version__}")
yield
logger.info("Praparing to shutdown...")
logger.success("Finished preparation to shutdown.")
app = FastAPI(lifespan=lifespan, version=__version__)
app.add_middleware(ResponseHTTPInfoMiddleware)
app.add_middleware(
HttpAccessLogMiddleware,
debug_format=logger_loader.config.extra.http_std_debug_format,
msg_format=logger_loader.config.extra.http_std_msg_format,
)
app.add_middleware(
RequestHTTPInfoMiddleware, has_proxy_headers=True, has_cf_headers=True
)
@app.get("/")
def root():
return {"Hello": "World"}
@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None):
return {"item_id": item_id, "q": q}
@app.get("/continue", status_code=100)
def get_continue():
return {}
@app.get("/redirect")
def redirect():
return RedirectResponse("/")
@app.get("/error")
def error():
raise HTTPException(status_code=500)
if __name__ == "__main__":
uvicorn.run(
app="main:app",
host="0.0.0.0",
port=8000,
access_log=False,
server_header=False,
proxy_headers=True,
forwarded_allow_ips="*",
)
```
Run the [**`examples`**](https://github.com/bybatkhuu/module.fastapi-logging/tree/main/examples):
```sh
cd ./examples
# Install python dependencies for examples:
pip install -r ./requirements.txt
uvicorn main:app --host=0.0.0.0 --port=8000
```
**Output**:
```txt
[2023-10-31 12:38:46.733 +09:00 | TRACE | beans_logging._base:578]: Intercepted modules: ['concurrent', 'concurrent.futures', 'watchfiles.watcher', 'dotenv.main', 'watchfiles.main', 'watchfiles', 'asyncio', 'fastapi', 'uvicorn.error', 'uvicorn', 'dotenv']; Muted modules: ['uvicorn.access'];
[2023-10-31 12:38:46.749 +09:00 | INFO | uvicorn.server:76]: Started server process [56216]
[2023-10-31 12:38:46.749 +09:00 | INFO | uvicorn.lifespan.on:46]: Waiting for application startup.
[2023-10-31 12:38:46.750 +09:00 | INFO | main:26]: Preparing to startup...
[2023-10-31 12:38:46.750 +09:00 | OK | main:27]: Finished preparation to startup.
[2023-10-31 12:38:46.750 +09:00 | INFO | main:28]: API version: 0.0.0-000000
[2023-10-31 12:38:46.750 +09:00 | INFO | uvicorn.lifespan.on:60]: Application startup complete.
[2023-10-31 12:38:46.752 +09:00 | INFO | uvicorn.server:218]: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
[2023-10-31 12:38:48.701 +09:00 | DEBUG | anyio._backends._asyncio:807]: [c3d76377250947c29559cb103a6d2c56] 127.0.0.1 - "GET / HTTP/1.1"
[2023-10-31 12:38:48.703 +09:00 | OK | anyio._backends._asyncio:807]: [c3d76377250947c29559cb103a6d2c56] 127.0.0.1 - "GET / HTTP/1.1" 200 17B 0.8ms
^C[2023-10-31 12:38:49.793 +09:00 | INFO | uvicorn.server:264]: Shutting down
[2023-10-31 12:38:49.903 +09:00 | INFO | uvicorn.lifespan.on:65]: Waiting for application shutdown.
[2023-10-31 12:38:49.903 +09:00 | INFO | main:31]: Praparing to shutdown...
[2023-10-31 12:38:49.904 +09:00 | OK | main:32]: Finished preparation to shutdown.
[2023-10-31 12:38:49.904 +09:00 | INFO | uvicorn.lifespan.on:76]: Application shutdown complete.
[2023-10-31 12:38:49.904 +09:00 | INFO | uvicorn.server:86]: Finished server process [56216]
```
---
## Running Tests
To run tests, run the following command:
```sh
# Install python test dependencies:
pip install -r ./requirements.test.txt
# Run tests:
python -m pytest -sv
```
## Environment Variables
You can use the following environment variables inside [**`.env.example`**](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/.env.example) file:
```sh
ENV=development
DEBUG=true
BEANS_LOGGING_DISABLE_DEFAULT=false
BEANS_LOGGING_CONFIG_PATH="./configs/logger.yml"
BEANS_LOGGING_LOGS_DIR="./logs"
```
## Documentation
- [docs](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/docs/README.md)
- [scripts](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/docs/scripts/README.md)
---
## References
- <https://github.com/bybatkhuu/module.python-logging>
- <https://github.com/Delgan/loguru>
- <https://loguru.readthedocs.io/en/stable/api/logger.html>
- <https://loguru.readthedocs.io/en/stable/resources/recipes.html>
Raw data
{
"_id": null,
"home_page": "https://github.com/bybatkhuu/module.fastapi-logging",
"name": "beans-logging-fastapi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "beans_logging_fastapi,fastapi-logging,fastapi-logging-middleware,fastapi-middleware,logging-middleware,middleware,beans-logging,http-access-logging,logging,logger,loguru",
"author": "Batkhuu Byambajav",
"author_email": "batkhuu10@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/14/7e/a91ed96d70a501f8f0d59063e8e89cf3ae706df06c0a269af19ea7dcaecd/beans_logging_fastapi-1.1.1.tar.gz",
"platform": null,
"description": "# beans_logging_fastapi\n\n[](https://choosealicense.com/licenses/mit)\n[](https://github.com/bybatkhuu/module.fastapi-logging/actions/workflows/2.build-publish.yml)\n[](https://github.com/bybatkhuu/module.fastapi-logging/releases)\n[](https://pypi.org/project/beans-logging-fastapi)\n[](https://docs.conda.io/en/latest/miniconda.html)\n\n`beans_logging_fastapi` is a middleware for FastAPI to log HTTP access.\n\nIt is based on **'beans-logging'** package.\n\n## Features\n\n- **Logger** based on **'beans-logging'** package\n- **FastAPI** HTTP access logging **middleware**\n\n---\n\n## Installation\n\n### 1. Prerequisites\n\n- **Python (>= v3.8)**\n- **PyPi (>= v23)**\n\n### 2. Install beans-logging-fastapi package\n\nChoose one of the following methods to install the package **[A ~ F]**:\n\n**A.** [**RECOMMENDED**] Install from **PyPi**\n\n```sh\n# Install or upgrade package:\npip install -U beans-logging-fastapi\n```\n\n**B.** Install latest version from **GitHub**\n\n```sh\n# Install package by git:\npip install git+https://github.com/bybatkhuu/module.fastapi-logging.git\n```\n\n**C.** Install from **pre-built release** files\n\n1. Download **`.whl`** or **`.tar.gz`** file from **releases** - <https://github.com/bybatkhuu/module.fastapi-logging/releases>\n2. Install with pip:\n\n```sh\n# Install from .whl file:\npip install ./beans_logging_fastapi-[VERSION]-py3-none-any.whl\n# Or install from .tar.gz file:\npip install ./beans_logging_fastapi-[VERSION].tar.gz\n```\n\n**D.** Install from **source code** by building package\n\n```sh\n# Clone repository by git:\ngit clone https://github.com/bybatkhuu/module.fastapi-logging.git beans_logging_fastapi\ncd ./beans_logging_fastapi\n\n# Install python build tool:\npip install -U pip build\n\n# Build python package:\npython -m build\n\n_VERSION=$(./scripts/get-version.sh)\n\n# Install from .whl file:\npip install ./dist/beans_logging_fastapi-${_VERSION}-py3-none-any.whl\n# Or install from .tar.gz file:\npip install ./dist/beans_logging_fastapi-${_VERSION}.tar.gz\n```\n\n**E.** Install with pip editable **development mode** (from source code)\n\n```sh\n# Clone repository by git:\ngit clone https://github.com/bybatkhuu/module.fastapi-logging.git beans_logging_fastapi\ncd ./beans_logging_fastapi\n\n# Install with editable development mode:\npip install -e .\n```\n\n**F.** Manually add to **PYTHONPATH** (not recommended)\n\n```sh\n# Clone repository by git:\ngit clone https://github.com/bybatkhuu/module.fastapi-logging.git beans_logging_fastapi\ncd ./beans_logging_fastapi\n\n# Install python dependencies:\npip install -r ./requirements.txt\n\n# Add current path to PYTHONPATH:\nexport PYTHONPATH=\"${PWD}:${PYTHONPATH}\"\n```\n\n## Usage/Examples\n\nTo use `beans_logging_fastapi`:\n\n### **FastAPI**\n\n[**`configs/logger.yml`**](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/examples/configs/logger.yml):\n\n```yaml\nlogger:\n app_name: \"fastapi-app\"\n level: \"TRACE\"\n use_diagnose: false\n stream:\n use_color: true\n use_icon: false\n format_str: \"[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{level_short:<5}</level> | <w>{name}:{line}</w>]: <level>{message}</level>\"\n std_handler:\n enabled: true\n file:\n logs_dir: \"./logs\"\n rotate_size: 10000000 # 10MB\n rotate_time: \"00:00:00\"\n backup_count: 90\n log_handlers:\n enabled: true\n format_str: \"[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {level_short:<5} | {name}:{line}]: {message}\"\n log_path: \"{app_name}.std.all.log\"\n err_path: \"{app_name}.std.err.log\"\n json_handlers:\n enabled: true\n use_custom: false\n log_path: \"json/{app_name}.json.all.log\"\n err_path: \"json/{app_name}.json.err.log\"\n intercept:\n auto_load:\n enabled: true\n only_base: false\n ignore_modules: []\n include_modules: []\n mute_modules: [\"uvicorn.access\"]\n extra:\n http_std_debug_format: '<n>[{request_id}]</n> {client_host} {user_id} \"<u>{method} {url_path}</u> HTTP/{http_version}\"'\n http_std_msg_format: '<n><w>[{request_id}]</w></n> {client_host} {user_id} \"<u>{method} {url_path}</u> HTTP/{http_version}\" {status_code} {content_length}B {response_time}ms'\n http_file_enabled: true\n http_file_format: '{client_host} {request_id} {user_id} [{datetime}] \"{method} {url_path} HTTP/{http_version}\" {status_code} {content_length} \"{h_referer}\" \"{h_user_agent}\" {response_time}'\n http_file_tz: \"localtime\"\n http_log_path: \"http/{app_name}.http.access.log\"\n http_err_path: \"http/{app_name}.http.err.log\"\n http_json_enabled: true\n http_json_path: \"json.http/{app_name}.json.http.access.log\"\n http_json_err_path: \"json.http/{app_name}.json.http.err.log\"\n```\n\n[**`.env`**](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/examples/.env):\n\n```sh\nENV=development\nDEBUG=true\n\nBEANS_LOGGING_DISABLE_DEFAULT=false\nBEANS_LOGGING_CONFIG_PATH=\"./configs/logger.yml\"\nBEANS_LOGGING_LOGS_DIR=\"./logs\"\n```\n\n[**`logger.py`**](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/examples/logger.py):\n\n```python\nfrom beans_logging import Logger, LoggerLoader\nfrom beans_logging_fastapi import (\n add_http_file_handler,\n add_http_file_json_handler,\n http_file_format,\n)\n\nlogger_loader = LoggerLoader()\nlogger: Logger = logger_loader.load()\n\n\ndef _http_file_format(record: dict) -> str:\n _format = http_file_format(\n record=record,\n msg_format=logger_loader.config.extra.http_file_format,\n tz=logger_loader.config.extra.http_file_tz,\n )\n return _format\n\n\nif logger_loader.config.extra.http_file_enabled:\n add_http_file_handler(\n logger_loader=logger_loader,\n log_path=logger_loader.config.extra.http_log_path,\n err_path=logger_loader.config.extra.http_err_path,\n formatter=_http_file_format,\n )\n\nif logger_loader.config.extra.http_json_enabled:\n add_http_file_json_handler(\n logger_loader=logger_loader,\n log_path=logger_loader.config.extra.http_json_path,\n err_path=logger_loader.config.extra.http_json_err_path,\n )\n```\n\n[**`main.py`**](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/examples/main.py):\n\n```python\nfrom typing import Union\nfrom contextlib import asynccontextmanager\n\nimport uvicorn\nfrom dotenv import load_dotenv\nfrom fastapi import FastAPI, HTTPException\nfrom fastapi.responses import RedirectResponse\n\nload_dotenv()\n\nfrom beans_logging_fastapi import (\n HttpAccessLogMiddleware,\n RequestHTTPInfoMiddleware,\n ResponseHTTPInfoMiddleware,\n)\n\nfrom logger import logger, logger_loader\nfrom __version__ import __version__\n\n\n@asynccontextmanager\nasync def lifespan(app: FastAPI):\n logger.info(\"Preparing to startup...\")\n logger.success(\"Finished preparation to startup.\")\n logger.info(f\"API version: {__version__}\")\n\n yield\n logger.info(\"Praparing to shutdown...\")\n logger.success(\"Finished preparation to shutdown.\")\n\n\napp = FastAPI(lifespan=lifespan, version=__version__)\n\napp.add_middleware(ResponseHTTPInfoMiddleware)\napp.add_middleware(\n HttpAccessLogMiddleware,\n debug_format=logger_loader.config.extra.http_std_debug_format,\n msg_format=logger_loader.config.extra.http_std_msg_format,\n)\napp.add_middleware(\n RequestHTTPInfoMiddleware, has_proxy_headers=True, has_cf_headers=True\n)\n\n\n@app.get(\"/\")\ndef root():\n return {\"Hello\": \"World\"}\n\n\n@app.get(\"/items/{item_id}\")\ndef read_item(item_id: int, q: Union[str, None] = None):\n return {\"item_id\": item_id, \"q\": q}\n\n\n@app.get(\"/continue\", status_code=100)\ndef get_continue():\n return {}\n\n\n@app.get(\"/redirect\")\ndef redirect():\n return RedirectResponse(\"/\")\n\n\n@app.get(\"/error\")\ndef error():\n raise HTTPException(status_code=500)\n\n\nif __name__ == \"__main__\":\n uvicorn.run(\n app=\"main:app\",\n host=\"0.0.0.0\",\n port=8000,\n access_log=False,\n server_header=False,\n proxy_headers=True,\n forwarded_allow_ips=\"*\",\n )\n```\n\nRun the [**`examples`**](https://github.com/bybatkhuu/module.fastapi-logging/tree/main/examples):\n\n```sh\ncd ./examples\n# Install python dependencies for examples:\npip install -r ./requirements.txt\n\nuvicorn main:app --host=0.0.0.0 --port=8000\n```\n\n**Output**:\n\n```txt\n[2023-10-31 12:38:46.733 +09:00 | TRACE | beans_logging._base:578]: Intercepted modules: ['concurrent', 'concurrent.futures', 'watchfiles.watcher', 'dotenv.main', 'watchfiles.main', 'watchfiles', 'asyncio', 'fastapi', 'uvicorn.error', 'uvicorn', 'dotenv']; Muted modules: ['uvicorn.access'];\n[2023-10-31 12:38:46.749 +09:00 | INFO | uvicorn.server:76]: Started server process [56216]\n[2023-10-31 12:38:46.749 +09:00 | INFO | uvicorn.lifespan.on:46]: Waiting for application startup.\n[2023-10-31 12:38:46.750 +09:00 | INFO | main:26]: Preparing to startup...\n[2023-10-31 12:38:46.750 +09:00 | OK | main:27]: Finished preparation to startup.\n[2023-10-31 12:38:46.750 +09:00 | INFO | main:28]: API version: 0.0.0-000000\n[2023-10-31 12:38:46.750 +09:00 | INFO | uvicorn.lifespan.on:60]: Application startup complete.\n[2023-10-31 12:38:46.752 +09:00 | INFO | uvicorn.server:218]: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)\n[2023-10-31 12:38:48.701 +09:00 | DEBUG | anyio._backends._asyncio:807]: [c3d76377250947c29559cb103a6d2c56] 127.0.0.1 - \"GET / HTTP/1.1\"\n[2023-10-31 12:38:48.703 +09:00 | OK | anyio._backends._asyncio:807]: [c3d76377250947c29559cb103a6d2c56] 127.0.0.1 - \"GET / HTTP/1.1\" 200 17B 0.8ms\n^C[2023-10-31 12:38:49.793 +09:00 | INFO | uvicorn.server:264]: Shutting down\n[2023-10-31 12:38:49.903 +09:00 | INFO | uvicorn.lifespan.on:65]: Waiting for application shutdown.\n[2023-10-31 12:38:49.903 +09:00 | INFO | main:31]: Praparing to shutdown...\n[2023-10-31 12:38:49.904 +09:00 | OK | main:32]: Finished preparation to shutdown.\n[2023-10-31 12:38:49.904 +09:00 | INFO | uvicorn.lifespan.on:76]: Application shutdown complete.\n[2023-10-31 12:38:49.904 +09:00 | INFO | uvicorn.server:86]: Finished server process [56216]\n```\n\n---\n\n## Running Tests\n\nTo run tests, run the following command:\n\n```sh\n# Install python test dependencies:\npip install -r ./requirements.test.txt\n\n# Run tests:\npython -m pytest -sv\n```\n\n## Environment Variables\n\nYou can use the following environment variables inside [**`.env.example`**](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/.env.example) file:\n\n```sh\nENV=development\nDEBUG=true\n\nBEANS_LOGGING_DISABLE_DEFAULT=false\nBEANS_LOGGING_CONFIG_PATH=\"./configs/logger.yml\"\nBEANS_LOGGING_LOGS_DIR=\"./logs\"\n```\n\n## Documentation\n\n- [docs](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/docs/README.md)\n- [scripts](https://github.com/bybatkhuu/module.fastapi-logging/blob/main/docs/scripts/README.md)\n\n---\n\n## References\n\n- <https://github.com/bybatkhuu/module.python-logging>\n- <https://github.com/Delgan/loguru>\n- <https://loguru.readthedocs.io/en/stable/api/logger.html>\n- <https://loguru.readthedocs.io/en/stable/resources/recipes.html>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "'beans_logging_fastapi' is a middleware for FastAPI to log HTTP access. It is based on 'beans-logging' package.",
"version": "1.1.1",
"project_urls": {
"Download": "https://github.com/bybatkhuu/module.fastapi-logging/archive/v1.1.1.tar.gz",
"Homepage": "https://github.com/bybatkhuu/module.fastapi-logging"
},
"split_keywords": [
"beans_logging_fastapi",
"fastapi-logging",
"fastapi-logging-middleware",
"fastapi-middleware",
"logging-middleware",
"middleware",
"beans-logging",
"http-access-logging",
"logging",
"logger",
"loguru"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e33eded97083bfcce01c51f6fecd29f5eefb9f488c354d3dce712307163eb51",
"md5": "4bdd21c9be70d214428a0754de1a7f6e",
"sha256": "bac02a8ddd56f5c16c6fcc70a95b2dd44cf6e62c33a6ad2423c226963ff3eb53"
},
"downloads": -1,
"filename": "beans_logging_fastapi-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bdd21c9be70d214428a0754de1a7f6e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13799,
"upload_time": "2023-12-15T05:45:18",
"upload_time_iso_8601": "2023-12-15T05:45:18.854636Z",
"url": "https://files.pythonhosted.org/packages/5e/33/eded97083bfcce01c51f6fecd29f5eefb9f488c354d3dce712307163eb51/beans_logging_fastapi-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "147ea91ed96d70a501f8f0d59063e8e89cf3ae706df06c0a269af19ea7dcaecd",
"md5": "275eba2b52e49c2133796452177e982d",
"sha256": "d86408e8c1f18610934c6ee4bffcc5cf5ee39c8e19c6a2e0fceecf8ef75690ae"
},
"downloads": -1,
"filename": "beans_logging_fastapi-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "275eba2b52e49c2133796452177e982d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13888,
"upload_time": "2023-12-15T05:45:20",
"upload_time_iso_8601": "2023-12-15T05:45:20.505203Z",
"url": "https://files.pythonhosted.org/packages/14/7e/a91ed96d70a501f8f0d59063e8e89cf3ae706df06c0a269af19ea7dcaecd/beans_logging_fastapi-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 05:45:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bybatkhuu",
"github_project": "module.fastapi-logging",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "beans-logging-fastapi"
}
JSON
