Flask-Graylog
This is a Flask extension that allows you to configure a Graylog log handler as well as configuring middleware to log every request/response to Graylog.
Installation
You can install it via pip:
pip install Flask-Graylog
Usage
You only need to import and initialize your app
# Import dependencies
from flask import Flask
from flask.ext.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.ext.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
{
"_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 -"
}
Metadata
Release files for Flask-Graylog 1.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| Flask-Graylog-1.1.2.tar.gz | 4.5 kB | Without provenance | Details for Flask-Graylog-1.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| Flask_Graylog-1.1.2-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for Flask_Graylog-1.1.2-py2.py3-none-any.whl |
Total release size: 11.3 kB
Release files / Flask-Graylog-1.1.2.tar.gz
| Download URL | Flask-Graylog-1.1.2.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3261e6b49d61a4412c469e5fe99c1245f4b304066548268ce276a405882e3dc3
|
|
BLAKE2b-256 checksum How to use checksums |
937ce21ae6b15f1bcbf3fee788bf18230a471230b0bffcc41bc6c7b877fcee42
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / Flask_Graylog-1.1.2-py2.py3-none-any.whl
| Download URL | Flask_Graylog-1.1.2-py2.py3-none-any.whl |
|---|---|
| Size | 6.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
ddf57e1c4b0ed78c8a0ceac49f3013cef569013a8ad46f4f3aac578abd0c6308
|
|
BLAKE2b-256 checksum How to use checksums |
3c66b3231b6c7536d3d6d774d74a7d7f40e8b21da277c322a067dfcabcdcfd0f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for Flask-Graylog 1.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.