Merge pull request #684 from Survey845/issue-471

Improving Exception Observability

Author: yeasy

src/api-engine/api/lib/agent/docker/handler.py

@@ -56,6 +56,7 @@ def create(self, info):
             else:
                 return None
         except Exception as e:
+            LOG.exception("DockerAgent Not Created")
             raise e
 
     def delete(self, *args, **kwargs):
@@ -66,6 +67,7 @@ def delete(self, *args, **kwargs):
             else:
                 raise response.reason
         except Exception as e:
+            LOG.exception("DockerAgent Not Deleted")
             raise e
 
     def start(self, *args, **kwargs):
@@ -76,6 +78,7 @@ def start(self, *args, **kwargs):
             else:
                 raise response.reason
         except Exception as e:
+            LOG.exception("DockerAgent Not Started")
             raise e
 
     def restart(self, *args, **kwargs):
@@ -86,6 +89,7 @@ def restart(self, *args, **kwargs):
             else:
                 raise response.reason
         except Exception as e:
+            LOG.exception("DockerAgent Not Restarted")
             raise e
 
     def stop(self, *args, **kwargs):
@@ -96,6 +100,7 @@ def stop(self, *args, **kwargs):
             else:
                 raise response.reason
         except Exception as e:
+            LOG.exception("DockerAgent Not Stopped")
             raise e
 
     def get(self, *args, **kwargs):
@@ -106,6 +111,7 @@ def get(self, *args, **kwargs):
             else:
                 raise response.reason
         except Exception as e:
+            LOG.exception("DockerAgent Not Found")
             raise e
 
     def update_config(self, config_file, node_type):
@@ -123,4 +129,5 @@ def update_config(self, config_file, node_type):
             else:
                 raise response.reason
         except Exception as e:
+            LOG.exception("Config Update Failed")
             raise e

src/api-engine/api/routes/agent/views.py

@@ -205,7 +205,7 @@ def retrieve(self, request, pk=None):
             if agent.type == HostType.Kubernetes.name.lower():
                 k8s_config = KubernetesConfig.objects.get(agent=agent)
         except ObjectDoesNotExist:
-            raise ResourceNotFound
+            raise ResourceNotFound("Agent not found")
         else:
             data = agent.__dict__
             if k8s_config:
@@ -234,7 +234,7 @@ def update(self, request, pk=None):
                 # organization = request.user.organization
                 try:
                     if Agent.objects.get(name=name):
-                        raise ResourceExists
+                        raise ResourceExists("Agent Exists")
                 except ObjectDoesNotExist:
                     pass
                 Agent.objects.filter(id=pk).update(name=name)
@@ -266,7 +266,7 @@ def partial_update(self, request, pk=None):
                 try:
                     agent = Agent.objects.get(id=pk)
                 except ObjectDoesNotExist:
-                    raise ResourceNotFound
+                    raise ResourceNotFound("Agent not found")
                 else:
                     if name:
                         agent.name = name
@@ -308,10 +308,10 @@ def destroy(self, request, pk=None):
                 else:
                     raise CustomError("User can't delete agent！")
             except ObjectDoesNotExist:
-                raise ResourceNotFound
+                raise ResourceNotFound("Agent not found")
             else:
                 if agent.node.count():
-                    raise ResourceInUse
+                    raise ResourceInUse("Agent in use")
                 agent.delete()
 
                 return Response(ok(None), status=status.HTTP_202_ACCEPTED)
@@ -357,7 +357,7 @@ def apply(self, request):
                     schedulable=True,
                 ).order_by("capacity")
                 if len(agents) == 0:
-                    raise NoResource
+                    raise NoResource("No Agent")
 
                 agent = agents[0]
                 agent.organization = request.user.organization
@@ -371,6 +371,7 @@ def apply(self, request):
         except NoResource as e:
             raise e
         except Exception as e:
+            LOG.exception("Agent Not Applied")
             return Response(
                 err(e.args), status=status.HTTP_400_BAD_REQUEST
             )
@@ -399,7 +400,7 @@ def release(self, request, pk=None):
                         id=pk, organization=request.user.organization
                     )
             except ObjectDoesNotExist:
-                raise ResourceNotFound
+                raise ResourceNotFound("Agent not found")
             else:
                 agent.organization = None
                 agent.save()

src/api-engine/api/routes/chaincode/views.py

@@ -70,6 +70,7 @@ def _read_cc_pkg(self, pk, filename, ccpackage_path):
             chaincode.save()
 
         except Exception as e:
+            LOG.exception("Could not read Chaincode Package")
             raise e
 
     @swagger_auto_schema(
@@ -208,6 +209,7 @@ def package(self, request):
                     threading.Thread(target=self._read_cc_pkg,
                                         args=(uuid, file.name, ccpackage_path)).start()
                 except Exception as e:
+                    LOG.exception("Failed Threading")
                     raise e
 
                 return Response(
@@ -239,7 +241,7 @@ def install(self, request):
             org = request.user.organization
             qs = Node.objects.filter(type="peer", organization=org)
             if not qs.exists():
-                raise ResourceNotFound
+                raise ResourceNotFound("Peer Does Not Exist")
             peer_node = qs.first()
 
             envs = init_env_vars(peer_node, org)
@@ -267,7 +269,7 @@ def query_installed(self, request):
             org = request.user.organization
             qs = Node.objects.filter(type="peer", organization=org)
             if not qs.exists():
-                raise ResourceNotFound
+                raise ResourceNotFound("Peer Does Not Exist")
             peer_node = qs.first()
             envs = init_env_vars(peer_node, org)
 
@@ -297,7 +299,7 @@ def get_installed_package(self, request):
             org = request.user.organization
             qs = Node.objects.filter(type="peer", organization=org)
             if not qs.exists():
-                raise ResourceNotFound
+                raise ResourceNotFound("Peer Does Not Exist")
             peer_node = qs.first()
             envs = init_env_vars(peer_node, org)
 
@@ -336,13 +338,13 @@ def approve_for_my_org(self, request):
                 org = request.user.organization
                 qs = Node.objects.filter(type="orderer", organization=org)
                 if not qs.exists():
-                    raise ResourceNotFound
+                    raise ResourceNotFound("Orderer Does Not Exist")
                 orderer_node = qs.first()
                 orderer_url = orderer_node.name + "." + org.name.split(".", 1)[1] + ":" + str(7050)
 
                 qs = Node.objects.filter(type="peer", organization=org)
                 if not qs.exists():
-                    raise ResourceNotFound
+                    raise ResourceNotFound("Peer Does Not Exist")
                 peer_node = qs.first()
                 envs = init_env_vars(peer_node, org)
 
@@ -371,7 +373,7 @@ def query_approved(self, request):
             org = request.user.organization
             qs = Node.objects.filter(type="peer", organization=org)
             if not qs.exists():
-                raise ResourceNotFound
+                raise ResourceNotFound("Peer Does Not Exist")
             peer_node = qs.first()
             envs = init_env_vars(peer_node, org)
 
@@ -414,7 +416,7 @@ def check_commit_readiness(self, request):
                 org = request.user.organization
                 qs = Node.objects.filter(type="orderer", organization=org)
                 if not qs.exists():
-                    raise ResourceNotFound
+                    raise ResourceNotFound("Orderer Does Not Exist")
                 orderer_node = qs.first()
 
                 orderer_tls_dir = "{}/{}/crypto-config/ordererOrganizations/{}/orderers/{}/msp/tlscacerts" \
@@ -428,7 +430,7 @@ def check_commit_readiness(self, request):
 
                 qs = Node.objects.filter(type="peer", organization=org)
                 if not qs.exists():
-                    raise ResourceNotFound
+                    raise ResourceNotFound("Peer Does Not Exist")
                 peer_node = qs.first()
                 envs = init_env_vars(peer_node, org)
 
@@ -470,7 +472,7 @@ def commit(self, request):
                 org = request.user.organization
                 qs = Node.objects.filter(type="orderer", organization=org)
                 if not qs.exists():
-                    raise ResourceNotFound
+                    raise ResourceNotFound("Orderer Does Not Exist")
                 orderer_node = qs.first()
 
                 orderer_tls_dir = "{}/{}/crypto-config/ordererOrganizations/{}/orderers/{}/msp/tlscacerts" \
@@ -483,7 +485,7 @@ def commit(self, request):
 
                 qs = Node.objects.filter(type="peer", organization=org)
                 if not qs.exists():
-                    raise ResourceNotFound
+                    raise ResourceNotFound("Peer Does Not Exist")
                 peer_node = qs.first()
                 envs = init_env_vars(peer_node, org)
 
@@ -530,7 +532,7 @@ def query_committed(self, request):
             org = request.user.organization
             qs = Node.objects.filter(type="peer", organization=org)
             if not qs.exists():
-                raise ResourceNotFound
+                raise ResourceNotFound("Peer Does Not Exist")
             peer_node = qs.first()
             envs = init_env_vars(peer_node, org)
             peer_channel_cli = PeerChainCode(**envs)
@@ -539,6 +541,7 @@ def query_committed(self, request):
             if code != 0:
                 return Response(err("query committed failed."), status=status.HTTP_400_BAD_REQUEST)
         except Exception as e:
+            LOG.exception("Could Not Commit Query")
             return Response(
                 err(e.args), status=status.HTTP_400_BAD_REQUEST
             )

src/api-engine/api/routes/channel/views.py

@@ -188,6 +188,7 @@ def retrieve(self, request, pk=None):
             return Response(ok(response.data), status=status.HTTP_200_OK)
 
         except ObjectDoesNotExist:
+            LOG.exception("channel not found")
             raise ResourceNotFound
 
     @swagger_auto_schema(
@@ -217,7 +218,7 @@ def update(self, request, pk=None):
                 try:
                     config = data["config"]["channel_group"]["groups"][org_type]["groups"][msp_id]
                 except KeyError:
-                    LOG.error("config file not found")
+                    LOG.exception("config file not found")
                     raise ResourceNotFound
 
                 try:
@@ -226,7 +227,7 @@ def update(self, request, pk=None):
                         LOG.info("load current config success")
                         current_config = json.load(f)
                 except FileNotFoundError:
-                    LOG.error("current config file not found")
+                    LOG.exception("current config file not found")
                     raise ResourceNotFound
 
                 # Create a new org
@@ -314,6 +315,7 @@ def update(self, request, pk=None):
                 LOG.info("new_org save success")
                 return Response(ok(None), status=status.HTTP_202_ACCEPTED)
             except ObjectDoesNotExist:
+                LOG.exception("channel not found")
                 raise ResourceNotFound
 
     @swagger_auto_schema(
@@ -361,6 +363,7 @@ def get_channel_org_config(self, request, pk=None):
             )
             return Response(data=data, status=status.HTTP_200_OK)
         except ObjectDoesNotExist:
+            LOG.exception("channel org not found")
             raise ResourceNotFound
 
 def validate_nodes(nodes):

src/api-engine/api/routes/file/views.py

@@ -55,7 +55,7 @@ def list(self, request):
             per_page = serializer.validated_data.get("per_page")
 
             if organization is not None and not request.user.is_operator:
-                raise PermissionDenied
+                raise PermissionDenied("Non-Operator Request Denied")
             query_filter = {}
             if name:
                 query_filter.update({"name__icontains": name})

src/api-engine/api/routes/general/views.py

@@ -121,6 +121,7 @@ def _conversion_msp_tls(self, name):
             with open("{}tls.zip".format(dir_org), "rb") as f_tls:
                 tls = base64.b64encode(f_tls.read())
         except Exception as e:
+            LOG.exception("Conversion Failed")
             raise e
 
         return msp, tls
@@ -169,7 +170,7 @@ def post(self, request, *args, **kwargs):
                         status=200,
                     )
             except TokenError:
-                LOG.warn("invalid token error")
+                LOG.exception("invalid token error")
                 return Response(
                     data=err(msg="invalid token"),
                     status=401

src/api-engine/api/routes/network/views.py

@@ -53,6 +53,7 @@ def _genesis2base64(self, network):
                 block = base64.b64encode(f_block.read())
             return block
         except Exception as e:
+            LOG.exception("Genesis to Base64 Failed")
             raise e
 
     @swagger_auto_schema(
@@ -138,6 +139,7 @@ def _agent_params(self, pk):
             info["ports"] = ports
             return info
         except Exception as e:
+            LOG.exception("Could Not Get Params")
             raise e
 
     def _start_node(self, pk):
@@ -156,6 +158,7 @@ def _start_node(self, pk):
             else:
                 raise ResourceNotFound(detail="Container Not Built")
         except Exception as e:
+            LOG.exception("Node Not Started")
             raise e
 
     @swagger_auto_schema(
@@ -199,6 +202,7 @@ def create(self, request):
                         threading.Thread(target=self._start_node,
                                          args=(node.id,)).start()
                     except Exception as e:
+                        LOG.exception("Network Not Created")
                         raise e
 
                 response = NetworkIDSerializer(data=network.__dict__)
@@ -207,6 +211,7 @@ def create(self, request):
                         ok(response.validated_data), status=status.HTTP_201_CREATED
                     )
         except ResourceExists as e:
+            LOG.exception("Network Exists")
             raise e
         except Exception as e:
             return Response(