insightconnect-plugin-runtime 5.3.0__tar.gz → 5.3.1__tar.gz

{insightconnect-plugin-runtime-5.3.0/insightconnect_plugin_runtime.egg-info → insightconnect-plugin-runtime-5.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 5.3.0
+Version: 5.3.1
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -212,6 +212,7 @@ after cloning this repository.
 
 ## Changelog
 
+* 5.3.1 - New logging added to the beginning and end of a task | New logging when an exception is instantiated.
 * 5.3.0 - Update base images to pull Python 3.9.18 | python packages bump | rename image to drop python minor version.
 * 5.2.4 - Extended logging with OrgID and IntID
 * 5.2.3 - Extended logging in AWSClient

{insightconnect-plugin-runtime-5.3.0 → insightconnect-plugin-runtime-5.3.1}/README.md

@@ -183,6 +183,7 @@ after cloning this repository.
 
 ## Changelog
 
+* 5.3.1 - New logging added to the beginning and end of a task | New logging when an exception is instantiated.
 * 5.3.0 - Update base images to pull Python 3.9.18 | python packages bump | rename image to drop python minor version.
 * 5.2.4 - Extended logging with OrgID and IntID
 * 5.2.3 - Extended logging in AWSClient

{insightconnect-plugin-runtime-5.3.0 → insightconnect-plugin-runtime-5.3.1}/insightconnect-plugin-swagger.json

@@ -451,7 +451,7 @@
     "PluginInfo": {
       "type": "object",
       "properties": {
-        "vendor": {
+        "sdk_version": {
           "type": "string"
         },
         "title": {
@@ -461,24 +461,27 @@
           "type": "integer",
           "format": "int32"
         },
-        "plugin_spec_version": {
+        "version": {
           "type": "string"
         },
-        "name": {
+        "vendor": {
           "type": "string"
         },
-        "version": {
-          "type": "string"
+        "threads": {
+          "type": "integer",
+          "format": "int32"
         },
-        "support": {
+        "description": {
           "type": "string"
         },
-        "description": {
+        "name": {
           "type": "string"
         },
-        "threads": {
-          "type": "integer",
-          "format": "int32"
+        "enable_cache": {
+          "type": "boolean"
+        },
+        "support": {
+          "type": "string"
         },
         "tags": {
           "type": "array",
@@ -486,17 +489,17 @@
             "type": "string"
           }
         },
-        "sdk_version": {
+        "plugin_spec_version": {
           "type": "string"
-        },
-        "enable_cache": {
-          "type": "boolean"
         }
       }
     },
     "ActionTriggerOutputBody": {
       "type": "object",
       "properties": {
+        "meta": {
+          "type": "object"
+        },
         "status": {
           "type": "string"
         },
@@ -505,9 +508,6 @@
         },
         "output": {
           "type": "object"
-        },
-        "meta": {
-          "type": "object"
         }
       },
       "required": [
@@ -527,11 +527,11 @@
             "trigger_event"
           ]
         },
-        "body": {
-          "$ref": "#/definitions/ActionTriggerOutputBody"
-        },
         "version": {
           "type": "string"
+        },
+        "body": {
+          "$ref": "#/definitions/ActionTriggerOutputBody"
         }
       },
       "required": [
@@ -543,19 +543,19 @@
     "TaskOutputBody": {
       "type": "object",
       "properties": {
-        "meta": {
-          "type": "object"
-        },
         "status": {
           "type": "string"
         },
-        "state": {
+        "output": {
           "type": "object"
         },
         "log": {
           "type": "string"
         },
-        "output": {
+        "meta": {
+          "type": "object"
+        },
+        "state": {
           "type": "object"
         }
       },
@@ -576,11 +576,11 @@
             "task_event"
           ]
         },
-        "body": {
-          "$ref": "#/definitions/TaskOutputBody"
-        },
         "version": {
           "type": "string"
+        },
+        "body": {
+          "$ref": "#/definitions/TaskOutputBody"
         }
       },
       "required": [
@@ -592,14 +592,14 @@
     "ActionTriggerInputBody": {
       "type": "object",
       "properties": {
+        "connection": {
+          "type": "object"
+        },
         "input": {
           "type": "object"
         },
         "action": {
           "type": "string"
-        },
-        "connection": {
-          "type": "object"
         }
       },
       "required": [
@@ -618,11 +618,11 @@
             "trigger_event"
           ]
         },
-        "body": {
-          "$ref": "#/definitions/ActionTriggerInputBody"
-        },
         "version": {
           "type": "string"
+        },
+        "body": {
+          "$ref": "#/definitions/ActionTriggerInputBody"
         }
       },
       "required": [
@@ -637,13 +637,13 @@
         "state": {
           "type": "object"
         },
-        "input": {
+        "connection": {
           "type": "object"
         },
         "task": {
           "type": "string"
         },
-        "connection": {
+        "input": {
           "type": "object"
         }
       },
@@ -663,11 +663,11 @@
             "task_event"
           ]
         },
-        "body": {
-          "$ref": "#/definitions/TaskInputBody"
-        },
         "version": {
           "type": "string"
+        },
+        "body": {
+          "$ref": "#/definitions/TaskInputBody"
         }
       },
       "required": [
@@ -682,24 +682,24 @@
         "input": {
           "type": "object"
         },
+        "output": {
+          "type": "object"
+        },
         "title": {
           "type": "string"
         },
         "description": {
           "type": "string"
-        },
-        "output": {
-          "type": "object"
         }
       }
     },
     "ConnectionDetails": {
       "type": "object",
       "properties": {
-        "title": {
+        "type": {
           "type": "string"
         },
-        "type": {
+        "title": {
           "type": "string"
         },
         "required": {
@@ -724,22 +724,22 @@
     "TaskDetails": {
       "type": "object",
       "properties": {
+        "state": {
+          "type": "object"
+        },
         "title": {
           "type": "string"
         },
-        "input": {
-          "type": "object"
-        },
         "schedule": {
           "type": "object"
         },
         "description": {
           "type": "string"
         },
-        "state": {
+        "output": {
           "type": "object"
         },
-        "output": {
+        "input": {
           "type": "object"
         }
       }

{insightconnect-plugin-runtime-5.3.0 → insightconnect-plugin-runtime-5.3.1}/insightconnect_plugin_runtime/api/endpoints.py

@@ -157,11 +157,13 @@ class Endpoints:
                 500:
                   description: Unexpected error
             """
+            self.logger.info("Plugin task beginning execution...")
             input_message = request.get_json(force=True)
             self.logger.debug("Request input: %s", input_message)
             Endpoints.validate_action_trigger_task_empty_input(input_message)
             Endpoints.validate_action_trigger_task_name(input_message, name, "task")
             output = self.run_action_trigger_task(input_message)
+            self.logger.info("Plugin task finished execution...")
             return output
 
         @legacy.route("/triggers/<string:name>/test", methods=["POST"])

{insightconnect-plugin-runtime-5.3.0 → insightconnect-plugin-runtime-5.3.1}/insightconnect_plugin_runtime/exceptions.py

@@ -1,4 +1,8 @@
 # -*- coding: utf-8 -*-
+import structlog
+logger = structlog.get_logger("plugin")
+
+
 class ClientException(Exception):
     """
     An exception which marks an error made by the plugin invoker.
@@ -120,6 +124,12 @@ class ConnectionTestException(Exception):
 
         self.data = str(data) if data else ""
 
+        # Safeguard to ensure the exception is logged across all plugins even if the plugin
+        # itself does not call `self.logger.error(<error info>)`
+        params = ["cause", "assistance", "data", "preset"]
+        info_log = ", ".join([f"{atr}='{getattr(self, atr)}'" for atr in params if getattr(self, atr)])
+        logger.error(f"Plugin exception instantiated. {info_log}")
+
     def __str__(self):
         if self.data:
             return "Connection test failed!\n\n{cause} {assistance} Response was: {data}".format(

{insightconnect-plugin-runtime-5.3.0 → insightconnect-plugin-runtime-5.3.1/insightconnect_plugin_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 5.3.0
+Version: 5.3.1
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -212,6 +212,7 @@ after cloning this repository.
 
 ## Changelog
 
+* 5.3.1 - New logging added to the beginning and end of a task | New logging when an exception is instantiated.
 * 5.3.0 - Update base images to pull Python 3.9.18 | python packages bump | rename image to drop python minor version.
 * 5.2.4 - Extended logging with OrgID and IntID
 * 5.2.3 - Extended logging in AWSClient

{insightconnect-plugin-runtime-5.3.0 → insightconnect-plugin-runtime-5.3.1}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="insightconnect-plugin-runtime",
-    version="5.3.0",
+    version="5.3.1",
     description="InsightConnect Plugin Runtime",
     long_description=long_description,
     long_description_content_type="text/markdown",