insightconnect-plugin-runtime 5.3.0__py3-none-any.whl → 5.3.1__py3-none-any.whl

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/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.dist-info → insightconnect_plugin_runtime-5.3.1.dist-info}/METADATA

@@ -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.dist-info → insightconnect_plugin_runtime-5.3.1.dist-info}/RECORD

@@ -3,7 +3,7 @@ insightconnect_plugin_runtime/action.py,sha256=8gsOONf7mzY83O3DNjCBIafk7C7acnf7m
 insightconnect_plugin_runtime/cli.py,sha256=Pb-Janu-XfRlSXxPHh30OIquljWptrhhS51C3clJqh4,8939
 insightconnect_plugin_runtime/connection.py,sha256=4bHHV2B0UFGsAtvLu1fiYQRwx7fissUakHPUyjLQO0E,2340
 insightconnect_plugin_runtime/dispatcher.py,sha256=ru7njnyyWE1-oD-VbZJ-Z8tELwvDf69rM7Iezs4rbnw,1774
-insightconnect_plugin_runtime/exceptions.py,sha256=YEbm63_s6J6978Elsfz2mavoSaxdtPVkHPC6WYNDTBI,6060
+insightconnect_plugin_runtime/exceptions.py,sha256=rC74M9aCSrY7J-nq9ttsccLkNbHR0gbZ2SRvXlCgLx0,6507
 insightconnect_plugin_runtime/helper.py,sha256=m5PxN04-NPXM1X10S2wwjqmiLvnNntd6TnwLoW4nnus,21108
 insightconnect_plugin_runtime/metrics.py,sha256=hf_Aoufip_s4k4o8Gtzz90ymZthkaT2e5sXh5B4LcF0,3186
 insightconnect_plugin_runtime/plugin.py,sha256=YEwxPHyIYsQcGAZYQZqh60POQOzbrtsZAcA5TcBmy8g,22708
@@ -15,7 +15,7 @@ insightconnect_plugin_runtime/trigger.py,sha256=Zq3cy68N3QxAGbNZKCID6CZF05Zi7YD2
 insightconnect_plugin_runtime/util.py,sha256=lE6UVOYyzY9Ldyqpf91V24CvvdKjUu3WjGOSy957Sm0,8073
 insightconnect_plugin_runtime/variables.py,sha256=7FjJGnU7KUR7m9o-_tRq7Q3KiaB1Pp0Apj1NGgOwrJk,3056
 insightconnect_plugin_runtime/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-insightconnect_plugin_runtime/api/endpoints.py,sha256=BjLr9YNM9J5cHXWfpD49JvBSB93jr-EChXxmXHhFVig,28966
+insightconnect_plugin_runtime/api/endpoints.py,sha256=jjKTFArNIOJkZw-L0QU_1yzRcKC6xyAC8ge86M6fQjQ,29099
 insightconnect_plugin_runtime/api/schemas.py,sha256=jRmDrwLJTBl-iQOnyZkSwyJlCWg4eNjAnKfD9Eko4z0,2754
 insightconnect_plugin_runtime/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 insightconnect_plugin_runtime/clients/aws_client.py,sha256=3Ytx-uchkl7dTcwYKZPKvCJaWralEqZUZeireOCWlPo,20290
@@ -71,7 +71,7 @@ tests/unit/test_schema.py,sha256=swWZPRo_Q4M6VHte-srmxcV2wH-XS7pgmNRxpaL0Qrg,642
 tests/unit/test_server_spec.py,sha256=7hmXdsY36nP0ENhijrolBInAMJwht2-Z-D6yhcg_zZI,578
 tests/unit/test_trigger.py,sha256=E53mAUoVyponWu_4IQZ0IC1gQ9lakBnTn_9vKN2IZfg,1692
 tests/unit/test_variables.py,sha256=OUEOqGYZA3Nd5oKk5GVY3hcrWKHpZpxysBJcO_v5gzs,291
-insightconnect_plugin_runtime-5.3.0.dist-info/METADATA,sha256=AX4be54BOYKpomlbhDMGtqiJ9ISv_PxyztqsvLirbAg,11914
-insightconnect_plugin_runtime-5.3.0.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-insightconnect_plugin_runtime-5.3.0.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-5.3.0.dist-info/RECORD,,
+insightconnect_plugin_runtime-5.3.1.dist-info/METADATA,sha256=nNNrHZvzCIPzoz3isVDx8T05UKQckWjbQOzz6Wp03mY,12026
+insightconnect_plugin_runtime-5.3.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+insightconnect_plugin_runtime-5.3.1.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-5.3.1.dist-info/RECORD,,

{insightconnect_plugin_runtime-5.3.0.dist-info → insightconnect_plugin_runtime-5.3.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.3)
+Generator: bdist_wheel (0.42.0)
 Root-Is-Purelib: true
 Tag: py3-none-any