herald package

Submodules

herald.angular_api module

ps.herald.angular_api.hello()

ps.herald.angular_api.hello_to_ps_basic_logger()

ps.herald.angular_api.index()

ps.herald.angular_api.internal_error(exception)

ps.herald.angular_api.list()

ps.herald.angular_api.options()

herald.bare_html_api module

ps.herald.bare_html_api.hello()

ps.herald.bare_html_api.hello_to_ps_basic_logger()

ps.herald.bare_html_api.index()

ps.herald.bare_html_api.isset(param1, param2)

ps.herald.bare_html_api.rm_logs()

ps.herald.bare_html_api.set_search_params(request)

herald.database module

ps.herald.database.close_engine(e=None)

ps.herald.database.get_engine()

current_app.config[‘DATABASE’] is already mapped to the ps.basic.Config.herald_sqlite_filename

ps.herald.database.get_session()

ps.herald.database.init_app(app)

ps.herald.database.init_db()

herald.model module

The models.

class ps.herald.model.HeartBeat(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

Store the HeartBeat of the different systems.

id

newest_heartbeat

system_id

class ps.herald.model.Log(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

The logging message.

The model currently is build around the data structure,

the standard python logging mechanism uses to send logging Events across the class logging.StreamHandler().

api_version

args

as_dict()

Return row as dict.

asctime

created

exc_info

exc_text

filename

funcname

id

levelname

levelno

lineno

message

module

msecs

name

package_version

pathname

process

processname

produkt_id

relativecreated

stack_info

sub_sub_system_id

sub_system_id

summary

system_id

thread

threadname

user_spec_1

user_spec_2

herald.ps_bridge module

ps.herald.ps_bridge.client_connected_handler(client_reader, client_writer)

Start a new asyncio.Task to handle this specific client connection

ps.herald.ps_bridge.handle_client(client_reader, client_writer)

Runs for each client connected.

The first 4 bytes of the message define the total length of the message. Hence in the first step, the first four bytes are read and then the rest of the message. This “rest” of the message is depickled and stored in the database. If the “bridge-mode” is enabled, the “byte-buffer” (first 4 bytes plus the rest of the message is also sent to another socket - the bridge socket.

ps.herald.ps_bridge.print_to_tunnel(data_p)

Running in bridge-mode we route the incoming message to the outgoing socket.

herald.ps_herald module

herald.ps_neelix module

ps.herald.ps_neelix.check()

[summary]

Go through the systemid’s found in the database:

• check if somebody needs notification

• update the hearbeat of the systemid

ps.herald.ps_neelix.notify(system_id_p, starting_at_p, till_p)

ps.herald.ps_neelix.react(system_id_p, cause_p, value_p, row_p)

• system_id_p Name of the system for which we react

• cause_p Name of the cause e.g. PATTERN or AGE

• value_p Value of the cause

• row_p table-row of the logging table correlated to the event

Subpackages

• herald.graph_ql package
  • Submodules
  • herald.graph_ql.mutation module
  • herald.graph_ql.query module
  • herald.graph_ql.schema module
  • herald.graph_ql.typedefs module
  • Module contents

Module contents

ps.herald.create_app(name, have_config_file=False, test_config=None)