Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gridscale/flask-graylog2
Flask extension that configures a Graylog GELF UDP logging handler for you
https://github.com/gridscale/flask-graylog2
Last synced: 5 days ago
JSON representation
Flask extension that configures a Graylog GELF UDP logging handler for you
- Host: GitHub
- URL: https://github.com/gridscale/flask-graylog2
- Owner: gridscale
- License: mit
- Created: 2020-06-17T09:39:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-06-19T16:38:38.000Z (over 4 years ago)
- Last Synced: 2024-11-01T21:18:39.334Z (13 days ago)
- Language: Python
- Size: 26.4 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# Flask-Graylog2
[](https://badge.fury.io/py/Flask-Graylog2)
Fork of [github.com/underdogio/flask-graylog](https://github.com/underdogio/flask-graylog) with additional patches and features.
This is a Flask extension that allows you to configure a Graylog GELF UDP logging handler as well as some middleware to log every request/response pair to Graylog.
See also:
- [Flask docs](https://flask.palletsprojects.com/en/1.1.x/logging/)
- [Graylog docs](https://docs.graylog.org/en/latest/index.html)
- [graypy docs](https://graypy.readthedocs.io/en/stable/?badge=stable#)
## Installation
You can install it with [`pip`](https://pypi.org/):
$ pip install Flask-Graylog2
## Usage
You only need to import and initialize your app
```python
# Import dependencies
from flask import Flask
from flask_graylog import Graylog
# Configure app and Graylog logger
app = Flask(__name__)
graylog = Graylog(app)
# Log to graylog
graylog.info("Message", extra={"extra": "metadata",})
# Use Graylog log handler in another logger
import logging
logger = logging.getLogger(__name__)
logger.addHandler(graylog.handler)
logger.info("Message")
```
## Configuration options
The following options can be use to configure the graylog logger.
```python
from flask import Flask
from flask_graylog import Graylog
app = Flask(__name__)
# Use configuration from `app`
app.config["GRAYLOG_HOST"] = "10.1.1.1"
graylog = Graylog(app)
# Provide configuration
config = {"GRAYLOG_HOST": "10.1.1.1"}
graylog = Graylog(app, config=config)
```
- `GRAYLOG_HOST` - the host to send messages to [default: 'localhost']
- `GRAYLOG_PORT` - the port to send messages to [default: 12201]
- `GRAYLOG_FACILITY` - the facility to report with [default: 'flask']
- `GRAYLOG_EXTRA_FIELDS` - whether or not to include the `extra` data from each message [default: True]
- `GRAYLOG_ADD_DEBUG_FIELDS` - whether extra python debug fields should be added to each message [default: True]
- `GRAYLOG_CONFIGURE_MIDDLEWARE` - whether to setup middleware to log each response [default: True]
## Example message format
```json
{
"_process_name": "MainProcess",
"_request": {
"content_length": "",
"remote_addr": "127.0.0.1",
"headers": {
"upgrade_insecure_requests": "1",
"connection": "keep-alive",
"accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
"dnt": "1",
"host": "localhost:5000",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36",
"accept_language": "en-US,en;q=0.8,ms;q=0.6",
"cache_control": "max-age=0",
"accept_encoding": "gzip, deflate, sdch"
},
"path_info": "/",
"content_type": "",
"query_string": "",
"method": "GET"
},
"level": 6,
"_logger": "flask_graylog",
"timestamp": 1460502169.950895,
"_pid": 6010,
"facility": "flask",
"_function": "after_request",
"_thread_name": "Thread-1",
"host": "voltaire.local",
"version": "1.0",
"file": "Flask-Graylog/flask_graylog.py",
"full_message": "Finishing request for \"GET http://localhost:5000/\" from -",
"line": 130,
"_response": {
"headers": {
"content_length": "6",
"content_type": "text/html; charset=utf-8"
},
"time_ms": 0,
"status_code": 200
},
"_flask": {
"view_args": {},
"endpoint": "root"
},
"short_message": "Finishing request for \"GET http://localhost:5000/\" from -"
}
```