ska_sdp_batchlet.plugins.plugin module

class ska_sdp_batchlet.plugins.plugin.FilterPlugin

Bases: ABC

Abstract base class for plugins that filter events.

A filter plugin takes the string log line and validates it against some criteria. If the line is valid, it should return the parsed event as a dictionary. If the line is invalid, it should return None.

DEFAULT_PACKAGE_PATH = 'ska_sdp_batchlet_plugins.filters'

abstract filter(line)

Parameters:

line (str) -- The raw log line to be processed

Returns:

event -- The parsed event as a dictionary if the line is valid, or None if it is invalid.

Return type:

dict | None

class ska_sdp_batchlet.plugins.plugin.ConsumerPlugin

Bases: ABC

Abstract base class for plugins that consume events.

A consumer plugin takes a parsed event as a dictionary and processes it.

DEFAULT_PACKAGE_PATH = 'ska_sdp_batchlet_plugins.consumers'

abstract process(event)

Parameters:

event (dict) -- The parsed event as a dictionary

Return type:

None