Some doc updates and several updates and fixes:

 - fix serialization
 - improve arbiter/scheduler WS interface
 - improve retention test

Author: mohierf

alignak/basemodule.py

@@ -351,7 +351,7 @@ def manage_signal(self, sig, frame):  # pylint: disable=unused-argument
 
         if sig == signal.SIGHUP:
             # if SIGHUP, reload configuration in arbiter
-            logger.info("Module are not able to reload their configuration. "
+            logger.info("Modules are not able to reload their configuration. "
                         "Stopping the module...")
 
         logger.info("Request to stop the module")

alignak/daemon.py

@@ -356,7 +356,7 @@ class Daemon(object):
         'alignak_monitor':
             StringProp(default=u''),
         'alignak_monitor_period':
-            IntegerProp(default=30),
+            IntegerProp(default=60),
         'alignak_monitor_username':
             StringProp(default=u''),
         'alignak_monitor_password':
@@ -651,6 +651,8 @@ def __init__(self, name, **kwargs):
             # Make it an absolute path file in the pid directory
             if self.pid_filename != os.path.abspath(self.pid_filename):
                 self.pid_filename = os.path.abspath(os.path.join(self.workdir, self.pid_filename))
+            self.workdir = os.path.dirname(self.pid_filename)
+            print("Daemon working directory: %s" % self.workdir)
         print("Daemon '%s' pid file: %s" % (self.name, self.pid_filename))
         self.pre_log.append(("INFO",
                              "Daemon '%s' pid file: %s" % (self.name, self.pid_filename)))
@@ -1342,6 +1344,7 @@ def check_parallel_run(self):  # pragma: no cover, not with unit tests...
         self.pre_log.append(("DEBUG", "Replacing former instance: %d" % pid))
         try:
             pgid = os.getpgid(pid)
+            # SIGQUIT to terminate and dump core
             os.killpg(pgid, signal.SIGQUIT)
         except os.error as err:
             if err.errno != errno.ESRCH:

alignak/daemons/arbiterdaemon.py

@@ -121,8 +121,9 @@ def __init__(self, **kwargs):
         self.daemons_last_reachable_check = 0
         self.my_daemons = {}
 
-        # My report monitor interface
+        # My report monitor interface and status
         self.my_monitor = None
+        self.my_status = 0
 
         super(Arbiter, self).__init__(kwargs.get('daemon_name', 'Default-Arbiter'), **kwargs)
 
@@ -1546,8 +1547,8 @@ def do_loop_turn(self):
             self.wait_for_master_death()
             return
 
-        if self.alignak_monitor and (self.loop_count % self.alignak_monitor_period == 1):
-            self.push_passive_check(details=True)
+        if self.loop_count % self.alignak_monitor_period == 1:
+            self.get_alignak_status(details=True)
 
         # Maybe an external process requested Alignak stop...
         if self.kill_request:
@@ -1806,7 +1807,7 @@ def get_monitoring_problems(self):
             if not satellite.active:
                 continue
 
-            if 'problems' in satellite.statistics:
+            if satellite.statistics and 'problems' in satellite.statistics:
                 res['problems'][satellite.name] = {
                     '_freshness': satellite.statistics['_freshness'],
                     'problems': satellite.statistics['problems']
@@ -1872,14 +1873,14 @@ def get_livesynthesis(self):
                     'livesynthesis': satellite.statistics['livesynthesis']
                 }
                 # Cumulated live synthesis
-                for prop in res['livesynthesis']['_overall']:
+                for prop in res['livesynthesis']['_overall']['livesynthesis']:
                     if prop in satellite.statistics['livesynthesis']:
                         res['livesynthesis']['_overall']['livesynthesis'][prop] += \
                             satellite.statistics['livesynthesis'][prop]
 
         return res
 
-    def push_passive_check(self, details=False):
+    def get_alignak_status(self, details=False):
         # pylint: disable=too-many-locals
         """Push the alignak overall state as a passive check
 
@@ -2020,6 +2021,22 @@ def push_passive_check(self, details=False):
                 ][state],
                 "long_output": '\n'.join(long_output)
             })
+            log_level = 'info'
+            if state == 1:  # DOWN
+                log_level = 'error'
+            if state == 2:  # UNREACHABLE
+                log_level = 'warning'
+            if self.conf.log_alignak_checks or state > 0:
+                self.add(make_monitoring_log(log_level, 'ALIGNAK CHECK;%s;%d;%s;%s' % (
+                    self.alignak_name, state, res['livestate']['output'],
+                    res['livestate']['long_output']
+                )))
+            if self.my_status != state:
+                self.my_status = state
+                self.add(make_monitoring_log(log_level, 'ALIGNAK ALERT;%s;%d;%s;%s' % (
+                    self.alignak_name, state, res['livestate']['output'],
+                    res['livestate']['long_output']
+                )))
 
         if self.alignak_monitor:
             logger.debug("Pushing Alignak passive check to %s: %s", self.alignak_monitor, res)
@@ -2036,6 +2053,13 @@ def push_passive_check(self, details=False):
         else:
             logger.debug("No configured Alignak monitor to receive: %s", res)
 
+        # Send our own events to the Alignak logger
+        for event in self.events:
+            event.prepare()
+            make_monitoring_log(event.data['level'], event.data['message'],
+                                timestamp=event.creation_time, to_logger=True)
+        self.events = []
+
         return res
 
     def main(self):

alignak/daemons/brokerdaemon.py

@@ -326,7 +326,6 @@ def setup_new_conf(self):
                                                                   rs_conf)
                     my_satellites[new_link.uuid] = new_link
                     logger.info("I got a new %s satellite: %s", link_type[:-1], new_link)
-                    # print("My new %s satellite: %s" % (link_type, new_link))
 
                     new_link.running_id = running_id
                     new_link.external_commands = external_commands

alignak/dispatcher.py

@@ -450,7 +450,7 @@ def get_scheduler_ordered_list(self, realm):
         List is ordered as: alive first, then spare (if any), then dead scheduler links
 
         :param realm: realm we want scheduler from
-        :type realm: object
+        :type realm: alignak.objects.realm.Realm
         :return: sorted scheduler list
         :rtype: list[alignak.objects.schedulerlink.SchedulerLink]
         """

alignak/http/arbiter_interface.py

@@ -26,6 +26,7 @@
 from alignak.http.generic_interface import GenericInterface
 from alignak.util import split_semicolon
 from alignak.external_command import ExternalCommand
+from alignak.misc.serialization import serialize, unserialize
 
 logger = logging.getLogger(__name__)  # pylint: disable=invalid-name
 
@@ -248,7 +249,7 @@ def wait_new_conf(self):
 
     @cherrypy.expose
     @cherrypy.tools.json_out()
-    def get_alignak_status(self, details=False):
+    def alignak_status(self, details=False):
         """Get the overall alignak status
 
         Returns a list of the satellites as in:
@@ -259,19 +260,19 @@ def get_alignak_status(self, details=False):
         }
 
         :param details: Details are required (different from 0)
-        :type details str
+        :type details bool
 
         :return: dict with key *daemon_type* and value list of daemon name
         :rtype: dict
         """
         if details is not False:
             details = bool(details)
 
-        return self.app.push_passive_check(details=details)
+        return self.app.get_alignak_status(details=details)
 
     @cherrypy.expose
     @cherrypy.tools.json_out()
-    def get_satellites_list(self, daemon_type=''):
+    def satellites_list(self, daemon_type=''):
         """Get the arbiter satellite names sorted by type
 
         Returns a list of the satellites as in:
@@ -302,7 +303,7 @@ def get_satellites_list(self, daemon_type=''):
 
     @cherrypy.expose
     @cherrypy.tools.json_out()
-    def get_satellites_configuration(self):
+    def satellites_configuration(self):
         """Return all the configuration data of satellites
 
         :return: dict containing satellites data
@@ -360,7 +361,7 @@ def get_objects_properties(self, table):  # pylint: disable=no-self-use, unused-
         :rtype: list
         """
         return {'_status': u'ERR',
-                '_message': u"Deprecated in favor of the get_stats endpoint."}
+                '_message': u"Deprecated in favor of the stats endpoint."}
 
     @cherrypy.expose
     @cherrypy.tools.json_in()
@@ -377,7 +378,7 @@ def push_external_command(self, command=None):
 
     @cherrypy.expose
     @cherrypy.tools.json_out()
-    def get_monitoring_problems(self):
+    def monitoring_problems(self):
         """Get Alignak detailed monitoring status
 
         This will return an object containing the properties of the `get_id`, plus a `problems`
@@ -434,7 +435,7 @@ def get_monitoring_problems(self):
 
     @cherrypy.expose
     @cherrypy.tools.json_out()
-    def get_livesynthesis(self):
+    def livesynthesis(self):
         """Get Alignak live synthesis
 
         This will return an object containing the properties of the `get_id`, plus a `livesynthesis`
@@ -524,3 +525,78 @@ def get_livesynthesis(self):
         res.update(self.get_start_time())
         res.update(self.app.get_livesynthesis())
         return res
+
+    @cherrypy.expose
+    @cherrypy.tools.json_in()
+    @cherrypy.tools.json_out()
+    def object(self, o_type, o_name='None'):
+        """Get a monitored object from the arbiter.
+
+        Indeed, the arbiter requires the object from its schedulers. It will iterate in
+        its schedulers list until a matching object is found. Else it will return a Json
+        structure containing _status and _message properties.
+
+        When found, the result is a serialized object which is a Json structure containing:
+        - content: the serialized object content
+        - __sys_python_module__: the python class of the returned object
+
+        The Alignak unserialize function of the alignak.misc.serialization package allows
+        to restore the initial object.
+
+        .. code-block:: python
+
+            from alignak.misc.serialization import unserialize
+            from alignak.objects.hostgroup import Hostgroup
+            raw_data = req.get("http://127.0.0.1:7768/object/hostgroup/allhosts")
+            print("Got: %s / %s" % (raw_data.status_code, raw_data.content))
+            assert raw_data.status_code == 200
+            object = raw_data.json()
+            group = unserialize(object, True)
+            assert group.__class__ == Hostgroup
+            assert group.get_name() == 'allhosts'
+
+        As an example:
+        {
+            "__sys_python_module__": "alignak.objects.hostgroup.Hostgroup",
+            "content": {
+                "uuid": "32248642-97dd-4f39-aaa2-5120112a765d",
+                "name": "",
+                "hostgroup_name": "allhosts",
+                "use": [],
+                "tags": [],
+                "alias": "All Hosts",
+                "notes": "",
+                "definition_order": 100,
+                "register": true,
+                "unknown_members": [],
+                "notes_url": "",
+                "action_url": "",
+
+                "imported_from": "unknown",
+                "conf_is_correct": true,
+                "configuration_errors": [],
+                "configuration_warnings": [],
+                "realm": "",
+                "downtimes": {},
+                "hostgroup_members": [],
+                "members": [
+                    "553d47bc-27aa-426c-a664-49c4c0c4a249",
+                    "f88093ca-e61b-43ff-a41e-613f7ad2cea2",
+                    "df1e2e13-552d-43de-ad2a-fe80ad4ba979",
+                    "d3d667dd-f583-4668-9f44-22ef3dcb53ad"
+                ]
+            }
+        }
+
+        :param o_type: searched object type
+        :type o_type: str
+        :param o_name: searched object name (or uuid)
+        :type o_name: str
+        :return: serialized object information
+        :rtype: str
+        """
+        for scheduler_link in self.app.conf.schedulers:
+            o_found = scheduler_link.get_object(o_type, o_name)
+            if isinstance(o_found, dict) and 'content' in o_found:
+                return o_found
+        return {'_status': u'ERR', '_message': u'Required %s not found.' % o_type}

alignak/http/generic_interface.py

@@ -390,7 +390,7 @@ def get_events(self):
     @cherrypy.expose
     @cherrypy.tools.json_in()
     @cherrypy.tools.json_out()
-    def get_stats(self, details=False):
+    def stats(self, details=False):
         """Get statistics and information from the daemon
 
         Returns an object with the daemon identity, the daemon start_time