Skip to main content

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.

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 -"
 }

Project details


Download files

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

Source Distribution

Flask-Graylog-1.1.2.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

Flask_Graylog-1.1.2-py2.py3-none-any.whl (6.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Flask-Graylog-1.1.2.tar.gz.

File metadata

File hashes

Hashes for Flask-Graylog-1.1.2.tar.gz
Algorithm Hash digest
SHA256 3261e6b49d61a4412c469e5fe99c1245f4b304066548268ce276a405882e3dc3
MD5 8486d807fa31fb8a399b58aa038215d0
BLAKE2b-256 937ce21ae6b15f1bcbf3fee788bf18230a471230b0bffcc41bc6c7b877fcee42

See more details on using hashes here.

File details

Details for the file Flask_Graylog-1.1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_Graylog-1.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ddf57e1c4b0ed78c8a0ceac49f3013cef569013a8ad46f4f3aac578abd0c6308
MD5 73699fcb656e59869f279a1e2f6ad69e
BLAKE2b-256 3c66b3231b6c7536d3d6d774d74a7d7f40e8b21da277c322a067dfcabcdcfd0f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page