API Reference

Flask-LogConfig module.

class flask_logconfig.LogConfig(app=None, start_listeners=True, queue_class=None, handler_class=None, listener_class=None)

Flask extension for configuring Python’s logging module from application’s config object.

add_listener(app, name, listener)

Add listener indexed by name to application.

after_request(response)

Log request.

before_request()

Store information related to start of request.

default_handler_class

alias of FlaskQueueHandler

default_listener_class

alias of QueueListener

default_queue_class

alias of Queue

get_app(app=None)

Look up and return application.

get_execution_time()

Get response time for request in milliseconds.

get_listeners(app=None)

Return listeners associated with application.

get_request_message_data(response)

Return data for use in request message format string.

get_requests_logger()

Get designated logger for requests.

get_state(app=None)

Return stored state for application.

init_app(app, start_listeners=True, queue_class=None, handler_class=None, listener_class=None)

Initialize extension on Flask application.

make_request_message(data)

Return string formatted message for request log message.

setup_logging(app)

Setup logging configuration for application.

setup_queue(app, start_listeners, queue_class, listener_class, handler_class)

Setup unified logging queue for application.

start_listeners(app=None)

Start all queue listeners for application.

stop_listeners(app=None)

Stop all queue listeners for application.

class flask_logconfig.FlaskQueueHandler(queue)

Extend QueueHandler to attach Flask request context to record since request context won’t be available inside listener thread.

prepare(record)

Return a prepared log record. Attach a copy of the current Flask request context for use inside threaded handlers.

exception flask_logconfig.FlaskLogConfigException

Base exception class for Flask-LogConfig.

flask_logconfig.request_context_from_record(*args, **kwds)

Context manager for Flask request context attached to log record or if one doesn’t exist, then from top of request context stack.

Raises:FlaskLogConfigException – If no request context exists on record or stack.