plugin.healthcheck_watchdog.BoswatchPlugin Class Reference

Public Member Functions
	__init__ (self, config)
	Do not change anything here!
	onLoad (self)
	Called by import of the plugin.
	setup (self)
	Called before alarm.
	fms (self, bwPacket)
	Called on FMS alarm.
	pocsag (self, bwPacket)
	Called on POCSAG alarm.
	zvei (self, bwPacket)
	Called on ZVEI alarm.
	msg (self, bwPacket)
	Called on MSG packet.
	teardown (self)
	Called after alarm Remove if not implemented.
	onUnload (self)
	Called by destruction of the plugin Remove if not implemented.
Public Member Functions inherited from plugin.pluginBase.PluginBase
	parseWildcards (self, msg)
	Return the message with parsed wildcards.

Data Fields
	timer
	timeout
	url
Data Fields inherited from plugin.pluginBase.PluginBase
	config

Protected Member Functions
	_reset_watchdog (self)
	_on_timeout (self)
	_send_ping (self)
	_do_ping (self)
Protected Member Functions inherited from plugin.pluginBase.PluginBase
	_cleanup (self)
	Cleanup routine calls onUnload() directly.
	_run (self, bwPacket)
	start an complete running turn of an plugin.
	_getStatistics (self)
	Returns statistical information's from last plugin run.

Additional Inherited Members
Protected Attributes inherited from plugin.pluginBase.PluginBase
	_pluginName
	_bwPacket
	_sumTime
	_cumTime
	_setupTime
	_alarmTime
	_teardownTime
	_runCount
	_setupErrorCount
	_alarmErrorCount
	_teardownErrorCount
Static Protected Attributes inherited from plugin.pluginBase.PluginBase
list	_pluginsActive = []

Detailed Description

Überwachung der Log-Aktivität via Healthchecks.io

Constructor & Destructor Documentation

__init__()

plugin.healthcheck_watchdog.BoswatchPlugin.__init__	(		self,
			config
	)

Do not change anything here!

Reimplemented from plugin.pluginBase.PluginBase.

    def __init__(self, config):
        r"""!Do not change anything here!"""
        super().__init__(__name__, config)  # you can access the config class on 'self.config'
 

Member Function Documentation

_reset_watchdog()

plugin.healthcheck_watchdog.BoswatchPlugin._reset_watchdog (   self )

protected

Stoppt den aktuellen Timer und startet einen neuen

    def _reset_watchdog(self):
        """Stoppt den aktuellen Timer und startet einen neuen"""
        if self.timer:
            self.timer.cancel()
 
        self.timer = threading.Timer(self.timeout, self._on_timeout)
        self.timer.daemon = True  # Damit der Thread BOSWatch nicht am Beenden hindert
        self.timer.start()
 

_on_timeout()

plugin.healthcheck_watchdog.BoswatchPlugin._on_timeout (   self )

protected

Wird aufgerufen, wenn x Sekunden lang kein Paket kam

    def _on_timeout(self):
        """Wird aufgerufen, wenn x Sekunden lang kein Paket kam"""
        logging.warning("WATCHDOG: Seit %s Sekunden keine Aktivität! Sende KEIN Signal.", self.timeout)
        # Wir senden hier absichtlich NICHTS an Healthchecks.io.
        # Healthchecks.io schlägt Alarm, weil der regelmäßige "Ping" ausbleibt.
 

_send_ping()

plugin.healthcheck_watchdog.BoswatchPlugin._send_ping (   self )

protected

Sendet den 'Alles OK' Ping an Healthchecks.io

    def _send_ping(self):
        """Sendet den 'Alles OK' Ping an Healthchecks.io"""
        threading.Thread(
                target=self._do_ping,
                daemon=True
            ).start()
 

_do_ping()

plugin.healthcheck_watchdog.BoswatchPlugin._do_ping (   self )

protected

Worker: führt den eigentlichen HTTP-Request aus

    def _do_ping(self):
        """Worker: führt den eigentlichen HTTP-Request aus"""
        try:
            requests.get(self.url, timeout=10)
            logging.debug("WATCHDOG: Ping an Healthchecks.io gesendet.")
        except Exception as e:
            logging.error("WATCHDOG: Fehler beim Ping: %s", e)
 

onLoad()

plugin.healthcheck_watchdog.BoswatchPlugin.onLoad

(

self

)

Called by import of the plugin.

Reimplemented from plugin.pluginBase.PluginBase.

    def onLoad(self):
        r"""!Called by import of the plugin"""
        self.timer = None
        # Konfiguration aus der yaml laden
        self.url = self.config.get("ping_url")
        # Standard: 125 Sekunden (2 Min 5 Sek)
        self.timeout = int(self.config.get("timeout", default=125))
        pass
 

setup()

plugin.healthcheck_watchdog.BoswatchPlugin.setup

(

self

)

Called before alarm.

Reimplemented from plugin.pluginBase.PluginBase.

    def setup(self):
        r"""!Called before alarm"""
        self._reset_watchdog()
        pass
 

fms()

plugin.healthcheck_watchdog.BoswatchPlugin.fms	(		self,
			bwPacket
	)

Called on FMS alarm.

Parameters

bwPacket

bwPacket instance Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def fms(self, bwPacket):
        r"""!Called on FMS alarm
 
        @param bwPacket: bwPacket instance
        Remove if not implemented"""
        self._send_ping()
        self._reset_watchdog()
        pass
 

pocsag()

plugin.healthcheck_watchdog.BoswatchPlugin.pocsag	(		self,
			bwPacket
	)

Called on POCSAG alarm.

Parameters

bwPacket

bwPacket instance Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def pocsag(self, bwPacket):
        r"""!Called on POCSAG alarm
 
        @param bwPacket: bwPacket instance
        Remove if not implemented"""
        self._send_ping()
        self._reset_watchdog()
        pass
 

zvei()

plugin.healthcheck_watchdog.BoswatchPlugin.zvei	(		self,
			bwPacket
	)

Called on ZVEI alarm.

Parameters

bwPacket

bwPacket instance Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def zvei(self, bwPacket):
        r"""!Called on ZVEI alarm
 
        @param bwPacket: bwPacket instance
        Remove if not implemented"""
        self._send_ping()
        self._reset_watchdog()
        pass
 

msg()

plugin.healthcheck_watchdog.BoswatchPlugin.msg	(		self,
			bwPacket
	)

Called on MSG packet.

Parameters

bwPacket

bwPacket instance Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def msg(self, bwPacket):
        r"""!Called on MSG packet
 
        @param bwPacket: bwPacket instance
        Remove if not implemented"""
        self._send_ping()
        self._reset_watchdog()
        pass
 

teardown()

plugin.healthcheck_watchdog.BoswatchPlugin.teardown

(

self

)

Called after alarm Remove if not implemented.

Reimplemented from plugin.pluginBase.PluginBase.

    def teardown(self):
        r"""!Called after alarm
        Remove if not implemented"""
        pass
 

onUnload()

plugin.healthcheck_watchdog.BoswatchPlugin.onUnload

(

self

)

Called by destruction of the plugin Remove if not implemented.

Reimplemented from plugin.pluginBase.PluginBase.

    def onUnload(self):
        r"""!Called by destruction of the plugin
        Remove if not implemented"""
        if self.timer:
            self.timer.cancel()
        pass

Field Documentation

timer

plugin.healthcheck_watchdog.BoswatchPlugin.timer

timeout

plugin.healthcheck_watchdog.BoswatchPlugin.timeout

url

plugin.healthcheck_watchdog.BoswatchPlugin.url