API Reference¶
Flask-LogConfig module.
- class flask_logconfig.LogConfig(app=None, start_listeners=True, queue_class=None, handler_class=None, listener_class=None)[source]¶
Flask extension for configuring Python’s logging module from application’s config object.
- default_handler_class¶
alias of FlaskQueueHandler
- default_listener_class¶
alias of QueueListener
- default_queue_class¶
alias of Queue
- init_app(app, start_listeners=True, queue_class=None, handler_class=None, listener_class=None)[source]¶
Initialize extension on Flask application.
- class flask_logconfig.FlaskQueueHandler(queue)[source]¶
Extend QueueHandler to attach Flask request context to record since request context won’t be available inside listener thread.
- exception flask_logconfig.FlaskLogConfigException[source]¶
Base exception class for Flask-LogConfig.
- flask_logconfig.request_context_from_record(*args, **kwds)[source]¶
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.