feature/sensor-to-check-if-api-is-down

CHANGES.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.8.0
+
+- Added sensor to check if the orion API is down and fires a trigger to restart the service if it is
+  Contributed by John Schoewe (Encore Technologies)
+
 ## 0.7.11
 
 - Added action to enable and disable maintenance mode on a given node

pack.yaml

@@ -8,7 +8,7 @@ keywords:
    - ncm
    - npm
    - monitoring
-version: 0.7.11
+version: 0.8.0
 python_versions:
     - "2"
     - "3"

sensors/solarwinds_api_check.py

@@ -0,0 +1,48 @@
+from orionsdk import SwisClient
+from requests.exceptions import ConnectionError
+from st2reactor.sensor.base import PollingSensor
+
+
+class SolarwindsApiCheck(PollingSensor):
+    """
+    This sensor is used to fire a trigger when it detects that the API is down
+    """
+
+    def setup(self):
+        server = self._config['orion_host']
+        user = self._config['orion_user']
+        passwd = self._config['orion_password']
+
+        self._logger = self.sensor_service.get_logger(name=self.__class__.__name__)
+
+        self.client = SwisClient(server, user, passwd)
+        self._logger.debug(self.client)
+
+        pass
+
+    def poll(self):
+        try:
+            self._logger.debug('SolarWinds API check poll')
+
+            # We need to run a query because the connection itself will not return an error
+            swql = """SELECT Name, MethodName, EntityName
+            FROM Metadata.Verb where CanInvoke=@CanInvoke"""
+            kargs = {'CanInvoke': True}
+            orion_data = self.client.query(swql, **kargs)
+            self._logger.debug("SolarWinds API query successful")
+            self._logger.debug(orion_data)
+        except ConnectionError:
+            self._logger.debug('Dispatch SolarWinds API down trigger')
+            self.sensor_service.dispatch(trigger='orion.solarwinds_api_down')
+
+    def cleanup(self):
+        pass
+
+    def add_trigger(self, trigger):
+        pass
+
+    def update_trigger(self, trigger):
+        pass
+
+    def remove_trigger(self, trigger):
+        pass

sensors/solarwinds_api_check.yaml

@@ -0,0 +1,9 @@
+---
+  class_name: "SolarwindsApiCheck"
+  entry_point: "solarwinds_api_check.py"
+  description: "Verify that the SolarWinds API is up and accepting connections."
+  poll_interval: 30
+  trigger_types:
+    -
+      name: "solarwinds_restart"
+      description: "An example trigger."

triggers/solarwinds_api_down.yaml

@@ -0,0 +1,4 @@
+name: solarwinds_api_down
+description: Trigger that gets fired when the orion API is unreachable
+payload_schema:
+  type: object