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

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

@@ -1,11 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: dt-extensions-sdk
-Version: 1.3.0
+Version: 1.4.0
 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.4.0}/dynatrace_extension/__about__.py

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

{dt_extensions_sdk-1.3.0 → dt_extensions_sdk-1.4.0}/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.4.0}/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.4.0}/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"
@@ -214,17 +215,23 @@ class Extension:
             "timediff": datetime.now() + TIME_DIFF_INTERVAL,
             "heartbeat": datetime.now() + HEARTBEAT_INTERVAL,
             "metrics": datetime.now() + METRIC_SENDING_INTERVAL,
+            "events": datetime.now() + METRIC_SENDING_INTERVAL,
             "sfm_metrics": datetime.now() + SFM_METRIC_SENDING_INTERVAL,
         }
 
         # 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()
         self._metrics: List[str] = []
 
+        # Extension logs
+        self._logs_lock = RLock()
+        self._logs: List[dict] = []
+
         # Self monitoring metrics
         self._sfm_metrics_lock = Lock()
         self._callbackSfmReport: Dict[str, WrappedCallback] = {}
@@ -503,6 +510,7 @@ class Extension:
         properties: Optional[dict] = None,
         timestamp: Optional[datetime] = None,
         severity: Union[Severity, str] = Severity.INFO,
+        send_immediately: bool = False,
     ) -> None:
         """Report an event using log ingest.
 
@@ -512,6 +520,7 @@ class Extension:
             properties: A dictionary of extra event properties
             timestamp: The timestamp of the event, defaults to the current time
             severity: The severity of the event, defaults to Severity.INFO
+            send_immediately: Option to directly schedule log to be sent without batching
         """
         if timestamp is None:
             timestamp = datetime.now(tz=timezone.utc)
@@ -528,7 +537,7 @@ class Extension:
             **self._metadata,
             **properties,
         }
-        self._send_events(event)
+        self._send_events(event, send_immediately=send_immediately)
 
     def report_dt_event(
         self,
@@ -633,7 +642,7 @@ class Extension:
                         raise ValueError(msg)
         self._send_dt_event(event)
 
-    def report_log_event(self, log_event: dict):
+    def report_log_event(self, log_event: dict, send_immediately: bool = False):
         """Report a custom log event using log ingest.
 
         Note:
@@ -641,25 +650,28 @@ class Extension:
 
         Args:
             log_event: The log event dictionary.
+            send_immediately: Option to directly schedule log to be sent without batching
         """
-        self._send_events(log_event)
+        self._send_events(log_event, send_immediately=send_immediately)
 
-    def report_log_events(self, log_events: List[dict]):
+    def report_log_events(self, log_events: List[dict], send_immediately: bool = False):
         """Report a list of custom log events using log ingest.
 
         Args:
             log_events: The list of log events
+            send_immediately: Option to directly schedule log to be sent without batching
         """
-        self._send_events(log_events)
+        self._send_events(log_events, send_immediately=send_immediately)
 
-    def report_log_lines(self, log_lines: List[Union[str, bytes]]):
+    def report_log_lines(self, log_lines: List[Union[str, bytes]], send_immediately: bool = False):
         """Report a list of log lines using log ingest
 
         Args:
             log_lines: The list of log lines
+            send_immediately: Option to directly schedule log to be sent without batching
         """
         events = [{"content": line} for line in log_lines]
-        self._send_events(events)
+        self._send_events(events, send_immediately=send_immediately)
 
     @property
     def enabled_feature_sets(self) -> dict[str, list[str]]:
@@ -817,6 +829,7 @@ class Extension:
         for callback in self._scheduled_callbacks_before_run:
             self._schedule_callback(callback)
         self._metrics_iteration()
+        self._events_iteration()
         self._sfm_metrics_iteration()
         self._timediff_iteration()
         self._scheduler.run()
@@ -827,7 +840,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)
 
@@ -836,6 +849,11 @@ class Extension:
         next_timestamp = self._get_and_set_next_internal_callback_timestamp("metrics", METRIC_SENDING_INTERVAL)
         self._scheduler.enterabs(next_timestamp, 1, self._metrics_iteration)
 
+    def _events_iteration(self):
+        self._internal_executor.submit(self._send_buffered_events)
+        next_timestamp = self._get_and_set_next_internal_callback_timestamp("events", METRIC_SENDING_INTERVAL)
+        self._scheduler.enterabs(next_timestamp, 1, self._events_iteration)
+
     def _sfm_metrics_iteration(self):
         self._internal_executor.submit(self._send_sfm_metrics)
         next_timestamp = self._get_and_set_next_internal_callback_timestamp("sfm_metrics", SFM_METRIC_SENDING_INTERVAL)
@@ -976,7 +994,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
 
@@ -1040,8 +1060,23 @@ class Extension:
             with self._internal_callbacks_results_lock:
                 self._internal_callbacks_results[self._send_events.__name__] = Status(StatusValue.GENERIC_ERROR, str(e))
 
-    def _send_events(self, events: Union[dict, List[dict]]):
-        self._internal_executor.submit(self._send_events_internal, events)
+    def _send_events(self, events: Union[dict, List[dict]], send_immediately: bool = False):
+        if send_immediately:
+            self._internal_executor.submit(self._send_events_internal, events)
+            return
+        with self._logs_lock:
+            if isinstance(events, dict):
+                self._logs.append(events)
+            elif isinstance(events, list):
+                self._logs.extend(events)
+            else:
+                self.logger.error(f"Invalid log format: {events}")
+
+    def _send_buffered_events(self):
+        with self._logs_lock:
+            if len(self._logs) > 0:
+                self._send_events_internal(self._logs)
+                self._logs = []
 
     def _send_dt_event(self, event: dict[str, str | int | dict[str, str]]):
         self._client.send_dt_event(event)

{dt_extensions_sdk-1.3.0 → dt_extensions_sdk-1.4.0}/tests/sdk/test_extension.py

@@ -60,6 +60,50 @@ class TestExtension(unittest.TestCase):
         with extension._metrics_lock:
             self.assertEqual(len(extension._metrics), 0)
 
+    def test_add_event(self):
+        extension = Extension()
+        extension.logger = MagicMock()
+        extension._running_in_sim = True
+        extension.report_event("my_event1", "my_description")
+        extension.report_event("my_event1", "my_description")
+        self.assertEqual(len(extension._logs), 2)
+        self.assertEqual(extension._logs[0].get("content", "not_good"), "my_event1\nmy_description")
+
+    def test_send_event_immediately(self):
+        extension = Extension()
+        extension.logger = MagicMock()
+        extension._running_in_sim = True
+        extension.report_event("my_event1", "my_description", send_immediately=True)
+        extension.report_event("my_event1", "my_description", send_immediately=True)
+        self.assertEqual(len(extension._logs), 0)
+
+    def test_add_log_events(self):
+        extension = Extension()
+        extension.logger = MagicMock()
+        extension._running_in_sim = True
+        extension.report_log_events([{"my_event": "hello there!"}, {"my_event": "hello there!"}])
+        self.assertEqual(len(extension._logs), 2)
+        self.assertEqual(extension._logs[0].get("my_event", "not_good"), "hello there!")
+
+    def test_send_log_events_immediately(self):
+        extension = Extension()
+        extension.logger = MagicMock()
+        extension._running_in_sim = True
+        extension.report_log_events([{"my_event": "hello there!"}, {"my_event": "hello there!"}], send_immediately=True)
+        self.assertEqual(len(extension._logs), 0)
+
+    def test_flush_events(self):
+        extension = Extension()
+        extension.logger = MagicMock()
+        extension._running_in_sim = True
+        extension.report_event("my_event1", "my_description")
+        extension.report_event("my_event1", "my_description")
+        self.assertEqual(len(extension._logs), 2)
+        extension._events_iteration()
+        time.sleep(0.01)
+        with extension._logs_lock:
+            self.assertEqual(len(extension._logs), 0)
+
     def test_callback(self):
         extension = Extension()
         extension.logger = MagicMock()
@@ -453,6 +497,7 @@ class TestExtension(unittest.TestCase):
         extension._running_in_sim = True
         extension._is_fastcheck = False
         extension._client = MagicMock()
+
         # extension._run_callback = MagicMock()
 
         def callback():

{dt_extensions_sdk-1.3.0 → dt_extensions_sdk-1.4.0}/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)