Add sdl healthcheck to a1's healthcheck
[ric-plt/a1.git] / a1 / controller.py
index b9db142..4210266 100644 (file)
@@ -2,8 +2,8 @@
 Main a1 controller
 """
 # ==================================================================================
-#       Copyright (c) 2019 Nokia
-#       Copyright (c) 2018-2019 AT&T Intellectual Property.
+#       Copyright (c) 2019-2020 Nokia
+#       Copyright (c) 2018-2020 AT&T Intellectual Property.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License");
 #   you may not use this file except in compliance with the License.
@@ -17,16 +17,15 @@ Main a1 controller
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
 # ==================================================================================
-import json
-from flask import Response
 from jsonschema import validate
 from jsonschema.exceptions import ValidationError
 import connexion
-from a1 import get_module_logger
+from mdclogpy import Logger
+from ricsdl.exceptions import RejectedByBackend, NotConnected, BackendError
 from a1 import a1rmr, exceptions, data
 
 
-logger = get_module_logger(__name__)
+mdc_logger = Logger(name=__name__)
 
 
 def _try_func_return(func):
@@ -35,28 +34,21 @@ def _try_func_return(func):
     """
     try:
         return func()
-    except (ValidationError, exceptions.PolicyTypeAlreadyExists, exceptions.CantDeleteNonEmptyType) as exc:
-        logger.exception(exc)
+    except (ValidationError, exceptions.PolicyTypeAlreadyExists, exceptions.CantDeleteNonEmptyType):
         return "", 400
-    except (exceptions.PolicyTypeNotFound, exceptions.PolicyInstanceNotFound) as exc:
-        logger.exception(exc)
+    except (exceptions.PolicyTypeNotFound, exceptions.PolicyInstanceNotFound):
         return "", 404
-    except BaseException as exc:
-        # catch all, should never happen...
-        logger.exception(exc)
-        return Response(status=500)
-
+    except (RejectedByBackend, NotConnected, BackendError):
+        """
+        These are SDL errors. At the time of development here, we do not have a good understanding which of these errors are "try again later it may work"
+        and which are "never going to work". There is some discussion that RejectedByBackend is in the latter category, suggesting it should map to 400,
+        but until we understand the root cause of these errors, it's confusing to clients to give them a 400 (a "your fault" code) because they won't know how to fix
+        For now, we log, and 503, and investigate the logs later to improve the handling/reporting.
+        """
+        # mdc_logger.exception(exc)  # waiting for https://jira.o-ran-sc.org/browse/RIC-39
+        return "", 503
 
-def _gen_body_to_handler(operation, policy_type_id, policy_instance_id, payload=None):
-    """
-    used to create the payloads that get sent to downstream policy handlers
-    """
-    return {
-        "operation": operation,
-        "policy_type_id": policy_type_id,
-        "policy_instance_id": policy_instance_id,
-        "payload": payload,
-    }
+    # let other types of unexpected exceptions blow up and log
 
 
 # Healthcheck
@@ -65,8 +57,15 @@ def _gen_body_to_handler(operation, policy_type_id, policy_instance_id, payload=
 def get_healthcheck():
     """
     Handles healthcheck GET
-    Currently, this basically checks the server is alive.a1rmr
-    """
+    Currently, this checks:
+    1. whether the a1 webserver is up (if it isn't, this won't even be called, so even entering this function confirms it is)
+    2. checks whether the rmr thread is running and has completed a loop recently
+    3. checks that our SDL connection is healthy
+    """
+    if not a1rmr.healthcheck_rmr_thread():
+        return "rmr thread is unhealthy", 500
+    if not data.SDL.healthcheck():
+        return "sdl connection is unhealthy", 500
     return "", 200
 
 
@@ -139,14 +138,7 @@ def get_policy_instance_status(policy_type_id, policy_instance_id):
         3. "NOT IN EFFECT" otherwise (no statuses, or none are OK but not all are deleted)
     """
 
-    def get_status_handler():
-        vector = data.get_policy_instance_statuses(policy_type_id, policy_instance_id)
-        for i in vector:
-            if i == "OK":
-                return "IN EFFECT", 200
-        return "NOT IN EFFECT", 200
-
-    return _try_func_return(get_status_handler)
+    return _try_func_return(lambda: data.get_policy_instance_status(policy_type_id, policy_instance_id))
 
 
 def create_or_replace_policy_instance(policy_type_id, policy_instance_id):
@@ -168,9 +160,8 @@ def create_or_replace_policy_instance(policy_type_id, policy_instance_id):
         # store the instance
         data.store_policy_instance(policy_type_id, policy_instance_id, instance)
 
-        # send rmr (best effort)
-        body = _gen_body_to_handler("CREATE", policy_type_id, policy_instance_id, payload=instance)
-        a1rmr.send(json.dumps(body), message_type=policy_type_id)
+        # queue rmr send (best effort)
+        a1rmr.queue_instance_send(("CREATE", policy_type_id, policy_instance_id, instance))
 
         return "", 202
 
@@ -183,14 +174,10 @@ def delete_policy_instance(policy_type_id, policy_instance_id):
     """
 
     def delete_instance_handler():
-        """
-        here we send out the DELETEs but we don't delete the instance until a GET is called where we check the statuses
-        """
-        data.instance_is_valid(policy_type_id, policy_instance_id)
+        data.delete_policy_instance(policy_type_id, policy_instance_id)
 
-        # send rmr (best effort)
-        body = _gen_body_to_handler("DELETE", policy_type_id, policy_instance_id)
-        a1rmr.send(json.dumps(body), message_type=policy_type_id)
+        # queue rmr send (best effort)
+        a1rmr.queue_instance_send(("DELETE", policy_type_id, policy_instance_id, ""))
 
         return "", 202