Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rai200890/flask_google_cloud_logger
Flask extension to format logs according to Google Cloud v2 Specification
https://github.com/rai200890/flask_google_cloud_logger
flask google-cloud-logging logging python3
Last synced: 20 days ago
JSON representation
Flask extension to format logs according to Google Cloud v2 Specification
- Host: GitHub
- URL: https://github.com/rai200890/flask_google_cloud_logger
- Owner: rai200890
- Created: 2018-10-21T19:54:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-06-01T22:58:48.000Z (over 3 years ago)
- Last Synced: 2024-08-08T22:20:08.858Z (3 months ago)
- Topics: flask, google-cloud-logging, logging, python3
- Language: Python
- Homepage:
- Size: 101 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# flask_google_cloud_logger
[](https://circleci.com/gh/rai200890/flask_google_cloud_logger)
[](https://badge.fury.io/py/flask-google-cloud-logger)
[](https://codeclimate.com/github/rai200890/flask_google_cloud_logger/maintainability)
[](https://codeclimate.com/github/rai200890/flask_google_cloud_logger/test_coverage)
Flask extension to format logs according to Google Cloud v2 Specification
Python log formatter for Google Cloud according to [v2 specification](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) using [python-json-logger](https://github.com/madzak/python-json-logger) formatter
Inspired by Elixir's [logger_json](https://github.com/Nebo15/logger_json)
## Instalation
### Pipenv
```
pipenv install flask_google_cloud_logger
```
### Pip
```
pip install flask_google_cloud_logger
```
## Usage
```python
import logging
from logging import config
from flask import Flask, request, g
from flask_google_cloud_logger import FlaskGoogleCloudLogger
LOG_CONFIG = {
"version": 1,
"formatters": {
"json": {
"()": "flask_google_cloud_logger.FlaskGoogleCloudFormatter",
"application_info": {
"type": "python-application",
"application_name": "Example Application"
},
"format": "[%(asctime)s] %(levelname)s in %(module)s: %(message)s"
}
},
"handlers": {
"json": {
"class": "logging.StreamHandler",
"formatter": "json"
}
},
"loggers": {
"root": {
"level": "INFO",
"handlers": ["json"]
},
"werkzeug": {
"level": "WARN", # Disable werkzeug hardcoded logger
"handlers": ["json"]
}
}
}
config.dictConfig(LOG_CONFIG) # load log config from dict
logger = logging.getLogger("root") # get root logger instance
app = Flask("test_app")
FlaskGoogleCloudLogger(app)
@app.route("/")
def hello_world():
return "Hello, World!"
@app.teardown_request #log request and response info after extension's callbacks
def log_request_time(_exception):
logger.info(
f"{request.method} {request.path} - Sent {g.response.status_code}" +
" in {g.request_time:.5f}ms")
```
Example output:
```json
{"timestamp": "2018-11-04T22:07:42.687000Z", "severity": "INFO", "message": "GET / - Sent 200 in {g.request_time:.5f}ms", "labels": {"type": "python-application", "application_name": "Example Application", "client": {"user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.75 Safari/537.36", "ip": "127.0.0.1", "version": null}, "connection": {"method": "GET", "path": "/", "request_id": "afc4c6d5-5f30-4f02-b66a-e97e87841073", "status": 200}, "latency": 0.13828277587890625}, "metadata": {"userLabels": {}}, "sourceLocation": {"file": "test_app.py", "line": 52, "function": "log_request_time"}}
```
## Credits
Thanks [@thulio](https://github.com/thulio), [@robsonpeixoto](https://github.com/robsonpeixoto), [@ramondelemos](https://github.com/ramondelemos)