mentat.module.informant module

This Mentat module is a script providing periodical informational reports about overall performance of Mentat system.

This script is implemented using the pyzenkit.zenscript framework and so it provides all of its core features. See the documentation for more in-depth details.

It is further based on mentat.script.fetcher module, which provides database fetching and message post-processing capabilities.

Usage examples

# Display help message and exit.
mentat-informant.py --help

# Run in debug mode (enable output of debugging information to terminal).
mentat-informant.py --debug

# Run with increased logging level.
mentat-informant.py --log-level debug

Available script commands

report (default)

Generate report containing overall Mentat system performance statistics within configured time interval thresholds.

class mentat.module.informant.MentatInformantScript

Bases: mentat.script.fetcher.FetcherScript

Implementation of Mentat module (script) providing periodical statistical overview for message processing performance analysis.

CONFIG_FORCE_LOCALE = 'force_locale'

CONFIG_FORCE_TEMPLATE = 'force_template'

CONFIG_FORCE_TIMEZONE = 'force_timezone'

CONFIG_REPORTS_DIR = 'reports_dir'

CONFIG_TEMPLATES_DIR = 'templates_dir'

CONFIG_TEMPLATE_VARS = 'template_vars'

CORECFG_INFORMANT = '__core__informant'

cbk_command_report()

Implementation of the report command (default).

Calculate statistics for messages stored into database within configured time interval thresholds.

get_default_command()

Return the name of the default script command. This command will be executed in case it is not explicitly selected either by command line option, or by configuration file directive.

Returns

Name of the default command.

Return type

str