insightconnect-plugin-runtime 6.3.4__tar.gz → 6.3.6__tar.gz

{insightconnect_plugin_runtime-6.3.4/insightconnect_plugin_runtime.egg-info → insightconnect_plugin_runtime-6.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: insightconnect-plugin-runtime
-Version: 6.3.4
+Version: 6.3.6
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -12,25 +12,26 @@ 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: 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: python-dateutil==2.9.0.post0
+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 +225,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.3.6 - Added required dependency to plugin runtime
+* 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

{insightconnect_plugin_runtime-6.3.4 → insightconnect_plugin_runtime-6.3.6}/README.md

@@ -182,6 +182,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.3.6 - Added required dependency to plugin runtime
+* 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

insightconnect_plugin_runtime-6.3.6/insightconnect_plugin_runtime/telemetry.py

@@ -0,0 +1,193 @@
+import contextvars
+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
+from opentelemetry.instrumentation.flask import FlaskInstrumentor
+from opentelemetry.instrumentation.requests import RequestsInstrumentor
+from opentelemetry.sdk.resources import Resource
+from opentelemetry.sdk.trace import TracerProvider
+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 (
+    OTEL_ENDPOINT,
+    is_running_in_cloud,
+    parse_from_string,
+)
+
+
+def init_tracing(app: Flask, plugin: Plugin, endpoint: str) -> None:
+    """
+    Initialize OpenTelemetry Tracing
+
+    The function sets up the tracer provider, span processor and exporter with auto-instrumentation
+
+    :param app: The Flask Application
+    :param plugin: The plugin to derive the service name from
+    :param endpoint: The Otel Endpoint to emit traces to
+    """
+
+    if not is_running_in_cloud():
+        return
+
+    resource = Resource(attributes={"service.name": f'{plugin.name.lower().replace(" ", "_")}-{plugin.version}'})
+
+    trace_provider = TracerProvider(resource=resource)
+    exporter = OTLPSpanExporter(endpoint=endpoint)
+    trace_provider.add_span_processor(BatchSpanProcessor(exporter))
+    trace.set_tracer_provider(trace_provider)
+
+    FlaskInstrumentor().instrument_app(app)
+
+    def requests_callback(span: trace.Span, _: Any, response: Any) -> None:
+        if hasattr(response, "status_code"):
+            span.set_status(Status(StatusCode.OK if response.status_code < 400 else StatusCode.ERROR))
+
+    RequestsInstrumentor().instrument(trace_provider=trace_provider, response_hook=requests_callback)
+
+
+def auto_instrument(func: Callable) -> Callable:
+    """
+    Decorator that auto-instruments a function with a trace
+
+    :param func: function to instrument
+    :return:
+    """
+
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        tracer = trace.get_tracer(__name__)
+        with tracer.start_as_current_span(func.__name__):
+            return func(*args, **kwargs)
+
+    return wrapper
+
+
+def create_post_fork(app_getter: Callable, plugin_getter: Callable, config_getter: Callable) -> Callable:
+    def post_fork(server, worker):
+        app = app_getter()
+        plugin = plugin_getter()
+        endpoint = config_getter().get(OTEL_ENDPOINT, None)
+        if endpoint:
+            init_tracing(app, plugin, endpoint)
+
+    return post_fork
+
+
+def with_context(context: contextvars.Context, function: Callable) -> Callable:
+    """
+    Creates a wrapper function that executes the target function with the specified context.
+
+    :param context: The Context object to apply when executing the function
+    :type context: contextvars.Context
+
+    :param function: The function to wrap with the specified context
+    :type function: Callable
+
+    :return: A wrapper function that applies the context when called
+    :rtype: Callable
+    """
+
+    def _wrapper(context_: contextvars.Context, function_: Callable, *args, **kwargs):
+        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-6.3.4 → insightconnect_plugin_runtime-6.3.6}/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.4 → insightconnect_plugin_runtime-6.3.6/insightconnect_plugin_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: insightconnect-plugin-runtime
-Version: 6.3.4
+Version: 6.3.6
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -12,25 +12,26 @@ 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: 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: python-dateutil==2.9.0.post0
+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 +225,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.3.6 - Added required dependency to plugin runtime
+* 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

insightconnect_plugin_runtime-6.3.6/insightconnect_plugin_runtime.egg-info/requires.txt

@@ -0,0 +1,20 @@
+requests==2.32.4
+python_jsonschema_objects==0.5.2
+jsonschema==4.22.0
+certifi==2025.4.26
+Flask==3.1.1
+gunicorn==23.0.0
+greenlet==3.2.3
+gevent==25.5.1
+marshmallow==3.21.0
+apispec==6.5.0
+apispec-webframeworks==1.0.0
+blinker==1.9.0
+structlog==25.4.0
+python-json-logger==2.0.7
+Jinja2==3.1.6
+python-dateutil==2.9.0.post0
+opentelemetry-sdk==1.34.0
+opentelemetry-instrumentation-flask==0.55b0
+opentelemetry-exporter-otlp-proto-http==1.34.0
+opentelemetry-instrumentation-requests==0.55b0

{insightconnect_plugin_runtime-6.3.4 → insightconnect_plugin_runtime-6.3.6}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="insightconnect-plugin-runtime",
-    version="6.3.4",
+    version="6.3.6",
     description="InsightConnect Plugin Runtime",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -14,25 +14,26 @@ setup(
     url="https://github.com/rapid7/komand-plugin-sdk-python",
     packages=find_packages(),
     install_requires=[
-        "requests==2.32.3",
+        "requests==2.32.4",
         "python_jsonschema_objects==0.5.2",
         "jsonschema==4.22.0",
-        "certifi==2024.12.14",
+        "certifi==2025.4.26",
         "Flask==3.1.1",
         "gunicorn==23.0.0",
-        "greenlet==3.1.1",
-        "gevent==24.11.1",
+        "greenlet==3.2.3",
+        "gevent==25.5.1",
         "marshmallow==3.21.0",
         "apispec==6.5.0",
         "apispec-webframeworks==1.0.0",
         "blinker==1.9.0",
-        "structlog==24.4.0",
+        "structlog==25.4.0",
         "python-json-logger==2.0.7",
         "Jinja2==3.1.6",
-        "opentelemetry-sdk==1.31.1",
-        "opentelemetry-instrumentation-flask==0.52b1",
-        "opentelemetry-exporter-otlp-proto-http==1.31.1",
-        "opentelemetry-instrumentation-requests==0.52b1",
+        "python-dateutil==2.9.0.post0",
+        "opentelemetry-sdk==1.34.0",
+        "opentelemetry-instrumentation-flask==0.55b0",
+        "opentelemetry-exporter-otlp-proto-http==1.34.0",
+        "opentelemetry-instrumentation-requests==0.55b0",
     ],
     tests_require=[
         "pytest",

insightconnect_plugin_runtime-6.3.4/insightconnect_plugin_runtime/telemetry.py

@@ -1,94 +0,0 @@
-import contextvars
-from functools import wraps, partial
-from typing import Any, Callable
-
-from flask.app import Flask
-from opentelemetry import trace
-from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
-from opentelemetry.instrumentation.flask import FlaskInstrumentor
-from opentelemetry.instrumentation.requests import RequestsInstrumentor
-from opentelemetry.sdk.resources import Resource
-from opentelemetry.sdk.trace import TracerProvider
-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
-
-
-def init_tracing(app: Flask, plugin: Plugin, endpoint: str) -> None:
-    """
-    Initialize OpenTelemetry Tracing
-
-    The function sets up the tracer provider, span processor and exporter with auto-instrumentation
-
-    :param app: The Flask Application
-    :param plugin: The plugin to derive the service name from
-    :param endpoint: The Otel Endpoint to emit traces to
-    """
-
-    if not is_running_in_cloud():
-        return
-
-    resource = Resource(attributes={"service.name": f'{plugin.name.lower().replace(" ", "_")}-{plugin.version}'})
-
-    trace_provider = TracerProvider(resource=resource)
-    exporter = OTLPSpanExporter(endpoint=endpoint)
-    trace_provider.add_span_processor(BatchSpanProcessor(exporter))
-    trace.set_tracer_provider(trace_provider)
-
-    FlaskInstrumentor().instrument_app(app)
-
-    def requests_callback(span: trace.Span, _: Any, response: Any) -> None:
-        if hasattr(response, "status_code"):
-            span.set_status(Status(StatusCode.OK if response.status_code < 400 else StatusCode.ERROR))
-
-    RequestsInstrumentor().instrument(trace_provider=trace_provider, response_hook=requests_callback)
-
-
-def auto_instrument(func: Callable) -> Callable:
-    """
-    Decorator that auto-instruments a function with a trace
-
-    :param func: function to instrument
-    :return:
-    """
-
-    @wraps(func)
-    def wrapper(*args, **kwargs):
-        tracer = trace.get_tracer(__name__)
-        with tracer.start_as_current_span(func.__name__):
-            return func(*args, **kwargs)
-
-    return wrapper
-
-
-def create_post_fork(app_getter: Callable, plugin_getter: Callable, config_getter: Callable) -> Callable:
-    def post_fork(server, worker):
-        app = app_getter()
-        plugin = plugin_getter()
-        endpoint = config_getter().get(OTEL_ENDPOINT, None)
-        if endpoint:
-            init_tracing(app, plugin, endpoint)
-
-    return post_fork
-
-
-def with_context(context: contextvars.Context, function: Callable) -> Callable:
-    """
-    Creates a wrapper function that executes the target function with the specified context.
-
-    :param context: The Context object to apply when executing the function
-    :type context: contextvars.Context
-
-    :param function: The function to wrap with the specified context
-    :type function: Callable
-
-    :return: A wrapper function that applies the context when called
-    :rtype: Callable
-    """
-
-    def _wrapper(context_: contextvars.Context, function_: Callable, *args, **kwargs):
-        return context_.copy().run(function_, *args, **kwargs)
-
-    return partial(_wrapper, context, function)

insightconnect_plugin_runtime-6.3.4/insightconnect_plugin_runtime.egg-info/requires.txt

@@ -1,19 +0,0 @@
-requests==2.32.3
-python_jsonschema_objects==0.5.2
-jsonschema==4.22.0
-certifi==2024.12.14
-Flask==3.1.1
-gunicorn==23.0.0
-greenlet==3.1.1
-gevent==24.11.1
-marshmallow==3.21.0
-apispec==6.5.0
-apispec-webframeworks==1.0.0
-blinker==1.9.0
-structlog==24.4.0
-python-json-logger==2.0.7
-Jinja2==3.1.6
-opentelemetry-sdk==1.31.1
-opentelemetry-instrumentation-flask==0.52b1
-opentelemetry-exporter-otlp-proto-http==1.31.1
-opentelemetry-instrumentation-requests==0.52b1