Configure Graylog logging handlers and middleware for your Flask app.
Project description
Flask-Graylog2
Fork of 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:
Installation
You can install it with pip
:
$ pip install Flask-Graylog2
Usage
You only need to import and initialize your app
# 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.
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 theextra
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
{
"_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 -"
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Flask-Graylog2-1.2.1.tar.gz
(6.6 kB
view hashes)
Built Distribution
Close
Hashes for Flask_Graylog2-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 281633b0c7a8293565cf04fc3053f8ccb7423a39f28e36941a6def818c12f751 |
|
MD5 | 9d699d0ca849b406aee1961f59ba1d1f |
|
BLAKE2b-256 | c1faf9aad36528932b9cfa37bc048244c12a394f8bacde12d84ee7e7af52bd81 |