def __init__(
self,
storage,
_id=None,
name=None,
namespace='events',
record=None,
logging_level=None
):
self.type = 'selector'
self.storage = storage
if name and not _id:
self._id = self.type + "." + storage.account._id + "." + name
# Default vars
self.namespace = namespace
self.dostate = True
self.data = {}
self.mfilter = {}
self.include_ids = []
self.exclude_ids = []
self.changed = False
self.rk = None
# Ouput replace purpose
self.template_replace = {
0: '[OFF]',
1: '[MINOR]',
2: '[MAJOR]',
3: '[CRITICAL]',
}
# Compute produced event state purpose
self.states_labels = {
'off': 0,
'minor': 1,
'major': 2,
'critical': 3
}
self.logger = getLogger('Selector')
self.context = singleton_per_scope(Context)
self.pbehavior = singleton_per_scope(PBehaviorManager)
# Canopsis filter management for mongo
self.cfilter = Filter()
if logging_level:
self.logger.setLevel(logging_level)
self.load(record.dump())
class Selector(Record):
def __init__(
self,
storage,
_id=None,
name=None,
namespace='events',
record=None,
logging_level=None
):
self.type = 'selector'
self.storage = storage
if name and not _id:
self._id = self.type + "." + storage.account._id + "." + name
# Default vars
self.namespace = namespace
self.dostate = True
self.data = {}
self.mfilter = {}
self.include_ids = []
self.exclude_ids = []
self.changed = False
self.rk = None
# Ouput replace purpose
self.template_replace = {
0: '[OFF]',
1: '[MINOR]',
2: '[MAJOR]',
3: '[CRITICAL]',
}
# Compute produced event state purpose
self.states_labels = {
'off': 0,
'minor': 1,
'major': 2,
'critical': 3
}
self.logger = getLogger('Selector')
self.context = singleton_per_scope(Context)
self.pbehavior = singleton_per_scope(PBehaviorManager)
# Canopsis filter management for mongo
self.cfilter = Filter()
if logging_level:
self.logger.setLevel(logging_level)
self.load(record.dump())
def load(self, dump):
self.logger.debug('Loading selector from record')
mfilter = dump.get('mfilter', '{}')
if type(mfilter) == dict:
self.mfilter = mfilter
elif mfilter is None:
self.mfilter = {}
else:
try:
self.mfilter = loads(mfilter)
except Exception as e:
self.logger.warning(
u'invalid mfilter for selector {} : {} '.format(
dump.get('display_name', 'noname'), e))
self.mfilter = {}
self._id = dump.get('_id')
self.namespace = dump.get('namespace', self.namespace)
self.dostate = dump.get('dostate')
self.dosla = dump.get('dosla')
self.display_name = dump.get('display_name', 'noname')
self.rk = dump.get('rk', self.rk)
self.include_ids = dump.get('include_ids', self.include_ids)
self.exclude_ids = dump.get('exclude_ids', self.exclude_ids)
self.previous_metrics = dump.get('previous_metrics', [])
self.last_publication_date = dump.get('last_publication_date', time())
self.state_when_all_ack = dump.get('state_when_all_ack', 'worststate')
self.output_tpl = self.get_output_tpl()
self.sla_output_tpl = self.get_sla_output_tpl()
if not self.output_tpl:
self.output_tpl = "No output template defined"
self.data = dump
def get_value(self, property_name, default_value):
"""
Allow accessing record property with set of a default value
instead of None value
"""
# Dealing with the old strange record system.
if (property_name not in self.data or
self.data[property_name] is None):
return default_value
else:
return self.data[property_name]
def get_output_tpl(self):
default_template = (
'Off: [OFF], Minor: [MINOR], Major: [MAJOR]' +
', Critical: [CRITICAL]'
)
return self.get_value('output_tpl', default_template)
def get_alert_level(self):
level = self.get_value('alert_level', 'minor')
return level
def get_sla_output_tpl(self):
# Defines default sla template if no one exists
default_sla_template = (
'Off: [OFF]%, Minor: [MINOR]%, Major: [MAJOR]%,' +
' Critical: [CRITICAL]%, Alerts [ALERTS]%, sla start [TSTART]' +
' time available [T_AVAIL], time alert [T_ALERT]'
)
return self.get_value('sla_output_tpl', default_sla_template)
def get_sla_timewindow(self):
result = self.data.get('sla_timewindow', None)
if result is None:
self.logger.info(
u'No timewindow set for selector {}, use default'.format(
self.display_name
))
result = DEFAULT_SLA_TIMEWINDOW
return result
def get_state_at_timewindow_start(self):
state = self.data.get('state_at_timewindow_start', None)
self.logger.debug(u'state_at_timewindow_start {}'.format(state))
return state
def get_previous_selector_state(self):
return self.data.get('previous_selector_state', None)
def get_percent_property(self, property_name, default_value):
"""Allow accessing percent values from a record property.
"""
value = self.get_value(property_name, default_value)
if value >= 0 and value <= 100:
return value
else:
return default_value
def get_sla_warning(self):
return self.get_percent_property('sla_warning', 40)
def get_sla_critical(self):
return self.get_percent_property('sla_critical', 80)
# Build MongoDB query to find every id matching event
def makeMfilter(self):
cfilter = self.cfilter.make_filter(
mfilter=self.mfilter,
includes=self.include_ids,
excludes=self.exclude_ids,
)
query = PBehaviorManager.get_query(behaviors='downtime')
entityids = self.pbehavior.whois(query=query)
entities = self.context.get_entities(list(entityids))
if entities:
downtime = {
'$or': [
{DOWNTIME: False},
{DOWNTIME: {'$exists': False}}
]
}
if '$and' not in cfilter:
cfilter = {'$and': [cfilter]}
cfilter['$and'].append(downtime)
self.logger.debug('Generated cfilter is')
return cfilter
def getState(self):
self.logger.debug("getStates:")
# Build MongoDB filter
mfilter = self.makeMfilter()
if not mfilter:
self.logger.debug(" + Invalid filter")
return ({}, 0, 0, 0, 0)
include_check_types = {'$in': ['check', 'eue', 'selector']}
# Adds default check clause as selector have to be done
# on check event only
# This constraint have to be available for all aggregation queries
check_clause = {'event_type': include_check_types}
if '$and' in mfilter:
mfilter['$and'].append(check_clause)
elif '$or' in mfilter:
mfilter = {'$and': [mfilter, check_clause]}
elif isinstance(mfilter, dict):
mfilter['event_type'] = include_check_types
# Main aggregation query, gets information about
# how many events are in what state
# information are aggregated for output computation
# and does not takes care about acknowleged events
self.logger.debug(" + selector statment agregation {}".format(mfilter))
result = self.storage.get_backend(namespace=self.namespace).aggregate([
{'$match': mfilter},
{'$project': {
'_id': True,
'state': True,
'state_type': True,
'previous_state': True,
}},
{'$group': {
'_id': {
'state': '$state',
'state_type': "$state_type",
'previous_state': "$previous_state",
},
'count': {'$sum': 1}}}])
self.logger.debug(u' + result: {}'.format(result))
states = {}
state = -1
total = 0
for state in result['result']:
key = state['_id']['state']
states[key] = states.get(key, 0) + state['count']
self.logger.debug(u' + states: {}'.format(states))
# Compute worst state
for s in [0, 1, 2, 3]:
if s in states:
state = s
# Aggreagation computing how many events
# are acknowleged with selector mfilter
result = self.storage.get_backend(namespace=self.namespace).aggregate([
{'$match': mfilter},
{
"$group": {
"_id": {"isAck": "$ack.isAck"},
"count": {
"$sum": {
"$cond": ["$ack.isAck", 1, 0]
}
}
}
},
{
"$project": {
"_id": 0,
"ack": "$_id",
"count": 1
}
}
])
# Computes how many event selected in mfilter are ack
if len(result['result']):
ack_count = 0
for ack_result in result['result']:
ack_count += ack_result['count']
else:
ack_count = -1
self.logger.debug(u' + result for ack : {}'.format(result))
infobagotmfilter = deepcopy(mfilter)
# Find worst state for events not ack, mfilter is modified
ack_clause = {'ack.isAck': {'$ne': True}}
if '$and' in mfilter:
mfilter['$and'].append(ack_clause)
elif '$or' in mfilter:
mfilter = {'$and': [mfilter, ack_clause]}
elif isinstance(mfilter, dict):
mfilter['ack.isAck'] = {'$ne': True}
self.logger.debug('Selector mfilter')
# Computes worst state for events that are not acknowleged
result_ack_worst_state = self.storage.get_backend(
namespace=self.namespace
).aggregate([
{'$match': mfilter},
{'$project': {
'_id': True,
'state': True,
}},
{'$group': {
'_id': {
'state': '$state',
},
'count': {'$sum': 1}
}}])
states_for_ack = {}
for state_result in result_ack_worst_state['result']:
key = state_result['_id']['state']
states_for_ack[key] = \
states_for_ack.get(key, 0) + state_result['count']
self.logger.debug(u' + states for ack: {}'.format(states_for_ack))
# Compute worst state
wstate_for_ack = 0
for s in [0, 1, 2, 3]:
if s in states_for_ack:
wstate_for_ack = s
infobagot = self.storage.get_backend(namespace=self.namespace).find({
'$and': [
{'state': 0, 'status': 3},
infobagotmfilter
]}
).count()
if infobagot:
self.logger.info(u'infobagot count : {}'.format(infobagot))
# Bit dirty return value
# states are dict containing event count depending on state for mfilter
# state is the worst state for both ack and not ack events
# ack_count is the count of event that are ack for current mfilter
# wstate_for_ack is the worst state for mfilter
# selected event that are ack
return states, state, ack_count, wstate_for_ack, infobagot
def event(self):
# Get state information form aggregation
states, state, ack_count, wstate_for_ack, infobagot = self.getState()
information = None
if state == -1 and ack_count == -1:
state = 0
information = u'No event matched by selector {}'.format(
self.display_name
)
# Build output
total = 0
total_error = 0
worst_state_with_ack = 0
for s in states:
states[s] = int(states[s])
total += states[s]
if s > 0:
total_error += states[s]
# Computed state when all events are not ack
computed_state = wstate_for_ack
# Is selector produced event acknowleged
if ack_count >= (total_error + infobagot) and ack_count > 0:
send_ack = True
# All matched event were acknowleged,
# then user chose what kind of state to use. it is either:
# The worst state computed from all events
# matched that are ack or not ack
if self.state_when_all_ack == 'worststate':
if state != -1:
computed_state = state
else:
computed_state = 0
# A defined state set by user
if self.state_when_all_ack in self.states_labels:
computed_state = self.states_labels[self.state_when_all_ack]
else:
send_ack = False
# Display purpose
if ack_count == -1:
ack_count = 0
self.logger.debug(u' + state: {}'.format(state))
perf_data_array = []
self.logger.debug(u' + total: {}'.format(total))
# Create perfdata array and generate output data
output = self.output_tpl.replace('[TOTAL]', str(total))
# Producing metrics for ack
if ack_count:
perf_data_array.append({
"metric": 'cps_sel_ack',
"value": ack_count,
"max": total
})
output = output.replace('[ACK]', str(ack_count))
output_data = {}
# Metrics and output computation
for i in [0, 1, 2, 3]:
value = 0
if i in states:
value = states[i]
metric = u'cps_sel_state_{}'.format(i)
output = output.replace(self.template_replace[i], str(value))
output_data[metric] = value
perf_data_array.append({
"metric": metric,
"value": value,
"max": total
})
self.logger.info(u'metric {} : {}'.format(metric, value))
perf_data_array.append({
"metric": "cps_sel_total",
"value": total
})
output_data['total'] = total
# Build Event
event = forger(
connector="canopsis",
connector_name="engine",
event_type="selector",
source_type="component",
component=self.display_name,
state=computed_state,
output=output,
perf_data_array=perf_data_array,
display_name=self.display_name
)
# Build RK
rk = get_routingkey(event)
return (rk, event, send_ack)
def have_to_publish(self, event):
self.logger.debug(u'Previous metrics\n{}'.format(
self.previous_metrics
))
is_different = False
new_metrics = event['perf_data_array']
for metric in new_metrics:
if metric['metric'] not in self.previous_metrics:
is_different = True
break
elif metric['value'] != self.previous_metrics[metric['metric']]:
is_different = True
break
self.logger.debug(u'Metrics are different: {}'.format(is_different))
seconds_since_last_publication = time() - self.last_publication_date
time_to_publish = seconds_since_last_publication > DELTA_PUBLICATION
self.logger.debug(u'Time to publish: {}'.format(time_to_publish))
self.logger.debug(u'Last publication date : {}'.format(
datetime.fromtimestamp(
self.last_publication_date
).strftime('%Y-%m-%d %H:%M:%S')
))
self.logger.debug(u'Seconds since last publication: {}'.format(
seconds_since_last_publication
))
# Do not publish metrics by removing them from event
if not time_to_publish and not is_different:
self.logger.debug('Will not publish selector event')
return False
else:
self.logger.info('Selector event publication')
self.last_publication_date = int(time())
return True
def setUp(self):
self.filter = Filter()
class KnownValues(unittest.TestCase):
def setUp(self):
self.filter = Filter()
def test_add_filter_by_id(self):
print('It should generate an empty filter')
cfilter = self.filter.add_filter_by_id([], True)
self.assertEqual(cfilter, {})
print('It should generate a filter with a single key equal test')
cfilter = self.filter.add_filter_by_id(['keyone'], True)
self.assertEqual(cfilter, {'_id': {'$eq': 'keyone'}})
print('It should generate a filter with a single key not equal test')
cfilter = self.filter.add_filter_by_id(['keyone'], False)
self.assertEqual(cfilter, {'_id': {'$ne': 'keyone'}})
print(
'It should generate a filter with a _id key with nested' +
' dict with noop key and given dict as value')
value = ['keyone', 'keytwo']
cfilter = self.filter.add_filter_by_id(value, True)
test = {'_id': {'$in': ['keyone', 'keytwo']}}
self.assertEqual(cfilter, test)
def test_make_mfilter(self):
mfilter = {'key': 'value'}
value = ['key1', 'key2']
print('It should return an empty filter')
cfilter = self.filter.make_filter()
self.assertEqual(cfilter, {})
print('It should return given filter')
cfilter = self.filter.make_filter(mfilter=mfilter)
self.assertIn('key', cfilter)
self.assertEqual(cfilter['key'], 'value')
self.assertEqual(len(cfilter.keys()), 1)
print('It should return an include filter')
cfilter = self.filter.make_filter(includes=value)
self.assertIn('_id', cfilter)
self.assertEqual(len(cfilter.keys()), 1)
self.assertIn('$in', cfilter['_id'])
self.assertEqual(len(cfilter['_id'].keys()), 1)
self.assertEqual(cfilter['_id']['$in'], value)
print('It should return an exclude filter')
cfilter = self.filter.make_filter(excludes=value)
self.assertIn('_id', cfilter)
self.assertEqual(len(cfilter.keys()), 1)
self.assertIn('$nin', cfilter['_id'])
self.assertEqual(len(cfilter['_id'].keys()), 1)
self.assertEqual(cfilter['_id']['$nin'], value)
print('It should return a compund filter between mfilter and excludes')
cfilter = self.filter.make_filter(mfilter=mfilter, excludes=value)
self.assertIn('$and', cfilter)
self.assertEqual(len(cfilter['$and']), 2)
self.assertEqual(cfilter['$and'][0], mfilter)
self.assertEqual(cfilter['$and'][1], {'_id': {'$nin': value}})
print('It should return a compund filter between mfilter and includes')
cfilter = self.filter.make_filter(mfilter=mfilter, includes=value)
self.assertIn('$or', cfilter)
self.assertEqual(len(cfilter['$or']), 2)
self.assertEqual(cfilter, {'$or': [mfilter, {'_id': {'$in': value}}]})
print('It should return a compund filter between excludes includes')
cfilter = self.filter.make_filter(
excludes=['singlekey'],
includes=value)
test = {'$and': [
{'_id': {'$in': value}},
{'_id': {'$ne': 'singlekey'}}]}
self.assertEqual(cfilter, test)
def setUp(self):
self.filter = Filter()
class KnownValues(unittest.TestCase):
def setUp(self):
self.filter = Filter()
def test_add_filter_by_id(self):
print('It should generate an empty filter')
cfilter = self.filter.add_filter_by_id([], True)
self.assertEqual(cfilter, {})
print('It should generate a filter with a single key equal test')
cfilter = self.filter.add_filter_by_id(['keyone'], True)
self.assertEqual(cfilter, {'_id': {'$eq': 'keyone'}})
print('It should generate a filter with a single key not equal test')
cfilter = self.filter.add_filter_by_id(['keyone'], False)
self.assertEqual(cfilter, {'_id': {'$ne': 'keyone'}})
print(
'It should generate a filter with a _id key with nested' +
' dict with noop key and given dict as value')
value = ['keyone', 'keytwo']
cfilter = self.filter.add_filter_by_id(value, True)
test = {'_id': {'$in': ['keyone', 'keytwo']}}
self.assertEqual(cfilter, test)
def test_make_mfilter(self):
mfilter = {'key': 'value'}
value = ['key1', 'key2']
print('It should return an empty filter')
cfilter = self.filter.make_filter()
self.assertEqual(cfilter, {})
print('It should return given filter')
cfilter = self.filter.make_filter(mfilter=mfilter)
self.assertIn('key', cfilter)
self.assertEqual(cfilter['key'], 'value')
self.assertEqual(len(cfilter.keys()), 1)
print('It should return an include filter')
cfilter = self.filter.make_filter(includes=value)
self.assertIn('_id', cfilter)
self.assertEqual(len(cfilter.keys()), 1)
self.assertIn('$in', cfilter['_id'])
self.assertEqual(len(cfilter['_id'].keys()), 1)
self.assertEqual(cfilter['_id']['$in'], value)
print('It should return an exclude filter')
cfilter = self.filter.make_filter(excludes=value)
self.assertIn('_id', cfilter)
self.assertEqual(len(cfilter.keys()), 1)
self.assertIn('$nin', cfilter['_id'])
self.assertEqual(len(cfilter['_id'].keys()), 1)
self.assertEqual(cfilter['_id']['$nin'], value)
print('It should return a compund filter between mfilter and excludes')
cfilter = self.filter.make_filter(mfilter=mfilter, excludes=value)
self.assertIn('$and', cfilter)
self.assertEqual(len(cfilter['$and']), 2)
self.assertEqual(cfilter['$and'][0], mfilter)
self.assertEqual(cfilter['$and'][1], {'_id': {'$nin': value}})
print('It should return a compund filter between mfilter and includes')
cfilter = self.filter.make_filter(mfilter=mfilter, includes=value)
self.assertIn('$or', cfilter)
self.assertEqual(len(cfilter['$or']), 2)
self.assertEqual(cfilter, {'$or': [mfilter, {'_id': {'$in': value}}]})
print('It should return a compund filter between excludes includes')
cfilter = self.filter.make_filter(
excludes=['singlekey'],
includes=value)
test = {'$and': [
{'_id': {'$in': value}},
{'_id': {'$ne': 'singlekey'}}]}
self.assertEqual(cfilter, test)