dt-extensions-sdk 1.3.0__py3-none-any.whl → 1.4.0__py3-none-any.whl

{dt_extensions_sdk-1.3.0.dist-info → dt_extensions_sdk-1.4.0.dist-info}/METADATA

@@ -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.dist-info → dt_extensions_sdk-1.4.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-dynatrace_extension/__about__.py,sha256=UOSMeuvYrIEfkKMe5OPGxqTQkGJsMCvBMaw2t3yMuJ4,110
+dynatrace_extension/__about__.py,sha256=0eF7oFPAs4l6aF4bObZHJnLcIaLQ07bZ0ozH7nzz4HY,110
 dynatrace_extension/__init__.py,sha256=BvQuknmA7ti3WJi3zEXZfY7aAxJrie37VNitWICsUvI,752
 dynatrace_extension/cli/__init__.py,sha256=HCboY_eJPoqjFmoPDsBL8Jk6aNvank8K7JpkVrgwzUM,123
 dynatrace_extension/cli/main.py,sha256=Z8gFcp0vIMBkzV6jUd5mwvP1U0JcLqAHoMLJw_6puz4,18260
@@ -16,10 +16,10 @@ dynatrace_extension/cli/create/extension_template/extension_name/__init__.py.tem
 dynatrace_extension/cli/create/extension_template/extension_name/__main__.py.template,sha256=NYuZ6BWZ6HOs4TCuboh6S0nuYp3F8MXW2lmjSpdREEA,1205
 dynatrace_extension/sdk/__init__.py,sha256=RsqQ1heGyCmSK3fhuEKAcxQIRCg4gEK0-eSkIehL5Nc,86
 dynatrace_extension/sdk/activation.py,sha256=goTbT1tD2kn8xfyXFdTy_cTZNcFPJpgbvQM8HOzKECA,1480
-dynatrace_extension/sdk/callback.py,sha256=PNRvOVzNpKvpsa0wCf7HRDkfo3wMsF2otVWI9a1AAkU,6307
-dynatrace_extension/sdk/communication.py,sha256=GVxIdLvhJW7mr1HHoS3qILGx7MNZm1ujocBrNYbfnUc,18494
+dynatrace_extension/sdk/callback.py,sha256=eMpC0F3fCI82mWHIFgmy9QmKl7Kq_9dSaanHdV6o7hA,6511
+dynatrace_extension/sdk/communication.py,sha256=QkJgEBblOen-jmvsb3ZfYZYglYUc7jHbkEgPtRj9l6w,19123
 dynatrace_extension/sdk/event.py,sha256=J261imbFKpxfuAQ6Nfu3RRcsIQKKivy6fme1nww2g-8,388
-dynatrace_extension/sdk/extension.py,sha256=gwESrAhlTtlJO-VfRFtfevmzDbd81Dj9r00u-kqs0iQ,42940
+dynatrace_extension/sdk/extension.py,sha256=59hg3aUXbrkhvEB7za8jujv1LZQ4sSx4ot9scijadQU,44926
 dynatrace_extension/sdk/helper.py,sha256=ZNrO9ao2hE3KQ934vAYD74k0fCr6QTG-_bAvbk9-hi8,6562
 dynatrace_extension/sdk/metric.py,sha256=7VClzJCFJNDCxA-d69uTu1pdPtDZBTwq7fbafs_L6nQ,3690
 dynatrace_extension/sdk/runtime.py,sha256=jyYsM1x-gMnW68eWq8IoZZZBarHgIcr_nVeGDDgpRDk,2802
@@ -28,8 +28,8 @@ dynatrace_extension/sdk/vendor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5
 dynatrace_extension/sdk/vendor/mureq/LICENSE,sha256=8AVcgZgiT_mvK1fOofXtRRr2f1dRXS_K21NuxQgP4VM,671
 dynatrace_extension/sdk/vendor/mureq/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dynatrace_extension/sdk/vendor/mureq/mureq.py,sha256=znF4mvzk5L03CLNozRz8UpK-fMijmSkObDFwlbhwLUg,14656
-dt_extensions_sdk-1.3.0.dist-info/METADATA,sha256=qyJXkr0QueRXicxxBHw_wO4X9gNQsHGZf0DelNJUabM,2648
-dt_extensions_sdk-1.3.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-dt_extensions_sdk-1.3.0.dist-info/entry_points.txt,sha256=pweyOCgENGHjOlT6_kXYaBPOrE3p18K0UettqnNlnoE,55
-dt_extensions_sdk-1.3.0.dist-info/licenses/LICENSE.txt,sha256=3Zihv0lOVYHNfDkJC-tUAU6euP9r2NexsDW4w-zqgVk,1078
-dt_extensions_sdk-1.3.0.dist-info/RECORD,,
+dt_extensions_sdk-1.4.0.dist-info/METADATA,sha256=LYTXYtBm33nrBL_jz22oNjpB0mRIhIdr27pFuHgNzao,2685
+dt_extensions_sdk-1.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dt_extensions_sdk-1.4.0.dist-info/entry_points.txt,sha256=pweyOCgENGHjOlT6_kXYaBPOrE3p18K0UettqnNlnoE,55
+dt_extensions_sdk-1.4.0.dist-info/licenses/LICENSE.txt,sha256=3Zihv0lOVYHNfDkJC-tUAU6euP9r2NexsDW4w-zqgVk,1078
+dt_extensions_sdk-1.4.0.dist-info/RECORD,,

{dt_extensions_sdk-1.3.0.dist-info → dt_extensions_sdk-1.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

dynatrace_extension/__about__.py

@@ -3,4 +3,4 @@
 # SPDX-License-Identifier: MIT
 
 
-__version__ = "1.3.0"
+__version__ = "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}")

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

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)