insightconnect-plugin-runtime 6.3.3__py3-none-any.whl → 6.3.5__py3-none-any.whl

insightconnect_plugin_runtime/telemetry.py

@@ -1,7 +1,9 @@
 import contextvars
-from functools import wraps, partial
-from typing import Any, Callable
+from datetime import UTC, datetime
+from functools import partial, wraps
+from typing import Any, Callable, List, Union
 
+from dateutil.parser import parse
 from flask.app import Flask
 from opentelemetry import trace
 from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
@@ -13,7 +15,11 @@ from opentelemetry.sdk.trace.export import BatchSpanProcessor
 from opentelemetry.trace import Status, StatusCode
 
 from insightconnect_plugin_runtime.plugin import Plugin
-from insightconnect_plugin_runtime.util import is_running_in_cloud, OTEL_ENDPOINT
+from insightconnect_plugin_runtime.util import (
+    OTEL_ENDPOINT,
+    is_running_in_cloud,
+    parse_from_string,
+)
 
 
 def init_tracing(app: Flask, plugin: Plugin, endpoint: str) -> None:
@@ -92,3 +98,96 @@ def with_context(context: contextvars.Context, function: Callable) -> Callable:
         return context_.copy().run(function_, *args, **kwargs)
 
     return partial(_wrapper, context, function)
+
+
+def monitor_task_delay(
+    timestamp_keys: Union[str, List[str]], default_delay_threshold: str = "2d"
+) -> Callable:
+    """Monitor timestamp fields in task state to detect processing delays.
+
+    This decorator checks if specified timestamp fields in a task's state have fallen
+    behind a configurable threshold, indicating the task is processing data with a lag.
+    When timestamps fall behind the threshold, an error is logged.
+
+    The threshold can be overridden at runtime by setting the "task_delay_threshold" key
+    in the task's custom_config.
+
+    :param timestamp_keys: One or more state keys containing timestamps to monitor
+    :type timestamp_keys: Union[str, List[str]]
+
+    :param default_delay_threshold: Time duration string representing maximum acceptable lag (e.g. "2d" for 2 days).
+    :type default_delay_threshold: str
+
+    :return: Decorator function that wraps the original task function
+    :rtype: Callable
+    """
+
+    # Check if time_fields is a string and convert it to a list
+    if isinstance(timestamp_keys, str):
+        timestamp_keys = [timestamp_keys]
+
+    def _decorator(function_: Callable):
+        @wraps(function_)
+        def _wrapper(self, *args, **kwargs):
+            # Unpack response tuple from task `def run()` method
+            output, state, has_more_pages, status_code, error_object = function_(
+                self, *args, **kwargs
+            )
+
+            # Try-except with pass to make sure any exception won't stop the task from running
+            try:
+                # Check if any time fields are in the past
+                threshold = kwargs.get("custom_config", {}).get(
+                    "task_delay_threshold", default_delay_threshold
+                )
+
+                # Calculate the delayed time based on the threshold
+                delay_threshold_time = (
+                    datetime.now(UTC) - parse_from_string(threshold)
+                ).replace(tzinfo=None)
+
+                # Loop over the state time fields and check if they are below the set threshold
+                for state_time in timestamp_keys:
+                    # Check if the state time exists in the state dictionary
+                    if not (current_state_time := state.get(state_time)):
+                        continue
+
+                    # Parse and normalize the state time value
+                    try:
+                        # First, try to parse the epoch timestamp
+                        normalized_state_time = datetime.fromtimestamp(
+                            float(current_state_time)
+                        )
+                    except (ValueError, TypeError):
+                        # If parsing fails, parse as a string
+                        normalized_state_time = parse(str(current_state_time))
+
+                    # Normalize the state time to UTC and remove timezone info
+                    normalized_state_time = normalized_state_time.astimezone(
+                        UTC
+                    ).replace(tzinfo=None)
+
+                    # If the normalized state time is below the threshold, log an error message
+                    if normalized_state_time < delay_threshold_time:
+                        # Log an error message that indicates the integration state time is below the threshold
+                        self.logger.error(
+                            f"ERROR: THE INTEGRATION IS FALLING BEHIND",
+                            field=state_time,
+                            current_value=current_state_time,
+                            normalized_time=normalized_state_time,
+                            threshold_time=delay_threshold_time,
+                            configured_threshold=threshold,
+                            has_more_pages=has_more_pages,
+                        )
+                        break
+            except Exception as error:
+                self.logger.info(
+                    f"An error occurred while checking task delay. Error: {error}"
+                )
+
+            # Return task output
+            return output, state, has_more_pages, status_code, error_object
+
+        return _wrapper
+
+    return _decorator

insightconnect_plugin_runtime/util.py

@@ -2,7 +2,9 @@
 import copy
 import logging
 import os
+import re
 import sys
+from datetime import timedelta
 from typing import Any, Dict, List, Tuple, Union
 
 import python_jsonschema_objects as pjs
@@ -261,3 +263,44 @@ def trace():
 
 def is_running_in_cloud():
     return os.environ.get("PLUGIN_RUNTIME_ENVIRONMENT") == "cloud"
+
+
+def parse_from_string(
+    duration: str,
+    default: timedelta = timedelta(days=2),
+    unit_map: Dict[str, str] = None,
+) -> timedelta:
+    """
+    Parse a string duration (i.e. '5d', '12h', '30m', '45s') into a timedelta object.
+
+    :param duration: String in format like '5d', '12h', '30m', '45s'
+    :type duration: str
+
+    :param default: Default timedelta to return if parsing fails
+    :type default: timedelta
+
+    :param unit_map: Mapping of unit letters to timedelta parameter names
+    :type unit_map: Dict[str, str]
+
+    :return: Parsed timedelta or default if parsing fails
+    :rtype: timedelta
+    """
+
+    # If unit_map is not provided, use the default mapping
+    if unit_map is None:
+        unit_map = {"s": "seconds", "m": "minutes", "h": "hours", "d": "days"}
+
+    # Check if duration is not empty and is a string
+    if not duration or not isinstance(duration, str):
+        return default
+
+    # Use regex to match the duration format
+    match = re.match(r"(\d+)([smhd])", duration.lower())
+    if not match:
+        return default
+
+    # If match is found, extract the value and unit
+    value, unit = match.groups()
+
+    # Return a timedelta object based on the matched value and unit from the unit_map
+    return timedelta(**{unit_map[unit]: int(value)})

{insightconnect_plugin_runtime-6.3.3.dist-info → insightconnect_plugin_runtime-6.3.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: insightconnect-plugin-runtime
-Version: 6.3.3
+Version: 6.3.5
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -12,25 +12,25 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Topic :: Software Development :: Build Tools
 Description-Content-Type: text/markdown
-Requires-Dist: requests==2.32.3
+Requires-Dist: requests==2.32.4
 Requires-Dist: python_jsonschema_objects==0.5.2
 Requires-Dist: jsonschema==4.22.0
-Requires-Dist: certifi==2024.12.14
-Requires-Dist: Flask==3.1.0
+Requires-Dist: certifi==2025.4.26
+Requires-Dist: Flask==3.1.1
 Requires-Dist: gunicorn==23.0.0
-Requires-Dist: greenlet==3.1.1
-Requires-Dist: gevent==24.11.1
+Requires-Dist: greenlet==3.2.3
+Requires-Dist: gevent==25.5.1
 Requires-Dist: marshmallow==3.21.0
 Requires-Dist: apispec==6.5.0
 Requires-Dist: apispec-webframeworks==1.0.0
 Requires-Dist: blinker==1.9.0
-Requires-Dist: structlog==24.4.0
+Requires-Dist: structlog==25.4.0
 Requires-Dist: python-json-logger==2.0.7
 Requires-Dist: Jinja2==3.1.6
-Requires-Dist: opentelemetry-sdk==1.31.1
-Requires-Dist: opentelemetry-instrumentation-flask==0.52b1
-Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.31.1
-Requires-Dist: opentelemetry-instrumentation-requests==0.52b1
+Requires-Dist: opentelemetry-sdk==1.34.0
+Requires-Dist: opentelemetry-instrumentation-flask==0.55b0
+Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.34.0
+Requires-Dist: opentelemetry-instrumentation-requests==0.55b0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -224,6 +224,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.3.5 - Added `monitor_task_delay` decorator to detect processing delays
+* 6.3.4 - Addressed vulnerabilities within the slim and non-slim Python images (bumping packages)
 * 6.3.3 - Add helper func for tracing context to preserve parent span in threadpools
 * 6.3.2 - Raise `APIException` from within the `response_handler` to easily access the status code within the plugin
 * 6.3.1 - Improved filtering for `custom_config` parameters for plugin tasks

{insightconnect_plugin_runtime-6.3.3.dist-info → insightconnect_plugin_runtime-6.3.5.dist-info}/RECORD

@@ -11,9 +11,9 @@ insightconnect_plugin_runtime/schema.py,sha256=6MVw5hqGATU1VLgwfOWfPsP3hy1OnsugC
 insightconnect_plugin_runtime/server.py,sha256=DHooHBQa1M2z7aETTWK6u9B2jChi8vONzqK4n_c94f4,13138
 insightconnect_plugin_runtime/step.py,sha256=KdERg-789-s99IEKN61DR08naz-YPxyinPT0C_T81C4,855
 insightconnect_plugin_runtime/task.py,sha256=d-H1EAzVnmSdDEJtXyIK5JySprxpF9cetVoFGtWlHrg,123
-insightconnect_plugin_runtime/telemetry.py,sha256=qJJ6N7hWhOQ-I40AJIAAZjdOvRmXMdJo0e3jwXQLOfs,3312
+insightconnect_plugin_runtime/telemetry.py,sha256=9ibZCX2sbLl9GaWnyOuJfk7lJ4xTFWO5lxh0jlGEbxs,7580
 insightconnect_plugin_runtime/trigger.py,sha256=Zq3cy68N3QxAGbNZKCID6CZF05Zi7YD2sdy_qbedUY8,874
-insightconnect_plugin_runtime/util.py,sha256=8cle29INhnshEcL2LWpaC0ZGqevjq8pW8TE0MFEiYYw,8475
+insightconnect_plugin_runtime/util.py,sha256=DMspk1DQ5oOUnKi2foX2N-Qo-cxhJWETYQCaVjHX8Qo,9804
 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=ddqqYM7s1huvXFD0nCjpV_J2XULDn8F5sRakdjq-AKU,38893
@@ -79,7 +79,7 @@ tests/unit/test_server_spec.py,sha256=je97BaktgK0Fiz3AwFPkcmHzYtOJJNqJV_Fw5hrvqX
 tests/unit/test_trigger.py,sha256=E53mAUoVyponWu_4IQZ0IC1gQ9lakBnTn_9vKN2IZfg,1692
 tests/unit/test_variables.py,sha256=OUEOqGYZA3Nd5oKk5GVY3hcrWKHpZpxysBJcO_v5gzs,291
 tests/unit/utils.py,sha256=hcY0A2H_DMgCDXUTvDtCXMdMvRjLQgTaGcTpATb8YG0,2236
-insightconnect_plugin_runtime-6.3.3.dist-info/METADATA,sha256=eYx7EgwH9i2PNL-uTXqctPyJIVztYzFOPibMThW04EE,16504
-insightconnect_plugin_runtime-6.3.3.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-insightconnect_plugin_runtime-6.3.3.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-6.3.3.dist-info/RECORD,,
+insightconnect_plugin_runtime-6.3.5.dist-info/METADATA,sha256=1dVj_hHOHaNHQ6KROnbmuubyBSeXo1IzwhnZkgKrdSM,16675
+insightconnect_plugin_runtime-6.3.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+insightconnect_plugin_runtime-6.3.5.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-6.3.5.dist-info/RECORD,,

{insightconnect_plugin_runtime-6.3.3.dist-info → insightconnect_plugin_runtime-6.3.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any