hawat.blueprints.status package

Description

This pluggable module provides access Mentat system status information. The following information is provided:

  • current status of all configured real-time message processing modules

  • current status of all configured cronjob message post-processing modules

Provided endpoints

/status/view

Page providing read-only access various Mentat system status characteristics.

Authentication: login required Methods: GET

hawat.blueprints.status.BLUEPRINT_NAME = 'status'

Name of the blueprint as module global constant.

class hawat.blueprints.status.StatusBlueprint(name, import_name, **kwargs)[source]

Bases: hawat.base.HawatBlueprint

Hawat pluggable module - Mentat system status.

classmethod get_module_title()[source]

Implementation of hawat.base.HawatBlueprint.get_module_title().

register_app(app)[source]

Callback method. Will be called from hawat.base.HawatApp.register_blueprint() method and can be used to customize the Flask application object. Possible use cases:

  • application menu customization

Parameters

app (hawat.base.HawatApp) – Flask application to be customize.

class hawat.blueprints.status.ViewView[source]

Bases: hawat.base.HTMLMixin, hawat.base.SimpleView

Application view providing access Mentat system status information.

authentication = True
authorization = [<Permission needs={Need(method='role', value='admin')} excludes=set()>]
do_before_response(**kwargs)[source]

Implementation of hawat.base.RenderableView.do_before_response().

classmethod get_menu_icon()[source]

Implementation of hawat.base.BaseView.get_menu_icon().

classmethod get_menu_title(item=None)[source]

Implementation of hawat.base.BaseView.get_menu_title().

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

classmethod get_view_title(item=None)[source]

Implementation of hawat.base.BaseView.get_view_title().

hawat.blueprints.status.get_blueprint()[source]

Mandatory interface and factory function. This function must return a valid instance of hawat.base.HawatBlueprint or flask.Blueprint.