omnata-plugin-runtime 0.4.8__tar.gz → 0.4.9__tar.gz

{omnata_plugin_runtime-0.4.8 → omnata_plugin_runtime-0.4.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.4.8
+Version: 0.4.9
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

{omnata_plugin_runtime-0.4.8 → omnata_plugin_runtime-0.4.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.4.8"
+version = "0.4.9"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"

{omnata_plugin_runtime-0.4.8 → omnata_plugin_runtime-0.4.9}/src/omnata_plugin_runtime/omnata_plugin.py

@@ -257,7 +257,8 @@ class SyncRequest(ABC):
     def get_ratelimit_retrying_http_session(self,
                                             max_retries: int = 5,
                                             backoff_factor: int = 1,
-                                            statuses_to_include: List[int] = [429]
+                                            statuses_to_include: List[int] = [429],
+                                            response_time_warning_threshold_ms:Optional[int] = None
 ):
         """
         Returns a requests.Session object which can respond to 429 responses by waiting and retrying.
@@ -272,14 +273,16 @@ class SyncRequest(ABC):
                 max_retries=max_retries,
                 backoff_factor=0,
                 statuses_to_include=statuses_to_include,
-                respect_retry_after_header=False
+                respect_retry_after_header=False,
+                response_time_warning_threshold_ms=response_time_warning_threshold_ms
             )
         return RateLimitedSession(
             run_deadline=self._run_deadline,
             thread_cancellation_token=self._thread_cancellation_token,
             max_retries=max_retries,
             backoff_factor=backoff_factor,
-            statuses_to_include=statuses_to_include
+            statuses_to_include=statuses_to_include,
+            response_time_warning_threshold_ms=response_time_warning_threshold_ms
         )
     
 

{omnata_plugin_runtime-0.4.8 → omnata_plugin_runtime-0.4.9}/src/omnata_plugin_runtime/rate_limiting.py

@@ -11,6 +11,7 @@ from logging import getLogger
 from typing import Any, List, Literal, Optional, Dict, Tuple
 import requests
 import time
+import logging
 from pydantic import Field, root_validator
 from pydantic.json import pydantic_encoder
 from .configuration import SubscriptableBaseModel
@@ -386,6 +387,27 @@ class RetryWithLogging(Retry):
             if self.thread_cancellation_token.wait(backoff):
                 raise InterruptedWhileWaitingException(message="The sync was interrupted while waiting for rate limiting to expire")
 
+class LongRequestLoggingAdapter(HTTPAdapter):
+    """
+    An adapter which wraps HTTPAdapter, and logs a warning if a request takes longer than a specified threshold
+    """
+    def __init__(self, 
+                 threshold_ms:int, 
+                 log_level=logging.WARNING,
+                 **kwargs):
+        super().__init__(**kwargs)
+        self.threshold_ms = threshold_ms
+        self.logger = logging.getLogger(__name__)
+        self.log_level = log_level
+
+    def send(self, request, *args, **kwargs):
+        start_time = time.time()
+        response = super().send(request, *args, **kwargs)
+        elapsed_time = (time.time() - start_time) * 1000  # Convert to milliseconds
+        if elapsed_time > self.threshold_ms:
+            self.logger.log(self.log_level, f"Request exceeded response time threshold of {self.threshold_ms}ms, taking {elapsed_time:.2f}ms to respond. URL: {request.url}")
+        return response
+
 
 class RateLimitedSession(requests.Session):
     """
@@ -400,7 +422,8 @@ class RateLimitedSession(requests.Session):
                  max_retries=5,
                  backoff_factor=1,
                  statuses_to_include:List[int] = [429],
-                 respect_retry_after_header:bool = True):
+                 respect_retry_after_header:bool = True,
+                 response_time_warning_threshold_ms:Optional[int] = None):
         super().__init__()
         self.max_retries = max_retries
         self.backoff_factor = backoff_factor
@@ -418,7 +441,10 @@ class RateLimitedSession(requests.Session):
             respect_retry_after_header=respect_retry_after_header
         )
         retry_strategy.thread_cancellation_token = thread_cancellation_token
-        adapter = HTTPAdapter(max_retries=retry_strategy)
+        if response_time_warning_threshold_ms is not None:
+            adapter = LongRequestLoggingAdapter(max_retries=retry_strategy, threshold_ms=response_time_warning_threshold_ms)
+        else:
+            adapter = HTTPAdapter(max_retries=retry_strategy)
         self.mount("https://", adapter)
         self.mount("http://", adapter)