dt-extensions-sdk 1.2.14__py3-none-any.whl → 1.3.1__py3-none-any.whl

{dt_extensions_sdk-1.2.14.dist-info → dt_extensions_sdk-1.3.1.dist-info}/METADATA

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

{dt_extensions_sdk-1.2.14.dist-info → dt_extensions_sdk-1.3.1.dist-info}/RECORD

@@ -1,13 +1,14 @@
-dynatrace_extension/__about__.py,sha256=OAg8p7JkpTB4TTezDDuRFRD-dX4xumJyns-GLgyZaOw,111
+dynatrace_extension/__about__.py,sha256=-jEpNU1eRpe8GBW_KoSO-6Flc820P-KhyssXl0K9kO4,110
 dynatrace_extension/__init__.py,sha256=BvQuknmA7ti3WJi3zEXZfY7aAxJrie37VNitWICsUvI,752
 dynatrace_extension/cli/__init__.py,sha256=HCboY_eJPoqjFmoPDsBL8Jk6aNvank8K7JpkVrgwzUM,123
-dynatrace_extension/cli/main.py,sha256=qv6BRgoyvhThhRh64OzL6OYHSLoxiJgWlZIxUDxKX4E,17995
+dynatrace_extension/cli/main.py,sha256=Z8gFcp0vIMBkzV6jUd5mwvP1U0JcLqAHoMLJw_6puz4,18260
 dynatrace_extension/cli/schema.py,sha256=d8wKUodRiaU3hfSZDWVNpD15lBfhmif2oQ-k07IxcaA,3230
 dynatrace_extension/cli/create/__init__.py,sha256=NfyOJCVlxs8dYtfDAMHS1Q5SJTuZcFzOg5rtaI-ZPRE,72
 dynatrace_extension/cli/create/create.py,sha256=apXden2M93MDDDm7aa-Os-AEtUtyKbk_PsS56j32NK4,2708
-dynatrace_extension/cli/create/extension_template/.gitignore.template,sha256=XixnHdyeMB2vwkGtGnwHqoWpH-9WChdyG0GXe57duhc,3078
+dynatrace_extension/cli/create/extension_template/.gitignore.template,sha256=FPye23W8dqmked4HQBCDCAKFf1UbBGkwhKjQpgmXhdg,3101
 dynatrace_extension/cli/create/extension_template/README.md.template,sha256=QcV0fYqJ1PHaouKdGQgzveJY5zAFBSICp7xSfgnoQj0,637
-dynatrace_extension/cli/create/extension_template/activation.json.template,sha256=EtjCI3EZY5nHu4ONcWLzaOR-Et5SdU0BMkCp0ZSPSrA,257
+dynatrace_extension/cli/create/extension_template/activation.json.template,sha256=qX-Fgq_JhUWNYMe1-RMcjwQPzF4scJYGfGlBr043UiY,266
+dynatrace_extension/cli/create/extension_template/secrets.json.template,sha256=fr-ya8lR0TiUmr6lf-PFko6RZw6sr54FxtMbqIWBVkA,36
 dynatrace_extension/cli/create/extension_template/setup.py.template,sha256=M4HPg3UFkvmWFHAz6vHbDG5Ocb-ZiR0TQuLt9eedW1M,846
 dynatrace_extension/cli/create/extension_template/extension/activationSchema.json.template,sha256=me3DL_Q449q4VaOStTqaBL-gUkKnlafC8L2093O0LOY,2905
 dynatrace_extension/cli/create/extension_template/extension/extension.yaml.template,sha256=qDyAURGXKsZBIPjW2s1BPhD-xOC8_FoBgA33HbsOkAU,299
@@ -15,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=lPUKxAq3mO8cO1ye79p9nuxYL-_cG6G4cJRzBZxD64w,17792
+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=2H86BhYwuLGs35c522TgMHBiBJcc_qXcQO-AxGHp2x4,42816
+dynatrace_extension/sdk/extension.py,sha256=RnF7Czlmg6QrQLLlP90dM0tAIxdX3LrqaUi8M1p1Guo,43251
 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
@@ -27,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.2.14.dist-info/METADATA,sha256=RCVLQM2azU7CLaL0G507ojhkDVPlqpFJwShuCAKv1BY,2686
-dt_extensions_sdk-1.2.14.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-dt_extensions_sdk-1.2.14.dist-info/entry_points.txt,sha256=pweyOCgENGHjOlT6_kXYaBPOrE3p18K0UettqnNlnoE,55
-dt_extensions_sdk-1.2.14.dist-info/licenses/LICENSE.txt,sha256=3Zihv0lOVYHNfDkJC-tUAU6euP9r2NexsDW4w-zqgVk,1078
-dt_extensions_sdk-1.2.14.dist-info/RECORD,,
+dt_extensions_sdk-1.3.1.dist-info/METADATA,sha256=LwKOdwizaSteiT3s-yPkAXYRyqkiqQC11TaPXiGlJ-Q,2685
+dt_extensions_sdk-1.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dt_extensions_sdk-1.3.1.dist-info/entry_points.txt,sha256=pweyOCgENGHjOlT6_kXYaBPOrE3p18K0UettqnNlnoE,55
+dt_extensions_sdk-1.3.1.dist-info/licenses/LICENSE.txt,sha256=3Zihv0lOVYHNfDkJC-tUAU6euP9r2NexsDW4w-zqgVk,1078
+dt_extensions_sdk-1.3.1.dist-info/RECORD,,

{dt_extensions_sdk-1.2.14.dist-info → dt_extensions_sdk-1.3.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+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.2.14"
+__version__ = "1.3.1"

dynatrace_extension/cli/create/extension_template/.gitignore.template

@@ -158,3 +158,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# Secrets
+secrets.json

dynatrace_extension/cli/create/extension_template/activation.json.template

@@ -8,7 +8,7 @@
 			{
 				"url": "http://127.0.0.1:15672",
 				"user": "guest",
-				"password": "guest"
+				"password": "{{myPassword}}"
 			}
 		]
 	}

dynatrace_extension/cli/create/extension_template/secrets.json.template

@@ -0,0 +1,3 @@
+{
+	"myPassword": "secretPassword"
+}

dynatrace_extension/cli/main.py

@@ -40,6 +40,7 @@ def version():
 def run(
     extension_dir: Path = typer.Argument("."),
     activation_config: str = "activation.json",
+    secrets: str = "secrets.json",
     fast_check: bool = typer.Option(False, "--fastcheck"),
     local_ingest: bool = typer.Option(False, "--local-ingest"),
     local_ingest_port: int = typer.Option(14499, "--local-ingest-port"),
@@ -50,6 +51,7 @@ def run(
 
     :param extension_dir: The directory of the extension, by default this is the current directory
     :param activation_config: The activation config file, by default this is activation.json
+    :param secrets: The secrets file to be used to enrich the activation config, by default this is secrets.json
     :param fast_check: If true, run a fastcheck and exits
     :param local_ingest: If true, send metrics to localhost:14499 on top of printing them
     :param local_ingest_port: The port to send metrics to, by default this is 14499
@@ -59,7 +61,15 @@ def run(
     # This parses the yaml, which validates it before running
     extension_yaml = ExtensionYaml(extension_dir / "extension/extension.yaml")
     try:
-        command = [sys.executable, "-m", extension_yaml.python.runtime.module, "--activationconfig", activation_config]
+        command = [
+            sys.executable,
+            "-m",
+            extension_yaml.python.runtime.module,
+            "--activationconfig",
+            activation_config,
+            "--secrets",
+            secrets,
+        ]
         if fast_check:
             command.append("--fastcheck")
         if local_ingest:

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
@@ -324,14 +347,24 @@ class DebugClient(CommunicationClient):
         activation_config_path: str,
         extension_config_path: str,
         logger: logging.Logger,
+        secrets_path: str = "secrets.json",
         local_ingest: bool = False,
         local_ingest_port: int = 14499,
         print_metrics: bool = True,
     ):
+
+        self.secrets = {}
+        if secrets_path and Path(secrets_path).exists():
+            with open(secrets_path) as f:
+                self.secrets = json.load(f)
+
         self.activation_config = {}
         if activation_config_path and Path(activation_config_path).exists():
             with open(activation_config_path) as f:
-                self.activation_config = json.load(f)
+                raw_activation_config = f.read()
+                self.activation_config = json.loads(
+                    self.replace_secrets_in_activation_config(self.secrets, raw_activation_config)
+                )
 
         self.extension_config = ""
         if not extension_config_path:
@@ -430,6 +463,12 @@ class DebugClient(CommunicationClient):
     def get_cluster_time_diff(self) -> int:
         return 0
 
+    def replace_secrets_in_activation_config(self, secrets: dict, activation_config_string: str) -> str:
+        for secret_name, secret_value in secrets.items():
+            activation_config_string = activation_config_string.replace(f"{{{{{secret_name}}}}}", str(secret_value))
+
+        return activation_config_string
+
 
 def divide_into_batches(
     items: Sequence[dict | str], max_size_bytes: int, join_with: str | None = None

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()
@@ -715,6 +717,7 @@ class Extension:
         # Debug parameters, these are used when running the extension locally
         parser.add_argument("--extensionconfig", required=False, default=None)
         parser.add_argument("--activationconfig", required=False, default="activation.json")
+        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()
@@ -727,6 +730,7 @@ class Extension:
                 activation_config_path=args.activationconfig,
                 extension_config_path=args.extensionconfig,
                 logger=api_logger,
+                secrets_path=args.secrets,
                 local_ingest=args.local_ingest,
                 local_ingest_port=args.local_ingest_port,
                 print_metrics=print_metrics,
@@ -825,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)
 
@@ -974,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