Conor/windows services

checks.d/windows_service.py

@@ -0,0 +1,66 @@
+""" Collect status information for Windows services
+"""
+# project
+from checks import AgentCheck
+
+# 3rd party
+import wmi
+
+class WindowsService(AgentCheck):
+    STATE_TO_VALUE = {
+        'Stopped': AgentCheck.CRITICAL,
+        'Start Pending': AgentCheck.WARNING,
+        'Stop Pending': AgentCheck.WARNING,
+        'Running': AgentCheck.OK,
+        'Continue Pending': AgentCheck.WARNING,
+        'Pause Pending': AgentCheck.WARNING,
+        'Paused': AgentCheck.WARNING,
+        'Unknown': AgentCheck.UNKNOWN
+    }
+
+    def __init__(self, name, init_config, agentConfig):
+        AgentCheck.__init__(self, name, init_config, agentConfig)
+        self.wmi_conns = {}
+
+    def _get_wmi_conn(self, host, user, password):
+        key = "%s:%s" % (host, user)
+        if key not in self.wmi_conns:
+            self.wmi_conns[key] = wmi.WMI(host, user=user, password=password)
+        return self.wmi_conns[key]
+
+    def check(self, instance):
+        # Connect to the WMI provider
+        host = instance.get('host', None)
+        user = instance.get('username', None)
+        password = instance.get('password', None)
+        tags = instance.get('tags') or []
+        services = instance.get('services') or []
+        w = self._get_wmi_conn(host, user, password)
+
+        if len(services) == 0:
+            raise Exception('No services defined in windows_service.yaml')
+
+        for service in services:
+            results = w.Win32_Service(name=service)
+            if len(results) == 0:
+                self.warning(u"No services found matching %s" % service)
+                continue
+            elif len(results) > 1:
+                self.warning(u"Multiple services found matching %s" % service)
+                continue
+
+            wmi_service = results[0]
+            self._create_service_check(wmi_service, host)
+
+    def _create_service_check(self, wmi_service, host):
+        """ Given an instance of a wmi_object from Win32_Service, write any
+            performance counters to be gathered and flushed by the collector.
+        """
+        if host == ".":
+            host_name = self.hostname
+        else:
+            host_name = host
+
+        tags = [u'service:%s' % wmi_service.Name, u'host:%s' % host_name]
+        state_value = self.STATE_TO_VALUE.get(wmi_service.State, AgentCheck.UNKNOWN)
+        self.service_check('windows_service.state', state_value, tags=tags)

conf.d/windows_service.yaml.example

@@ -0,0 +1,23 @@
+init_config:
+
+instances:
+    # For each instance you define what host to connect to (defaulting to the
+    # current host) as well as a list of services you care about. The service
+    # names should match the Service name in the properties and NOT the display
+    # name in the services.msc list.
+    #
+    # If you want to check services on a remote host, you have to specify a
+    # hostname and (optional) credentials
+    #
+    #-  host: MYREMOTESERVER
+    #   username: MYREMOTESERVER\fred
+    #   password: mysecretpassword
+    #   tags:
+    #       - fredserver
+    #
+    # The sample configuration will monitor the WMI Performance Adapter service,
+    # named "wmiApSrv" in the service properties.
+    #
+    -   host: . # "." means the current host
+        services:
+            - wmiApSrv