dt-extensions-sdk 1.7.1__tar.gz → 1.7.3__tar.gz

dt_extensions_sdk-1.7.3/.github/workflows/build-package.yml

@@ -0,0 +1,40 @@
+name: Build distribution 📦
+
+on:
+  workflow_call:
+  workflow_dispatch:
+  pull_request:
+
+jobs:
+  build-package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install hatch
+        run: |
+          pip install hatch --user
+
+      - name: Run tests
+        run: |
+          python3 -m hatch run test
+
+      - name: Run linting
+        run: |
+          python3 -m hatch run lint:all
+
+      - name: Build a wheel and a source tarball
+        run: |
+          python3 -m hatch build
+      
+      - name: Upload built distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: package
+          path: dist/*
+

{dt_extensions_sdk-1.7.1 → dt_extensions_sdk-1.7.3}/.github/workflows/publish.yml

@@ -2,49 +2,21 @@ name: Publish to PyPI
 on:
   workflow_dispatch:
 
-jobs:
-  build-package:
-    name: Build distribution 📦
+jobs:  
+  check-tag:
     runs-on: ubuntu-latest
-
     steps:
       - id: check_ref
         run: echo "::set-output name=match::$(echo '${{ github.ref }}' | grep -Pq '^refs/tags/v\d+\.\d+\.\d+$' && echo true || echo false)"
         shell: bash
-
       - name: Check if tag is valid
         if: steps.check_ref.outputs.match != 'true'
         run: exit 1
 
-      - uses: actions/checkout@v4
-    
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.10"
-
-      - name: Install hatch
-        run: |
-          pip install hatch --user
-
-      - name: Run tests
-        run: |
-          python3 -m hatch run test
-
-      - name: Run linting
-        run: |
-          python3 -m hatch run lint:all
-    
-      - name: Build a wheel and a source tarball
-        run: |
-          python3 -m hatch build
-    
-      - name: Store the distribution packages
-        uses: actions/upload-artifact@v4
-        with:
-          name: package
-          path: |
-            dist/*
+  build-package:
+    needs:
+      - check-tag
+    uses: ./.github/workflows/build-package.yml
   
   github-release:
     name: Create GitHub release

{dt_extensions_sdk-1.7.1 → dt_extensions_sdk-1.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dt-extensions-sdk
-Version: 1.7.1
+Version: 1.7.3
 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

{dt_extensions_sdk-1.7.1 → dt_extensions_sdk-1.7.3}/dynatrace_extension/__about__.py

@@ -3,4 +3,4 @@
 # SPDX-License-Identifier: MIT
 
 
-__version__ = "1.7.1"
+__version__ = "1.7.3"

{dt_extensions_sdk-1.7.1 → dt_extensions_sdk-1.7.3}/dynatrace_extension/sdk/callback.py

@@ -4,6 +4,7 @@
 
 import logging
 import random
+import time
 from collections.abc import Callable
 from datetime import datetime, timedelta
 from timeit import default_timer as timer
@@ -39,6 +40,7 @@ class WrappedCallback:
         self.duration = 0  # global counter
         self.duration_interval_total = 0  # counter per interval = 1 min by default
         self.cluster_time_diff = 0
+        self.start_timestamp_monotonic = time.monotonic()
         self.start_timestamp = self.get_current_time_with_cluster_diff()
         self.running_in_sim = running_in_sim
         self.activation_type = activation_type
@@ -147,8 +149,6 @@ class WrappedCallback:
         """
         Get the timestamp for the next execution of the callback
         This is done using execution total, the interval and the start timestamp
-        :return: datetime
+        :return: float
         """
-        return (
-            self.start_timestamp + timedelta(seconds=self.interval.total_seconds() * (self.iterations or 1))
-        ).timestamp()
+        return self.start_timestamp_monotonic + self.interval.total_seconds() * (self.iterations or 1)

{dt_extensions_sdk-1.7.1 → dt_extensions_sdk-1.7.3}/dynatrace_extension/sdk/communication.py

@@ -343,7 +343,7 @@ class DebugClient(CommunicationClient):
     def get_feature_sets(self) -> dict[str, list[str]]:
         # This is only called from dt-sdk run, where PyYaml is installed because of dt-cli
         # Do NOT move this to the top of the file
-        import yaml  # type: ignore
+        import yaml  # noqa: PLC0415
 
         # Grab the feature sets from the extension.yaml file
         extension_yaml = yaml.safe_load(self.extension_config)

{dt_extensions_sdk-1.7.1 → dt_extensions_sdk-1.7.3}/dynatrace_extension/sdk/extension.py

@@ -28,10 +28,11 @@ from .snapshot import Snapshot
 from .status import EndpointStatuses, EndpointStatusesMap, IgnoreStatus, Status, StatusValue
 from .throttled_logger import StrictThrottledHandler, ThrottledHandler
 
-HEARTBEAT_INTERVAL = timedelta(seconds=50)
-METRIC_SENDING_INTERVAL = timedelta(seconds=30)
-SFM_METRIC_SENDING_INTERVAL = timedelta(seconds=60)
-TIME_DIFF_INTERVAL = timedelta(seconds=60)
+# Intervals defined in seconds for internal callbacks
+HEARTBEAT_INTERVAL = 50
+METRIC_SENDING_INTERVAL = 30
+SFM_METRIC_SENDING_INTERVAL = 60
+TIME_DIFF_INTERVAL = 60
 
 CALLBACKS_THREAD_POOL_SIZE = 100
 INTERNAL_THREAD_POOL_SIZE = 20
@@ -180,11 +181,11 @@ class Extension:
     """
 
     _instance: ClassVar = None
-    schedule_decorators: ClassVar = []
+    schedule_decorators: ClassVar[list[tuple[Callable, timedelta | int, tuple | None, ActivationType | None]]] = []
 
     def __new__(cls, *args, **kwargs):  # noqa: ARG004
         if Extension._instance is None:
-            Extension._instance = super(__class__, cls).__new__(cls)
+            Extension._instance = super().__new__(cls)
         return Extension._instance
 
     def __init__(self, name: str = "") -> None:
@@ -240,15 +241,15 @@ class Extension:
         self._running_callbacks: dict[int, WrappedCallback] = {}
         self._running_callbacks_lock: Lock = Lock()
 
-        self._scheduler = sched.scheduler(time.time, time.sleep)
+        self._scheduler = sched.scheduler(time.monotonic, time.sleep)
 
         # Timestamps for scheduling of internal callbacks
-        self._next_internal_callbacks_timestamps: dict[str, datetime] = {
-            "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,
+        self._next_internal_callbacks_timestamps: dict[str, float] = {
+            "timediff": time.monotonic() + TIME_DIFF_INTERVAL,
+            "heartbeat": time.monotonic() + HEARTBEAT_INTERVAL,
+            "metrics": time.monotonic() + METRIC_SENDING_INTERVAL,
+            "events": time.monotonic() + METRIC_SENDING_INTERVAL,
+            "sfm_metrics": time.monotonic() + SFM_METRIC_SENDING_INTERVAL,
         }
 
         # Executors for the callbacks and internal methods
@@ -412,7 +413,7 @@ class Extension:
         else:
             self._schedule_callback(callback)
 
-    def query(self):
+    def query(self) -> Any:
         """Callback to be executed every minute by default.
 
         Optional method that can be implemented by subclasses.
@@ -683,7 +684,7 @@ class Extension:
                 msg = f"Event type must be a DtEventType enum value, got: {value}"
                 raise ValueError(msg)
             if key == "properties":
-                for prop_key, prop_val in event[key].items():
+                for prop_key, prop_val in value.items():
                     if not isinstance(prop_key, str) or not isinstance(prop_val, str):
                         msg = f'invalid "properties" member: {prop_key}: {prop_val}, required: "str": str'
                         raise ValueError(msg)
@@ -777,7 +778,7 @@ class Extension:
         parser.add_argument("--secrets", required=False, default="secrets.json")
         parser.add_argument("--no-print-metrics", required=False, action="store_true")
 
-        args, unknown = parser.parse_known_args()
+        args, _ = parser.parse_known_args()
         self._is_fastcheck = args.fastcheck
         if args.dsid is None:
             # DEV mode
@@ -1169,10 +1170,10 @@ class Extension:
     def _send_dt_event(self, event: dict[str, str | int | dict[str, str]]):
         self._client.send_dt_event(event)
 
-    def _get_and_set_next_internal_callback_timestamp(self, callback_name: str, interval: timedelta):
+    def _get_and_set_next_internal_callback_timestamp(self, callback_name: str, interval: float) -> float:
         next_timestamp = self._next_internal_callbacks_timestamps[callback_name]
         self._next_internal_callbacks_timestamps[callback_name] += interval
-        return next_timestamp.timestamp()
+        return next_timestamp
 
     def get_version(self) -> str:
         """Return the extension version."""

{dt_extensions_sdk-1.7.1 → dt_extensions_sdk-1.7.3}/dynatrace_extension/sdk/status.py

@@ -114,6 +114,9 @@ class EndpointStatus:
     def __eq__(self, other):
         return isinstance(other, EndpointStatus) and self.__dict__ == other.__dict__
 
+    def __hash__(self):
+        return hash(tuple(sorted(self.__dict__.items())))
+
 
 class EndpointStatuses:
     def __init__(self, total_endpoints_number=None) -> None:
@@ -227,33 +230,34 @@ class EndpointStatusesMap:
         with self._lock:
             # Summarize all statuses
             ok_count = 0
-            nok_count = 0
-            error_messages = []
-            has_warning_status = False
+            warning_count = 0
+            error_count = 0
+            messages_to_report = []
 
             for ep_record in self._ep_records.values():
                 ep_status = ep_record.ep_status
-                if ep_status.status.is_warning():
-                    has_warning_status = True
 
-                if ep_status.status.is_error():
-                    nok_count += 1
-                    error_messages.append(f"{ep_status.endpoint} - {ep_status.status.value} {ep_status.message}")
+                if ep_status.status.is_warning():
+                    warning_count += 1
+                    messages_to_report.append(f"{ep_status.endpoint} - {ep_status.status.value} {ep_status.message}")
+                elif ep_status.status.is_error():
+                    error_count += 1
+                    messages_to_report.append(f"{ep_status.endpoint} - {ep_status.status.value} {ep_status.message}")
                 else:
                     ok_count += 1
 
+            status_msg = f"Endpoints OK: {ok_count} WARNING: {warning_count} ERROR: {error_count}"
+
             # Early return if all OK
-            if nok_count == 0:
-                return Status(StatusValue.OK, f"Endpoints OK: {ok_count} NOK: 0")
+            if error_count == 0 and warning_count == 0:
+                return Status(StatusValue.OK, status_msg)
 
             # Build final status if some errors present
-            common_msg = ", ".join(error_messages)
-            all_endpoints_faulty = ok_count == 0
+            status_msg += f" Unhealthy endpoints: {', '.join(messages_to_report)}"
 
-            if all_endpoints_faulty and not has_warning_status:
+            if ok_count == 0 and warning_count == 0:
                 status_value = StatusValue.GENERIC_ERROR
             else:
                 status_value = StatusValue.WARNING
 
-            message = f"Endpoints OK: {ok_count} NOK: {nok_count} NOK_reported_errors: {common_msg}"
-            return Status(status=status_value, message=message)
+            return Status(status=status_value, message=status_msg)

{dt_extensions_sdk-1.7.1 → dt_extensions_sdk-1.7.3}/tests/sdk/test_extension.py

@@ -1,7 +1,7 @@
 import threading
 import time
 import unittest
-from datetime import datetime, timedelta
+from datetime import timedelta
 from unittest.mock import MagicMock, mock_open, patch
 
 import pytest
@@ -27,7 +27,7 @@ class TestExtension(unittest.TestCase):
         extension = Extension()
         extension.logger = MagicMock()
         extension._running_in_sim = True
-        extension._next_heartbeat = datetime.now()
+        extension._next_heartbeat = time.monotonic()
         extension._heartbeat_iteration()
         extension._heartbeat.assert_called()
 
@@ -387,15 +387,15 @@ class TestExtension(unittest.TestCase):
         extension._client = MagicMock()
 
         fastcheck = MagicMock()
-        fastcheck.side_effect = Exception("SomeException")
+        fastcheck.side_effect = ImportError("SomeException")
         extension.register_fastcheck(fastcheck)
-        self.assertRaises(Exception, extension._run_fastcheck)
+        self.assertRaises(ImportError, extension._run_fastcheck)
 
         fastcheck.assert_called_once()
         extension._client.send_status.assert_called_once()
         self.assertEqual(extension._client.send_status.call_args[0][0].status, StatusValue.GENERIC_ERROR)
         self.assertIn(
-            "Python datasource fastcheck error: Exception('SomeException')",
+            "Python datasource fastcheck error: ImportError('SomeException')",
             extension._client.send_status.call_args[0][0].message,
         )
 

{dt_extensions_sdk-1.7.1 → dt_extensions_sdk-1.7.3}/tests/sdk/test_status.py

@@ -305,7 +305,7 @@ class TestStatus(unittest.TestCase):
 
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.OK)
-        self.assertIn("OK: 3 NOK: 0", status.message)
+        self.assertIn("OK: 3 WARNING: 0 ERROR: 0", status.message)
 
     def test_endpoint_status_some_faulty_endpoints(self):
         ext = Extension()
@@ -334,8 +334,8 @@ class TestStatus(unittest.TestCase):
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.WARNING)
         self.assertIn(
-            "OK: 1 NOK: 2 NOK_reported_errors: 4.5.6.7:80 - DEVICE_CONNECTION_ERROR "
-            "Invalid authorization scheme 2, 6.7.8.9:80 - DEVICE_CONNECTION_ERROR Invalid authorization scheme 3",
+            "Endpoints OK: 1 WARNING: 0 ERROR: 2 Unhealthy endpoints: "
+            "4.5.6.7:80 - DEVICE_CONNECTION_ERROR Invalid authorization scheme 2, 6.7.8.9:80 - DEVICE_CONNECTION_ERROR Invalid authorization scheme 3",
             status.message,
         )
 
@@ -368,9 +368,8 @@ class TestStatus(unittest.TestCase):
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.GENERIC_ERROR)
         self.assertIn(
-            "OK: 0 NOK: 3 NOK_reported_errors: 1.2.3.4:80 - AUTHENTICATION_ERROR "
-            "Invalid authorization scheme 4, 4.5.6.7:80 - DEVICE_CONNECTION_ERROR "
-            "Invalid authorization scheme 5, 6.7.8.9:80 - DEVICE_CONNECTION_ERROR Invalid authorization scheme 6",
+            "Endpoints OK: 0 WARNING: 0 ERROR: 3 Unhealthy endpoints: 1.2.3.4:80 - AUTHENTICATION_ERROR Invalid authorization scheme 4, "
+            "4.5.6.7:80 - DEVICE_CONNECTION_ERROR Invalid authorization scheme 5, 6.7.8.9:80 - DEVICE_CONNECTION_ERROR Invalid authorization scheme 6",
             status.message,
         )
 
@@ -391,7 +390,7 @@ class TestStatus(unittest.TestCase):
 
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.OK)
-        self.assertNotIn("OK: 0 NOK: 0", status.message)
+        self.assertNotIn("Endpoints", status.message)
 
     def test_endpoint_status_single_warning(self):
         ext = Extension()
@@ -414,7 +413,8 @@ class TestStatus(unittest.TestCase):
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.WARNING)
         self.assertIn(
-            "OK: 0 NOK: 1 NOK_reported_errors: 1.2.3.4:80 - WARNING Invalid authorization scheme A", status.message
+            "Endpoints OK: 0 WARNING: 1 ERROR: 0 Unhealthy endpoints: 1.2.3.4:80 - WARNING Invalid authorization scheme A",
+            status.message,
         )
 
     def test_endpoint_status_single_error(self):
@@ -438,7 +438,7 @@ class TestStatus(unittest.TestCase):
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.GENERIC_ERROR)
         self.assertIn(
-            "OK: 0 NOK: 1 NOK_reported_errors: 1.2.3.4:80 - AUTHENTICATION_ERROR Invalid authorization scheme",
+            "OK: 0 WARNING: 0 ERROR: 1 Unhealthy endpoints: 1.2.3.4:80 - AUTHENTICATION_ERROR Invalid authorization scheme",
             status.message,
         )
 
@@ -467,7 +467,7 @@ class TestStatus(unittest.TestCase):
 
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.OK)
-        self.assertIn("OK: 3 NOK: 0", status.message)
+        self.assertIn("OK: 3 WARNING: 0 ERROR: 0", status.message)
 
     def test_endpoint_merge_error(self):
         def callback_ep_status_1():
@@ -494,7 +494,7 @@ class TestStatus(unittest.TestCase):
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.GENERIC_ERROR)
         self.assertIn(
-            "OK: 0 NOK: 2 NOK_reported_errors: EP_HINT_1 - AUTHENTICATION_ERROR EP1 MSG, EP_HINT_2 - INVALID_CONFIG_ERROR EP2 MSG",
+            "OK: 0 WARNING: 0 ERROR: 2 Unhealthy endpoints: EP_HINT_1 - AUTHENTICATION_ERROR EP1 MSG, EP_HINT_2 - INVALID_CONFIG_ERROR EP2 MSG",
             status.message,
         )
 
@@ -522,7 +522,7 @@ class TestStatus(unittest.TestCase):
 
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.WARNING)
-        self.assertIn("OK: 1 NOK: 1 NOK_reported_errors: EP_HINT_2 - WARNING EP2 MSG", status.message)
+        self.assertIn("OK: 1 WARNING: 1 ERROR: 0 Unhealthy endpoints: EP_HINT_2 - WARNING EP2 MSG", status.message)
 
     def test_overall_status_error(self):
         def callback_ep_status():
@@ -554,7 +554,7 @@ class TestStatus(unittest.TestCase):
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.GENERIC_ERROR)
         self.assertIn(
-            "Endpoints OK: 0 NOK: 1 NOK_reported_errors: EP_HINT - UNKNOWN_ERROR EP MSG"
+            "Endpoints OK: 0 WARNING: 0 ERROR: 1 Unhealthy endpoints: EP_HINT - UNKNOWN_ERROR EP MSG"
             "\ncallback_multistatus: GENERIC_ERROR - MULTI MSG\ncallback_status: EEC_CONNECTION_ERROR - STATUS MSG",
             status.message,
         )
@@ -588,7 +588,7 @@ class TestStatus(unittest.TestCase):
 
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.OK)
-        self.assertIn("Endpoints OK: 1 NOK: 0\ncallback_status: OK - STATUS MSG", status.message)
+        self.assertIn("Endpoints OK: 1 WARNING: 0 ERROR: 0\ncallback_status: OK - STATUS MSG", status.message)
 
     def test_overall_status_warning_1(self):
         def callback_ep_status():
@@ -620,7 +620,7 @@ class TestStatus(unittest.TestCase):
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.WARNING)
         self.assertIn(
-            "Endpoints OK: 0 NOK: 1 NOK_reported_errors: EP_HINT - WARNING EP MSG\ncallback_multistatus: OK - MULTI MSG",
+            "Endpoints OK: 0 WARNING: 1 ERROR: 0 Unhealthy endpoints: EP_HINT - WARNING EP MSG\ncallback_multistatus: OK - MULTI MSG",
             status.message,
         )
 
@@ -654,8 +654,9 @@ class TestStatus(unittest.TestCase):
         status = ext._build_current_status()
         self.assertEqual(status.status, StatusValue.WARNING)
         self.assertIn(
-            "Endpoints OK: 0 NOK: 1 NOK_reported_errors: EP_HINT - INVALID_CONFIG_ERROR "
-            "\ncallback_multistatus: GENERIC_ERROR - \ncallback_status: WARNING - ",
+            "Endpoints OK: 0 WARNING: 0 ERROR: 1 Unhealthy endpoints: EP_HINT - INVALID_CONFIG_ERROR "
+            "\ncallback_multistatus: GENERIC_ERROR - "
+            "\ncallback_status: WARNING - ",
             status.message,
         )
 
@@ -711,7 +712,7 @@ class TestStatus(unittest.TestCase):
             self.assertEqual(status.status, StatusValue.GENERIC_ERROR)
             self.assertIn(
                 (
-                    "Endpoints OK: 0 NOK: 2 NOK_reported_errors: "
+                    "Endpoints OK: 0 WARNING: 0 ERROR: 2 Unhealthy endpoints: "
                     "skipped_callback - GENERIC_ERROR skipped_callback_msg, regular_callback - UNKNOWN_ERROR regular_callback_msg"
                 ),
                 status.message,