API Docs

Console

Invenio filesystem logging module.

This extension is enabled by default and automatically installed via invenio_base.apps and invenio_base.api_apps entry points.

class invenio_logging.console.InvenioLoggingConsole(app=None)[source]

Invenio-Logging extension for console.

Extension initialization.

Parameters:app – An instance of Flask.
init_app(app)[source]

Flask application initialization.

init_config(app)[source]

Initialize config.

install_handler(app)[source]

Install logging handler.

File System

Invenio filesystem logging module.

This extension is automatically installed via invenio_base.apps and invenio_base.api_apps entry points.

class invenio_logging.fs.InvenioLoggingFS(app=None)[source]

Invenio-Logging extension. Filesystem handler.

Extension initialization.

Parameters:app – An instance of Flask.
init_app(app)[source]

Flask application initialization.

init_config(app)[source]

Initialize config.

install_handler(app)[source]

Install log handler on Flask application.

Sentry

Compatibility layer for dealing with Sentry 6.x.

class invenio_logging.sentry6.Sentry6(app=None, client=None, client_cls=<class 'raven.base.Client'>, dsn=None, logging=False, level=0, wrap_wsgi=None, register_signal=True)[source]

Compatibility layer for Sentry.

get_user_info(request)[source]

Implement custom getter.

Sentry logging module.

class invenio_logging.sentry.InvenioLoggingSentry(app=None)[source]

Invenio-Logging extension for Sentry.

Extension initialization.

Parameters:app – An instance of Flask.
init_app(app)[source]

Flask application initialization.

init_config(app)[source]

Initialize configuration.

install_handler(app)[source]

Install log handler.

class invenio_logging.sentry.RequestIdProcessor(client)[source]

Sentry event request processor for adding the request id as a tag.

process(data, **kwargs)[source]

Process event data.