107 lines
3.6 KiB
Python
107 lines
3.6 KiB
Python
"""Windows Only.
|
|
|
|
Generic WMI check. This check allows you to specify particular metrics that you
|
|
want from WMI in your configuration. Check wmi.yaml.example in your conf.d
|
|
directory for more details on configuration.
|
|
"""
|
|
try:
|
|
import wmi
|
|
except Exception:
|
|
wmi = None
|
|
|
|
from monagent.collector.checks import AgentCheck
|
|
|
|
UP_METRIC = 'Up'
|
|
SEARCH_WILDCARD = '*'
|
|
|
|
|
|
class WMICheck(AgentCheck):
|
|
|
|
def __init__(self, name, init_config, agent_config):
|
|
AgentCheck.__init__(self, name, init_config, agent_config)
|
|
self.wmi_conns = {}
|
|
|
|
def _get_wmi_conn(self, host, user, password):
|
|
key = "%s:%s:%s" % (host, user, password)
|
|
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):
|
|
if wmi is None:
|
|
raise Exception("Missing 'wmi' module")
|
|
|
|
host = instance.get('host', None)
|
|
user = instance.get('username', None)
|
|
password = instance.get('password', None)
|
|
w = self._get_wmi_conn(host, user, password)
|
|
|
|
wmi_class = instance.get('class')
|
|
metrics = instance.get('metrics')
|
|
filters = instance.get('filters')
|
|
tag_by = instance.get('tag_by')
|
|
|
|
if not wmi_class:
|
|
raise Exception('WMI instance is missing a value for `class` in wmi.yaml')
|
|
|
|
# If there are filters, we need one query per filter.
|
|
if filters:
|
|
for f in filters:
|
|
prop = f.keys()[0]
|
|
search = f.values()[0]
|
|
if SEARCH_WILDCARD in search:
|
|
search = search.replace(SEARCH_WILDCARD, '%')
|
|
wql = "SELECT * FROM %s WHERE %s LIKE '%s'" % (wmi_class, prop, search)
|
|
results = w.query(wql)
|
|
else:
|
|
results = getattr(w, wmi_class)(**f)
|
|
self._extract_metrics(results, metrics, tag_by)
|
|
else:
|
|
results = getattr(w, wmi_class)()
|
|
self._extract_metrics(results, metrics, tag_by)
|
|
|
|
def _extract_metrics(self, results, metrics, tag_by):
|
|
if len(results) > 1 and tag_by is None:
|
|
raise Exception(
|
|
'WMI query returned multiple rows but no `tag_by` value was given. metrics=%s' %
|
|
metrics)
|
|
|
|
for wmi_property, name, mtype in metrics:
|
|
for res in results:
|
|
if wmi_property == UP_METRIC:
|
|
# Special-case metric will just submit 1 for every value
|
|
# returned in the result.
|
|
val = 1
|
|
else:
|
|
val = float(getattr(res, wmi_property))
|
|
|
|
# Grab the tag from the result if there's a `tag_by` value (e.g.: "name:jenkins")
|
|
if tag_by:
|
|
tags = ['%s:%s' % (tag_by.lower(), getattr(res, tag_by))]
|
|
else:
|
|
tags = None
|
|
|
|
try:
|
|
func = getattr(self, mtype)
|
|
except AttributeError:
|
|
raise Exception('Invalid metric type: {0}'.format(mtype))
|
|
|
|
# submit the metric to datadog
|
|
func(name, val, tags=tags)
|
|
|
|
@staticmethod
|
|
def parse_agent_config(agentConfig):
|
|
if not agentConfig.get('WMI'):
|
|
return False
|
|
|
|
config = []
|
|
metrics = agentConfig['WMI']
|
|
for metric_name, wmi_conf in metrics.items():
|
|
wmi_class, wmi_prop = wmi_conf.split(':')
|
|
config.append({
|
|
'class': wmi_class,
|
|
'metrics': [[wmi_prop, metric_name, 'gauge']]
|
|
})
|
|
|
|
return config
|