Skip to content

Commit fb093e8

Browse files
committed
fix unsaved readme
1 parent ca33e60 commit fb093e8

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,27 @@ The `fastapi-gae-logging` module addresses these problems by:
3737

3838
## API
3939

40-
- `FastAPIGAELoggingHandler` class: A custom Cloud Logging Handler for FastAPI applications to use with the official google-cloud-logging library.
40+
- Initialization
41+
42+
```python
43+
FastAPIGAELoggingHandler(
44+
app: FastAPI,
45+
request_logger_name: Optional[str] = None,
46+
log_payload: bool = True,
47+
*args, **kwargs
48+
)
49+
```
50+
51+
- Parameters
52+
- **app** (FastAPI): The FastAPI application instance.
53+
- **request_logger_name** (Optional[str], optional): The name of the Cloud Logging logger to use for request logs.
54+
Defaults to the Google Cloud Project ID with the suffix '-request-logger'.
55+
56+
- **log_payload** (bool, optional): Whether to log the request payload. If True, the payload for POST, PUT, PATCH, and DELETE requests will be logged. Defaults to True.
57+
58+
- ***args**: Additional arguments to pass to the superclass constructor. Any argument you would pass to CloudLoggingHandler.
59+
60+
- ****kwargs**: Additional keyword arguments to pass to the superclass constructor. Any keyword argument you would pass to CloudLoggingHandler.
4161

4262

4363
## Example of usage

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
setup(
44
name="fastapi-gae-logging",
5-
version="0.0.5",
5+
version="0.0.6",
66
description="Custom Cloud Logging handler for FastAPI applications deployed in Google App Engine. \
77
Groups logs coming from the same request lifecycle and propagates the maximum log level \
88
throughout the request lifecycle using middleware and context management.",

0 commit comments

Comments
 (0)