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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dt-extensions-sdk
-Version: 1.3.1
+Version: 1.4.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
@@ -16,6 +16,7 @@ Requires-Python: <3.11,>=3.10
 Provides-Extra: cli
 Requires-Dist: dt-cli>=1.6.13; extra == 'cli'
 Requires-Dist: pyyaml; extra == 'cli'
+Requires-Dist: ruff; extra == 'cli'
 Requires-Dist: typer[all]; extra == 'cli'
 Description-Content-Type: text/markdown
 

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

@@ -1,25 +1,26 @@
-dynatrace_extension/__about__.py,sha256=-jEpNU1eRpe8GBW_KoSO-6Flc820P-KhyssXl0K9kO4,110
+dynatrace_extension/__about__.py,sha256=sfmpNB9deUupD5FEf51kP87yHBs_W3e0oAyN3Zd3_vI,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
+dynatrace_extension/cli/main.py,sha256=afgSPayrpxwQjcCZzv9dIEbYBWs84708BbwoQr8XL4w,20157
 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=FPye23W8dqmked4HQBCDCAKFf1UbBGkwhKjQpgmXhdg,3101
 dynatrace_extension/cli/create/extension_template/README.md.template,sha256=QcV0fYqJ1PHaouKdGQgzveJY5zAFBSICp7xSfgnoQj0,637
 dynatrace_extension/cli/create/extension_template/activation.json.template,sha256=qX-Fgq_JhUWNYMe1-RMcjwQPzF4scJYGfGlBr043UiY,266
+dynatrace_extension/cli/create/extension_template/ruff.toml.template,sha256=knGDPYHrdrlSDXpe3XNofcgAP-6XyzyHNqLd6Tr8bbs,1853
 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/setup.py.template,sha256=CPSx_mRKP6R273wFN-tJFQEsMNF2ktSO-I58mAWLM9M,829
 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
 dynatrace_extension/cli/create/extension_template/extension_name/__init__.py.template,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dynatrace_extension/cli/create/extension_template/extension_name/__main__.py.template,sha256=NYuZ6BWZ6HOs4TCuboh6S0nuYp3F8MXW2lmjSpdREEA,1205
+dynatrace_extension/cli/create/extension_template/extension_name/__main__.py.template,sha256=cS79GVxJB-V-gocu4ZOjmZ54HXJNg89eXdLf89zDHJQ,1249
 dynatrace_extension/sdk/__init__.py,sha256=RsqQ1heGyCmSK3fhuEKAcxQIRCg4gEK0-eSkIehL5Nc,86
 dynatrace_extension/sdk/activation.py,sha256=goTbT1tD2kn8xfyXFdTy_cTZNcFPJpgbvQM8HOzKECA,1480
 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=RnF7Czlmg6QrQLLlP90dM0tAIxdX3LrqaUi8M1p1Guo,43251
+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 +29,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.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.4.1.dist-info/METADATA,sha256=MxsxFe30Bn3TW-Gpdul4OrkySRE6JHb_bDxWKZAWkCo,2721
+dt_extensions_sdk-1.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dt_extensions_sdk-1.4.1.dist-info/entry_points.txt,sha256=pweyOCgENGHjOlT6_kXYaBPOrE3p18K0UettqnNlnoE,55
+dt_extensions_sdk-1.4.1.dist-info/licenses/LICENSE.txt,sha256=3Zihv0lOVYHNfDkJC-tUAU6euP9r2NexsDW4w-zqgVk,1078
+dt_extensions_sdk-1.4.1.dist-info/RECORD,,

dynatrace_extension/__about__.py

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

dynatrace_extension/cli/create/extension_template/extension_name/__main__.py.template

@@ -2,7 +2,6 @@ from dynatrace_extension import Extension, Status, StatusValue
 
 
 class ExtensionImpl(Extension):
-
     def query(self):
         """
         The query method is automatically scheduled to run every minute
@@ -11,22 +10,24 @@ class ExtensionImpl(Extension):
 
         for endpoint in self.activation_config["endpoints"]:
             url = endpoint["url"]
-            user = endpoint["user"]
-            password = endpoint["password"]
+            # user = endpoint["user"]
+            # password = endpoint["password"]
             self.logger.debug(f"Running endpoint with url '{url}'")
 
             # Your extension code goes here, e.g.
             # response = requests.get(url, auth=(user, password))
 
             # Report metrics with
-            self.report_metric("my_metric", 1, dimensions={"my_dimension": "dimension1"})
+            self.report_metric("metric_key", 1, dimensions={"key": "value"})
 
         self.logger.info("query method ended for %extension_name%.")
 
     def fastcheck(self) -> Status:
         """
-        This is called when the extension runs for the first time.
-        If this AG cannot run this extension, raise an Exception or return StatusValue.ERROR!
+        Use to check if the extension can run.
+        If this Activegate cannot run this extension, you can
+        raise an Exception or return StatusValue.ERROR.
+        This does not run for OneAgent extensions.
         """
         return Status(StatusValue.OK)
 
@@ -35,6 +36,5 @@ def main():
     ExtensionImpl(name="%extension_name%").run()
 
 
-
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

dynatrace_extension/cli/create/extension_template/ruff.toml.template

@@ -0,0 +1,77 @@
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+    "windows.py", # windows run as
+    "windows_runas.py", # windows run as
+    "*grpc.py", # automatically generated grpc files
+    "mureq.py", # a replacement for requests
+    "vendor", # vendored dependencies
+    "alembic", # alembic migrations
+    "oci", # special case for an extension
+    "pymqi", # special case for an extension
+    "lib" # some extensions commit a lib folder
+]
+
+line-length = 110
+indent-width = 4
+
+# Assume Python 3.10
+target-version = "py310"
+
+[lint]
+select = ["E", "F", "W", "C90", "I", "N", "UP", "B", "A", "FA", "T20", "Q", "RET", "SIM", "ARG", "PTH", "C"]
+ignore = [
+    "T201", # we allow print because these are logged into the extension logs
+     "PTH123" # open is used too frequently to open files
+]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[lint.mccabe]
+# Flag errors (`C901`) whenever the complexity level exceeds 20.
+max-complexity = 20
+
+[format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+docstring-code-format = false
+docstring-code-line-length = "dynamic"

dynatrace_extension/cli/create/extension_template/setup.py.template

@@ -1,5 +1,6 @@
 from pathlib import Path
-from setuptools import setup, find_packages
+
+from setuptools import find_packages, setup
 
 
 def find_version() -> str:
@@ -9,20 +10,21 @@ def find_version() -> str:
         with open(extension_yaml_path, encoding="utf-8") as f:
             for line in f:
                 if line.startswith("version"):
-                    version = line.split(" ")[-1].strip("\"")
+                    version = line.split(" ")[-1].strip('"')
                     break
     except Exception:
         pass
     return version
 
 
-setup(name="%extension_name%",
-      version=find_version(),
-      description="%Extension_Name% python EF2 extension",
-      author="Dynatrace",
-      packages=find_packages(),
-      python_requires=">=3.10",
-      include_package_data=True,
-      install_requires=["dt-extensions-sdk"],
-      extras_require={"dev": ["dt-extensions-sdk[cli]"]},
-      )
+setup(
+    name="%extension_name%",
+    version=find_version(),
+    description="%Extension_Name% python EF2 extension",
+    author="Dynatrace",
+    packages=find_packages(),
+    python_requires=">=3.10",
+    include_package_data=True,
+    install_requires=["dt-extensions-sdk"],
+    extras_require={"dev": ["dt-extensions-sdk[cli]"]},
+)

dynatrace_extension/cli/main.py

@@ -425,6 +425,56 @@ def create(extension_name: str, output: Path = typer.Option(None, "--output", "-
     console.print(f"Extension created at {extension_path}", style="bold green")
 
 
+@app.command(
+    "format",
+    help="Runs ruff format on the extension code",
+)
+def fmt(extension_dir: Path = typer.Argument(".", help="Path to the python extension")):
+    """
+    Runs ruff format on the extension code
+
+    :param extension_dir: The directory of the extension, by default this is the current directory
+    """
+    run_process(["ruff", "format", str(extension_dir.resolve())])
+
+
+@app.command(help="Runs ruff check on the extension code")
+def lint(
+    extension_dir: Path = typer.Argument(".", help="Path to the python extension"),
+    fix: bool = typer.Option(False, "--fix", "-f", help="Fix linting issues"),
+):
+    """
+    Runs ruff lint on the extension code
+
+    :param extension_dir: The directory of the extension, by default this is the current directory
+    :param fix: If true, ask ruff to also fix the linting issues
+    """
+    command = ["ruff", "check", "--exit-zero"]
+    if fix:
+        command.append("--fix")
+    command.append(str(extension_dir.resolve()))
+    run_process(command)
+
+
+@app.command(help="Adds ruff rules if they don't exist already")
+def ruff_init(extension_dir: Path = typer.Argument(".", help="Path to the python extension")):
+    """
+    Adds ruff rules if they don't exist already
+
+    :param extension_dir: The directory of the extension, by default this is the current directory
+    """
+
+    if (extension_dir / "ruff.toml").exists():
+        console.print(f"ruff.toml already exists in {extension_dir.resolve()}, skipping", style="bold yellow")
+        return
+    else:
+        # create\extension_template\ruff.toml.template -> extension\ruff.toml
+        ruff_template = Path(__file__).parent / "create" / "extension_template" / "ruff.toml.template"
+        ruff_file = extension_dir / "ruff.toml"
+        shutil.copy(ruff_template, ruff_file)
+        console.print(f"Added ruff.toml to {extension_dir.resolve()}", style="bold green")
+
+
 def run_process(
     command: List[str], cwd: Optional[Path] = None, env: Optional[dict] = None, print_message: Optional[str] = None
 ):

dynatrace_extension/sdk/extension.py

@@ -215,6 +215,7 @@ 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,
         }
 
@@ -227,6 +228,10 @@ class Extension:
         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] = {}
@@ -505,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.
 
@@ -514,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)
@@ -530,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,
@@ -635,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:
@@ -643,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]]:
@@ -819,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()
@@ -838,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)
@@ -1044,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)