Add: BP rules: host/service in downtime as object with OK state

Author: Flavien Peyre

doc/source/06_medium/business-rules.rst

@@ -482,12 +482,12 @@ Imagine you want to build a consolidated service which notifications contain lin
 
 The resulting output would look like ``Down web services: link1 link2 link3 ...`` where ``linkN`` are urls leading to the problem in the WebUI.
 
-Acknowledge management
+Acknowledge and downtime management
 ======================
 
-By default, if we acknowledge an element, it conserves its state to determine the status of our aggregated service.
-In some cases, we want that an acknowledge element is considered as if it was in Ok/Up state for a business rule.
+By default, if we acknowledge or downtime an element, it conserves its state to determine the status of our aggregated service.
+In some cases, we want that an acknowledge/downtime element is considered as if it was in Ok/Up state for a business rule.
 
-To enable this feature, simply set `business_rule_ack_as_ok`` to ``1``..
+To enable this feature, simply set `business_rule_ack_as_ok`` to ``1`` for acknowledge, `business_rule_downtime_as_ok`` to ``1`` for downtime  ..
 
 .. _ticket: https://github.com/naparuba/shinken/issues/509

doc/source/08_configobjects/host.rst

@@ -79,6 +79,7 @@ labels                                     *labels*
 business_rule_output_template              *template*
 business_rule_smart_notifications          [0/1]
 business_rule_downtime_as_ack              [0/1]
+business_rule_downtime_as_ok               [0/1]
 business_rule_ack_as_ok                    [0/1]
 business_rule_host_notification_options    [d,u,r,f,s]
 business_rule_service_notification_options [w,u,c,r,f,s]
@@ -328,6 +329,9 @@ business_rule_downtime_as_ack
 business_rule_ack_as_ok
   By default, acknowledging an underlying problem doesn't change its state for the :ref:`business rules <medium/business-rules>` evaluation. This variable allows to treat acknowledged services or hosts as if their are in an Ok/Up state.
 
+business_rule_downtime_as_ok
+  By default, marking an underlying problem as downtime doesn't change its state for the :ref:`business rules <medium/business-rules>` evaluation. This variable allows to treat services or hosts in downtime as if their are in an Ok/Up state.
+
 business_rule_host_notification_options
   This option allows to enforce :ref:`business rules <medium/business-rules>` underlying hosts notification options to easily compose a consolidated meta check. This is especially useful for business rules relying on grouping expansion.
 

doc/source/08_configobjects/service.rst

@@ -71,6 +71,7 @@ business_rule_output_template              *template*
 business_rule_smart_notifications          [0/1]
 business_rule_downtime_as_ack              [0/1]
 business_rule_ack_as_ok                    [0/1]
+business_rule_downtime_as_ok               [0/1]
 business_rule_host_notification_options    [d,u,r,f,s]
 business_rule_service_notification_options [w,u,c,r,f,s]
 snapshot_enabled                           [0/1]
@@ -406,6 +407,9 @@ business_rule_downtime_as_ack
 business_rule_ack_as_ok
   By default, acknowledging an underlying problem doesn't change its state for the :ref:`business rules <medium/business-rules>` evaluation. This variable allows to treat acknowledged services or hosts as if their are in an Ok/Up state.
 
+business_rule_downtime_as_ok
+  By default, marking an underlying problem as downtime doesn't change its state for the :ref:`business rules <medium/business-rules>` evaluation. This variable allows to treat services or hosts in downtime as if their are in an Ok/Up state.
+
 business_rule_host_notification_options
   This option allows to enforce :ref:`business rules <medium/business-rules>` underlying hosts notification options to easily compose a consolidated meta check. This is especially useful for business rules relying on grouping expansion.
 

shinken/dependencynode.py

@@ -45,7 +45,7 @@
 
 
 class DependencyNode(object):
-    def __init__(self, ack_as_ok=False):
+    def __init__(self, ack_as_ok=False, downtime_as_ok=False):
         self.operand = None
         self.sons = []
         # Of: values are a triple OK,WARN,CRIT
@@ -54,6 +54,7 @@ def __init__(self, ack_as_ok=False):
         self.configuration_errors = []
         self.not_value = False
         self.ack_as_ok = ack_as_ok
+        self.downtime_as_ok = downtime_as_ok
 
     def __str__(self):
         return "Op:'%s' Val:'%s' Sons:'[%s]' IsNot:'%s'" % (self.operand, self.of_values,
@@ -97,6 +98,9 @@ def get_simple_node_state(self):
         # If our node is acknowledged and business_rule_ack_as_ok is true, state is ok/up
         if self.sons[0].problem_has_been_acknowledged and self.ack_as_ok:
             state = 0
+        # If our node is downtimed and business_rule_downtime_as_ok is true, state is ok/up
+        if self.sons[0].in_scheduled_downtime and self.downtime_as_ok:
+            state = 0
         # Maybe we are a NOT node, so manage this
         if self.not_value:
             # We inverse our states
@@ -328,7 +332,7 @@ def eval_xof_pattern(self, node, pattern):
     # Evaluate a complex correlation expression, such as an &, |, nested
     # expressions in par, and so on.
     def eval_complex_cor_pattern(self, pattern, hosts, services, running=False):
-        node = DependencyNode(self.bound_item.business_rule_ack_as_ok)
+        node = DependencyNode(self.bound_item.business_rule_ack_as_ok, self.bound_item.business_rule_downtime_as_ok)
         pattern = self.eval_xof_pattern(node, pattern)
 
         in_par = False
@@ -446,7 +450,7 @@ def eval_complex_cor_pattern(self, pattern, hosts, services, running=False):
     # Evaluate a simple correlation expression, such as a host, a host + a
     # service, or expand a host or service expression.
     def eval_simple_cor_pattern(self, pattern, hosts, services, running=False):
-        node = DependencyNode(self.bound_item.business_rule_ack_as_ok)
+        node = DependencyNode(self.bound_item.business_rule_ack_as_ok, self.bound_item.business_rule_downtime_as_ok)
         pattern = self.eval_xof_pattern(node, pattern)
 
         # print "Try to find?", pattern
@@ -519,7 +523,7 @@ def find_object(self, pattern, hosts, services):
     # using (host|service)group membership, regex, or labels as item selector.
     def expand_expression(self, pattern, hosts, services, running=False):
         error = None
-        node = DependencyNode(self.bound_item.business_rule_ack_as_ok)
+        node = DependencyNode(self.bound_item.business_rule_ack_as_ok, self.bound_item.business_rule_downtime_as_ok)
         node.operand = '&'
         elts = [e.strip() for e in pattern.split(',')]
         # If host_name is empty, use the host_name the business rule is bound to
@@ -561,7 +565,7 @@ def expand_expression(self, pattern, hosts, services, running=False):
         # Creates dependency node subtree
         for item in items:
             # Creates a host/service node
-            son = DependencyNode(self.bound_item.business_rule_ack_as_ok)
+            son = DependencyNode(self.bound_item.business_rule_ack_as_ok, self.bound_item.business_rule_downtime_as_ok)
             son.operand = item.__class__.my_type
             son.sons.append(item)
             # Appends it to wrapping node

shinken/objects/host.py

@@ -214,6 +214,9 @@ class Host(SchedulingItem):
         # Treat acknowledged host/service like an Ok/Up state in a business rule
         'business_rule_ack_as_ok':
             BoolProp(default=False, fill_brok=['full_status']),
+        # Treat downtimed host/service like an Ok/Up state in a business rule
+        'business_rule_downtime_as_ok':
+            BoolProp(default=False, fill_brok=['full_status']),
         # Enforces child nodes notification options
         'business_rule_host_notification_options':
             ListProp(default=[], fill_brok=['full_status']),

shinken/objects/service.py

@@ -201,6 +201,9 @@ class Service(SchedulingItem):
         # Treat acknowledged host/service like an Ok/Up state in a business rule
         'business_rule_ack_as_ok':
             BoolProp(default=False, fill_brok=['full_status']),
+        # Treat host/service in downtime like an Ok/Up state in a business rule
+        'business_rule_downtime_as_ok':
+            BoolProp(default=False, fill_brok=['full_status']),
         # Enforces child nodes notification options
         'business_rule_host_notification_options':
             ListProp(default=[], fill_brok=['full_status'], split_on_coma=True),

test/etc/business_correlator/hosts.cfg

@@ -17,6 +17,7 @@ define host{
   retain_status_information      1
   retry_interval                 1
   business_rule_ack_as_ok        1
+  business_rule_downtime_as_ok   1
 }
 
 define host{

test/etc/business_correlator/services.cfg

@@ -23,6 +23,7 @@ define service{
   retain_status_information      1
   retry_interval                 1
   business_rule_ack_as_ok        1
+  business_rule_downtime_as_ok   1
 }