dt-extensions-sdk 1.3.0__tar.gz → 1.3.1__tar.gz

{dt_extensions_sdk-1.3.0 → dt_extensions_sdk-1.3.1}/PKG-INFO

@@ -1,11 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: dt-extensions-sdk
-Version: 1.3.0
+Version: 1.3.1
 Project-URL: Documentation, https://github.com/dynatrace-extensions/dt-extensions-python-sdk#readme
 Project-URL: Issues, https://github.com/dynatrace-extensions/dt-extensions-python-sdk/issues
 Project-URL: Source, https://github.com/dynatrace-extensions/dt-extensions-python-sdk
 Author-email: dlopes7 <davidribeirolopes@gmail.com>
-License: MIT
+License-Expression: MIT
+License-File: LICENSE.txt
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10

{dt_extensions_sdk-1.3.0 → dt_extensions_sdk-1.3.1}/dynatrace_extension/__about__.py

@@ -3,4 +3,4 @@
 # SPDX-License-Identifier: MIT
 
 
-__version__ = "1.3.0"
+__version__ = "1.3.1"

{dt_extensions_sdk-1.3.0 → dt_extensions_sdk-1.3.1}/dynatrace_extension/sdk/callback.py

@@ -9,7 +9,7 @@ from timeit import default_timer as timer
 from typing import Callable, Dict, Optional, Tuple
 
 from .activation import ActivationType
-from .communication import Status, StatusValue
+from .communication import MultiStatus, Status, StatusValue
 
 
 class WrappedCallback:
@@ -60,8 +60,13 @@ class WrappedCallback:
         start_time = timer()
         failed = False
         try:
-            self.callback(*self.callback_args, **self.callback_kwargs)
-            self.status = Status(StatusValue.OK)
+            ret = self.callback(*self.callback_args, **self.callback_kwargs)
+            if isinstance(ret, Status):
+                self.status = ret
+            elif isinstance(ret, MultiStatus):
+                self.status = ret.build()
+            else:
+                self.status = Status(StatusValue.OK)
         except Exception as e:
             failed = True
             self.logger.exception(f"Error running callback {self}: {e!r}")

{dt_extensions_sdk-1.3.0 → dt_extensions_sdk-1.3.1}/dynatrace_extension/sdk/communication.py

@@ -59,6 +59,29 @@ class Status:
         return self.status not in (StatusValue.OK, StatusValue.EMPTY)
 
 
+class MultiStatus:
+
+    def __init__(self):
+        self.statuses = []
+
+    def add_status(self, status: StatusValue, message):
+        self.statuses.append(Status(status, message))
+
+    def build(self) -> Status:
+        ret = Status(StatusValue.OK)
+        if len(self.statuses) == 0:
+            return ret
+
+        messages = []
+        for stored_status in self.statuses:
+            print(stored_status)  # noqa: T201
+            if stored_status.is_error():
+                ret.status = stored_status.status
+            messages.append(stored_status.message)
+        ret.message = "\n".join(messages)
+        return ret
+
+
 class CommunicationClient(ABC):
     """
     Abstract class for extension communication

{dt_extensions_sdk-1.3.0 → dt_extensions_sdk-1.3.1}/dynatrace_extension/sdk/extension.py

@@ -32,6 +32,7 @@ TIME_DIFF_INTERVAL = timedelta(seconds=60)
 
 CALLBACKS_THREAD_POOL_SIZE = 100
 INTERNAL_THREAD_POOL_SIZE = 20
+HEARTBEAT_THREAD_POOL_SIZE = 10
 
 RFC_3339_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
 DATASOURCE_TYPE = "python"
@@ -220,6 +221,7 @@ class Extension:
         # Executors for the callbacks and internal methods
         self._callbacks_executor = ThreadPoolExecutor(max_workers=CALLBACKS_THREAD_POOL_SIZE)
         self._internal_executor = ThreadPoolExecutor(max_workers=INTERNAL_THREAD_POOL_SIZE)
+        self._heartbeat_executor = ThreadPoolExecutor(max_workers=HEARTBEAT_THREAD_POOL_SIZE)
 
         # Extension metrics
         self._metrics_lock = RLock()
@@ -827,7 +829,7 @@ class Extension:
         self._scheduler.enterabs(next_timestamp, 1, self._timediff_iteration)
 
     def _heartbeat_iteration(self):
-        self._internal_executor.submit(self._heartbeat)
+        self._heartbeat_executor.submit(self._heartbeat)
         next_timestamp = self._get_and_set_next_internal_callback_timestamp("heartbeat", HEARTBEAT_INTERVAL)
         self._scheduler.enterabs(next_timestamp, 2, self._heartbeat_iteration)
 
@@ -976,7 +978,9 @@ class Extension:
             if callback.status.is_error():
                 overall_status.status = callback.status.status
                 messages.append(f"{callback}: {callback.status.message}")
-
+                continue
+            if callback.status.message is not None and callback.status.message != "":
+                messages.append(f"{callback}: {callback.status.message}")
         overall_status.message = "\n".join(messages)
         return overall_status
 

{dt_extensions_sdk-1.3.0 → dt_extensions_sdk-1.3.1}/tests/sdk/test_status.py

@@ -4,7 +4,7 @@ from datetime import timedelta
 from unittest.mock import MagicMock
 
 from dynatrace_extension import Extension
-from dynatrace_extension.sdk.communication import DebugClient
+from dynatrace_extension.sdk.communication import DebugClient, MultiStatus
 from dynatrace_extension.sdk.extension import Status, StatusValue
 
 
@@ -52,7 +52,7 @@ class TestStatus(unittest.TestCase):
         self.assertEqual(status.status, StatusValue.GENERIC_ERROR)
         self.assertIn("something went wrong", status.message)
 
-    def test_mutiple_bad_status(self):
+    def test_multiple_bad_status(self):
         ext = Extension()
         ext.logger = MagicMock()
         ext._running_in_sim = True
@@ -70,7 +70,7 @@ class TestStatus(unittest.TestCase):
         ext.schedule(bad_method_1, timedelta(seconds=1))
         ext.schedule(bad_method_2, timedelta(seconds=1))
         ext._scheduler.run(blocking=False)
-        time.sleep(0.01)
+        time.sleep(1)
 
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.GENERIC_ERROR)
@@ -93,3 +93,66 @@ class TestStatus(unittest.TestCase):
 
         self.assertTrue(extension._scheduled_callbacks[1].status.is_error())
         self.assertIn("longer than the interval", extension._scheduled_callbacks[1].status.message)
+
+    def test_direct_status_return(self):
+        ext = Extension()
+        ext.logger = MagicMock()
+        ext._running_in_sim = True
+        ext._client = DebugClient("", "", MagicMock())
+        ext._is_fastcheck = False
+
+        def callback():
+            return Status(StatusValue.OK, "foo1")
+
+        ext.schedule(callback, timedelta(seconds=1))
+        ext._scheduler.run(blocking=False)
+        time.sleep(0.01)
+
+        status = ext._build_current_status()
+        self.assertEqual(status.status, StatusValue.OK)
+        self.assertIn("foo1", status.message)
+
+    def test_direct_statuses_return(self):
+
+        def callback():
+            return Status(StatusValue.OK, "foo1")
+
+        def custom_query():
+            return Status(StatusValue.EMPTY, "foo2")
+
+        ext = Extension()
+        ext.logger = MagicMock()
+        ext._running_in_sim = True
+        ext._client = DebugClient("", "", MagicMock())
+        ext._is_fastcheck = False
+
+        ext.schedule(callback, timedelta(seconds=1))
+        ext.schedule(custom_query, timedelta(seconds=1))
+        ext._scheduler.run(blocking=False)
+        time.sleep(0.01)
+
+        status = ext._build_current_status()
+        self.assertEqual(status.status, StatusValue.OK)
+        self.assertIn("foo1", status.message)
+        self.assertIn("foo2", status.message)
+
+    def test_multistatus(self):
+        ext = Extension()
+        ext.logger = MagicMock()
+        ext._running_in_sim = True
+        ext._client = DebugClient("", "", MagicMock())
+        ext._is_fastcheck = False
+
+        def callback():
+            ret = MultiStatus()
+            ret.add_status(StatusValue.OK, "foo1")
+            ret.add_status(StatusValue.UNKNOWN_ERROR, "foo2")
+            return ret
+
+        ext.schedule(callback, timedelta(seconds=1))
+        ext._scheduler.run(blocking=False)
+        time.sleep(1)
+
+        status = ext._build_current_status()
+        self.assertEqual(status.status, StatusValue.UNKNOWN_ERROR)
+        self.assertIn("foo1", status.message)