Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Configure Graylog logging handlers and middleware for your Flask app

Project Description

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.


You can install it via pip:

pip install Flask-Graylog


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'Message', extra={
    'extra': 'metadata',

# Use graylog log handler in another logger
import logging
logger = logging.getLogger(__name__)

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'] = ''
graylog = Graylog(app)

# Provide configuration
config = {'GRAYLOG_HOST': ''}
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": "",
         "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/",
     "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 -"
Release History

Release History

This version
History Node


History Node


History Node


History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
Flask_Graylog-1.1.2-py2.py3-none-any.whl (6.9 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Jul 13, 2017
Flask-Graylog-1.1.2.tar.gz (4.5 kB) Copy SHA256 Checksum SHA256 Source Jul 13, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting