A falcon middleware logging provider.
Install the extension via pip.
> pip install falcon-provider-loggerThis package provides a middleware logging component for the Falcon Web Framework (https://falcon.readthedocs.io/en/stable/index.html). The component provides two logging handlers that are pre-configured with sane defaults, yet fully customizable. The rotating_handler() method allows log events to be easily written to a file on disk, while the syslog_handler() method allows sending the log events over the network (both UDP and TCP).
- Pre-configure rotating file logging handlers with sane defaults, which can also be fully customized.
- Pre-configure syslog logging handlers with sane defaults, which can also be fully customized.
- Support for any custom logging handlers.
- Supports using a pre-existing logger instance.
- Supports multiple handler (e.g., using both file, syslog handlers, and/or custom handler).
Important
This middleware component should be one of the first middleware component loaded to make it available for other components. From the Falcon docs "Each component’s process_request, process_resource, and process_response methods are executed hierarchically, as a stack, following the ordering of the list passed via the middleware kwarg of falcon.App.".
- Falcon - https://pypi.org/project/falcon/
All values passed to the handler function are optional kwargs.
| Setting | Default | Description |
|---|---|---|
| backup_count | 10 | The number of backup log files to keep. |
| directory | log | The directory to write the log file. |
| filename | server.log | The name of the log file. |
| formatter | A sane formatter w/ module/lineno | A logging formatter to format log events. |
| level | INFO | The level for the logger. |
| name | rfh | A unique name for the handler. |
| max_bytes | 10485760 | The maximum size of the log file before rotating. |
| mode | a (append) | The write mode for the log file. |
The example below is a basic logger middleware using default values as defined in table above.
import falcon
from falcon_provider_logger.middleware import LoggerMiddleware
from falcon_provider_logger.utils import rotating_handler
class LoggerMiddleWareResource(object):
"""Logger middleware testing resource."""
def on_get(self, req, resp):
"""Support GET method."""
key = req.get_param('key')
self.log.debug(f'DEBUG {key}')
self.log.info(f'INFO {key}')
self.log.warning(f'WARNING {key}')
self.log.error(f'ERROR {key}')
self.log.critical(f'CRITICAL {key}')
resp.text = f'Logged - {key}'
def on_post(self, req, resp):
"""Support GET method."""
key = req.get_param('key')
value = req.get_param('value')
self.log.debug(f'DEBUG {key} {value}')
self.log.info(f'INFO {key} {value}')
self.log.warning(f'WARNING {key} {value}')
self.log.error(f'ERROR {key} {value}')
self.log.critical(f'CRITICAL {key} {value}')
resp.text = f'Logged - {key}'
rh = rotating_handler()
app = falcon.App(middleware=[LoggerMiddleware([rh])])
app.add_route('/middleware', LoggerMiddleWareResource())The example below shows a heavily customized logger.
import falcon
from falcon_provider_logger.middleware import LoggerMiddleware
from falcon_provider_logger.utils import rotating_handler
class LoggerMiddleWareResource(object):
"""Logger middleware testing resource."""
def on_get(self, req, resp):
"""Support GET method."""
key = req.get_param('key')
self.log.debug(f'DEBUG {key}')
self.log.info(f'INFO {key}')
self.log.warning(f'WARNING {key}')
self.log.error(f'ERROR {key}')
self.log.critical(f'CRITICAL {key}')
resp.text = f'Logged - {key}'
def on_post(self, req, resp):
"""Support GET method."""
key = req.get_param('key')
value = req.get_param('value')
self.log.debug(f'DEBUG {key} {value}')
self.log.info(f'INFO {key} {value}')
self.log.warning(f'WARNING {key} {value}')
self.log.error(f'ERROR {key} {value}')
self.log.critical(f'CRITICAL {key} {value}')
resp.text = f'Logged - {key}'
rh = rotating_handler(
backup=5,
directory='/var/log/',
filename='my-app.log',
formatter='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
level='debug',
name='my-rfh',
max_bytes='5000',
mode='w',
)
app = falcon.App(middleware=[LoggerMiddleware(handlers=[rh], level='INFO', name='MY-LOGGER')])
app.add_route('/middleware', LoggerMiddleWareResource())All values passed to the handler function are optional kwargs.
| Setting | Default | Description |
|---|---|---|
| host | localhost | The host name or IP of syslog server. |
| facility | user | The syslog facility. |
| formatter | A sane formatter w/ module/lineno | A logging formatter to format log events. |
| level | INFO | The level for the logger. |
| name | sh | A unique name for the handler. |
| port | 514 | The port for the syslog server. |
| socktype | UDP | The syslog socket type (TCP or UDP). |
The example below is a basic logger middleware using default values as defined in table above.
import falcon
from falcon_provider_logger.middleware import LoggerMiddleware
from falcon_provider_logger.utils import syslog_handler
class LoggerMiddleWareResource(object):
"""Logger middleware testing resource."""
def on_get(self, req, resp):
"""Support GET method."""
key = req.get_param('key')
self.log.debug(f'DEBUG {key}')
self.log.info(f'INFO {key}')
self.log.warning(f'WARNING {key}')
self.log.error(f'ERROR {key}')
self.log.critical(f'CRITICAL {key}')
resp.text = f'Logged - {key}'
def on_post(self, req, resp):
"""Support GET method."""
key = req.get_param('key')
value = req.get_param('value')
self.log.debug(f'DEBUG {key} {value}')
self.log.info(f'INFO {key} {value}')
self.log.warning(f'WARNING {key} {value}')
self.log.error(f'ERROR {key} {value}')
self.log.critical(f'CRITICAL {key} {value}')
resp.text = f'Logged - {key}'
sh = syslog_handler()
app = falcon.App(middleware=[LoggerMiddleware([sh])])
app.add_route('/middleware', LoggerMiddleWareResource())The example below shows a heavily customized logger.
import falcon
from falcon_provider_logger.middleware import LoggerMiddleware
from falcon_provider_logger.utils import syslog_handler
class LoggerMiddleWareResource(object):
"""Logger middleware testing resource."""
def on_get(self, req, resp):
"""Support GET method."""
key = req.get_param('key')
self.log.debug(f'DEBUG {key}')
self.log.info(f'INFO {key}')
self.log.warning(f'WARNING {key}')
self.log.error(f'ERROR {key}')
self.log.critical(f'CRITICAL {key}')
resp.text = f'Logged - {key}'
def on_post(self, req, resp):
"""Support GET method."""
key = req.get_param('key')
value = req.get_param('value')
self.log.debug(f'DEBUG {key} {value}')
self.log.info(f'INFO {key} {value}')
self.log.warning(f'WARNING {key} {value}')
self.log.error(f'ERROR {key} {value}')
self.log.critical(f'CRITICAL {key} {value}')
resp.text = f'Logged - {key}'
sh = syslog_handler(
host='10.10.10.10',
facility='daemon',
formatter='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
level='debug',
name='my-sh',
port='5140',
socktype='TCP',
)
app = falcon.App(middleware=[LoggerMiddleware(handlers=[sh], level='INFO', name='MY-LOGGER')])
app.add_route('/middleware', LoggerMiddleWareResource())This module can be a dependency for other middleware components. If using this module and no handler is required the following example shows how to setup the middleware component with no handlers/null handlers.
import falcon
from falcon_provider_logger.middleware import LoggerMiddleware
class LoggerMiddleWareResource(object):
"""Logger middleware testing resource."""
def on_get(self, req, resp):
"""Support GET method."""
key = req.get_param('key')
self.log.debug(f'DEBUG {key}') # No handler added so this would get dropped on the floor
resp.text = 'No Logging'
app = falcon.App(middleware=[LoggerMiddleware()])
app.add_route('/middleware', LoggerMiddleWareResource())After cloning the repository, all development requirements can be installed via pip. For linting and code consistency the pre-commit hooks should be installed.
> poetry install --with dev
> pre-commit installRun pytest test cases and get a coverage report.
> poetry install --with dev,test
> pytest --cov=falcon_provider_logger --cov-report=term-missing tests/