dt-extensions-sdk 1.1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

docs/conf.py

@@ -0,0 +1,98 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+from datetime import datetime
+
+sys.path.insert(0, os.path.abspath("."))
+
+
+# -- Project information -----------------------------------------------------
+project = "dt-sdk"
+copyright = f"2023–{datetime.now().year}, Dynatrace LLC"
+author = "Dynatrace"
+
+# Short version
+version = "1.0.0"
+# The full version, including alpha/beta/rc tags
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosectionlabel",
+    "sphinx_wagtail_theme",
+    "sphinxcontrib.programoutput",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# True to prefix each section label with the name of the document it is in,
+# followed by a colon. For example, index:Introduction for a section called
+# Introduction that appears in document index.rst. Useful for avoiding
+# ambiguity when the same section heading appears in different documents.
+autosectionlabel_prefix_document = True
+
+# -- Autodoc -----------------------------------------------------------------
+
+autodoc_default_options = {"member-order": "bysource", "undoc-members": True}
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_wagtail_theme"
+html_favicon = "_static/favicon.ico"
+html_show_copyright = True
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# html_sidebars = {"**": ["search-field.html", "sidebar-nav-bs.html"]}
+
+html_theme_options = {
+    "project_name": "dt-sdk",
+    "logo": "dt-sdk-logo.png",
+    "logo_alt": "dt-sdk",
+    "logo_url": "/",
+    "github_url": "https://github.com/dynatrace-extensions/dt-extensions-python-sdk",
+    "footer_links": ",".join(
+        [
+            "Dynatrace|https://dynatrace.com/",
+            "Extensions Team|mailto:extenions@dynatrace.com",
+        ]
+    ),
+}

{dt_extensions_sdk-1.1.0.dist-info → dt_extensions_sdk-1.1.1.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: dt-extensions-sdk
-Version: 1.1.0
-Project-URL: Documentation, https://github.com/unknown/dynatrace-extensions-sdk#readme
-Project-URL: Issues, https://github.com/unknown/dynatrace-extensions-sdk/issues
-Project-URL: Source, https://github.com/unknown/dynatrace-extensions-sdk
+Version: 1.1.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
 Author-email: dlopes7 <davidribeirolopes@gmail.com>
 License-Expression: MIT
 License-File: LICENSE.txt
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.7
+Requires-Python: >=3.10
 Provides-Extra: cli
 Requires-Dist: dt-cli==1.6.13; extra == 'cli'
 Requires-Dist: pyyaml; extra == 'cli'
@@ -32,19 +32,55 @@ Description-Content-Type: text/markdown
 
 **Table of Contents**
 
-- [Installation](#installation)
+- [Quick Start](#quick-start)
 - [License](#license)
 - [Developing](#developing)
 
-## Installation
+## Quick Start
 
-```console
-pip install dt-extensions-sdk
+### Requirements:
+
+* Python 3.10+
+
+### Install the SDK
+
+```bash
+pip install dt-extensions-sdk[cli]
+# Note, on some shells like zsh you may need to escape the brackets - pip install dt-extensions-sdk\[cli\]
 ```
 
-## License
+### Create signing certificates
+
+```bash
+dt-sdk gencerts
+```
 
-`dt-extensions-sdk` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+### Create a new extension
+
+```bash
+dt-sdk create my_first_extension
+```
+
+### Simulate
+
+```bash
+cd my_first_extension
+dt-sdk run
+```
+
+### Build
+    
+```bash
+dt-sdk build
+```
+
+
+### Upload
+    
+```bash
+# Note, you need to either set environment variables DT_API_URL and DT_API_TOKEN or pass them as arguments
+dt-sdk upload
+```
 
 ## Developing
 
@@ -64,4 +100,14 @@ hatch run lint:all
 
 ```console
 hatch build
-```
+```
+
+### Building docs
+
+```console
+hatch run docs:build
+```
+
+## License
+
+`dt-extensions-sdk` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

{dt_extensions_sdk-1.1.0.dist-info → dt_extensions_sdk-1.1.1.dist-info}/RECORD

@@ -1,4 +1,5 @@
-dynatrace_extension/__about__.py,sha256=88jJscpSyDohq8X8smaiFVx4eiwxXIttJZPQSeA_-tA,112
+docs/conf.py,sha256=YNcAnuTe9rU_2ktEHdDLBgr013WMGuDR7kzcxEuVJNY,3582
+dynatrace_extension/__about__.py,sha256=PmqLyPzjaUchXdOD4KgX_mnu19HbF9u6_1dod8bXTCA,112
 dynatrace_extension/__init__.py,sha256=XYHyWducrLWengm6jcCZMYAHzaQwQfoJKzKT4QvhTxE,779
 dynatrace_extension/cli/__init__.py,sha256=eg2YQkeboIfJ_hcUGp1WFEvT-moa2qGGN-L9RjTbxCM,128
 dynatrace_extension/cli/main.py,sha256=MbTCwhI3i7l1IcPHMgpbA4DqOZ5kVCtIkouoz5eWYOE,16254
@@ -17,16 +18,16 @@ dynatrace_extension/sdk/__init__.py,sha256=sh7MNjmyR0vt-ugkqEHXVqwTNLExfexS0CTK-
 dynatrace_extension/sdk/activation.py,sha256=s1ZToshWNptfmgu5NsZCI_WMsNM3-O8CSzzoauo62Uk,1523
 dynatrace_extension/sdk/callback.py,sha256=ozMUWjWHRMX9baU2HGhaCEw6ZVjN_z6kRM9OaX85Hvw,6306
 dynatrace_extension/sdk/communication.py,sha256=xzXXW--0dgvYxmECvZEQ6xI4H1iLCmqbh5p22NSdR40,16486
-dynatrace_extension/sdk/event.py,sha256=AmMDlbNJTu8EWfcgY1RAwk1pmu7y6-8l33igSjWEdiQ,391
-dynatrace_extension/sdk/extension.py,sha256=V8vdH_Jv5duOF3NuiDp9hHkCqh80XNvYzvfieFR9S74,38690
+dynatrace_extension/sdk/event.py,sha256=oyvcm8uTle-A1jKgXIsFwAvl-Ta2RKbFHVZv3sxTPmo,407
+dynatrace_extension/sdk/extension.py,sha256=jCG3V6xh2hu1zcQKHYw87ogpeDAuLcvFSpiBDcDg1LQ,40759
 dynatrace_extension/sdk/helper.py,sha256=TyL6aSIN6lhoH2yHZw8NbhtixdvlyV5q6fDh5NPODdc,6753
-dynatrace_extension/sdk/metric.py,sha256=9eFap_Zcxlrhn3_xvp8JumRwOpmVcZ4XM1paybqD0NE,3907
+dynatrace_extension/sdk/metric.py,sha256=QwrfrmFdj-IddZxAZlZrch62TWKDtzrDU88FwBIv30E,3808
 dynatrace_extension/sdk/runtime.py,sha256=JgP_qVomatVw85ZuAjbR0S-rzrK5U9JwSZXwfQDKNA4,2869
 dynatrace_extension/sdk/vendor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dynatrace_extension/sdk/vendor/mureq/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dynatrace_extension/sdk/vendor/mureq/mureq.py,sha256=gKzGiPmZ2g74Nb8K_6bu0f2coWZHZiZ2aXGzG2Pimlg,15102
-dt_extensions_sdk-1.1.0.dist-info/METADATA,sha256=u-0zPB4CE2QZpQhBJpD-EFm_ODXdSqRuewVyPJEbFZA,1823
-dt_extensions_sdk-1.1.0.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
-dt_extensions_sdk-1.1.0.dist-info/entry_points.txt,sha256=pweyOCgENGHjOlT6_kXYaBPOrE3p18K0UettqnNlnoE,55
-dt_extensions_sdk-1.1.0.dist-info/licenses/LICENSE.txt,sha256=k7kok_OTpJ5sfb5ANni8wu-Q1lXw8OQjNZXdrTGhFKc,1087
-dt_extensions_sdk-1.1.0.dist-info/RECORD,,
+dt_extensions_sdk-1.1.1.dist-info/METADATA,sha256=X5NaUoYxxzx53TEmj63jjTFTACajkV_JkTpe9esnbDs,2469
+dt_extensions_sdk-1.1.1.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
+dt_extensions_sdk-1.1.1.dist-info/entry_points.txt,sha256=pweyOCgENGHjOlT6_kXYaBPOrE3p18K0UettqnNlnoE,55
+dt_extensions_sdk-1.1.1.dist-info/licenses/LICENSE.txt,sha256=k7kok_OTpJ5sfb5ANni8wu-Q1lXw8OQjNZXdrTGhFKc,1087
+dt_extensions_sdk-1.1.1.dist-info/RECORD,,

dynatrace_extension/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2023-present Dynatrace LLC
 #
 # SPDX-License-Identifier: MIT
-__version__ = "1.1.0"
+__version__ = "1.1.1"

dynatrace_extension/sdk/event.py

@@ -6,9 +6,7 @@ from enum import Enum
 
 
 class Severity(Enum):
-    """
-    Severity of an event.
-    """
+    """Severity of an event ingested through log ingest."""
 
     EMERGENCY = "EMERGENCY"
     ERROR = "ERROR"

dynatrace_extension/sdk/extension.py

@@ -71,6 +71,14 @@ class AggregationMode(Enum):
 
 
 class DtEventType(str, Enum):
+    """Event type.
+
+    Note:
+        Official API v2 documentation:
+
+        https://docs.dynatrace.com/docs/dynatrace-api/environment-api/events-v2/post-event
+    """
+
     CUSTOM_INFO = "CUSTOM_INFO"
     CUSTOM_ALERT = "CUSTOM_ALERT"
     CUSTOM_ANNOTATION = "CUSTOM_ANNOTATION"
@@ -89,40 +97,39 @@ class CountMetricRegistrationEntry(NamedTuple):
 
     @staticmethod
     def make_list(metric_key: str, dimensions_list: List[str]):
-        """
-        Get count metric entry for registration that for aggregation uses defined list of dimensions
-
-        :param metric_key: metric key in string
-        :param dimensions_list: list of dimensions ids in string
+        """Build an entry that uses defined list of dimensions for aggregation.
 
+        Args:
+            metric_key: Metric key in string.
+            dimensions_list: List of dimensions.
         """
         return CountMetricRegistrationEntry(metric_key, AggregationMode.LIST, dimensions_list)
 
     @staticmethod
     def make_all(metric_key: str):
-        """
-        Get count metric entry for registration that for aggregation uses all mint dimensions
-
-        :param metric_key: metric key in string
+        """Build an entry that uses all mint dimensions for aggregation.
 
+        Args:
+            metric_key: Metric key in string.
         """
         return CountMetricRegistrationEntry(metric_key, AggregationMode.ALL, [])
 
     @staticmethod
     def make_none(metric_key: str):
-        """
-        Get count metric entry for registration that for aggregation uses none of mint dimensions
-
-        :param metric_key: metric key in string
+        """Build an entry that uses none of mint dimensions for aggregation.
 
+        Args:
+            metric_key: Metric key in string.
         """
         return CountMetricRegistrationEntry(metric_key, AggregationMode.NONE, [])
 
     def registration_items_dict(self):
+        result = {"aggregation_mode": self.aggregation_mode.value}
         if self.aggregation_mode == AggregationMode.LIST:
-            return {"aggregation_mode": self.aggregation_mode.value, "dimensions_list": self.dimensions_list}
+            result["dimensions_list"] = self.dimensions_list
+            return result
         else:
-            return {"aggregation_mode": self.aggregation_mode.value}
+            return result
 
 
 def _add_sfm_metric(metric: Metric, sfm_metrics: Optional[List[Metric]] = None):
@@ -133,6 +140,12 @@ def _add_sfm_metric(metric: Metric, sfm_metrics: Optional[List[Metric]] = None):
 
 
 class Extension:
+    """Base class for Python extensions.
+
+    Attributes:
+        logger: Embedded logger object for the extension.
+    """
+
     _instance: ClassVar = None
     schedule_decorators: ClassVar = []
 
@@ -227,20 +240,33 @@ class Extension:
 
     @property
     def is_helper(self) -> bool:
+        """Internal property used by the EEC."""
+
         return False
 
     @property
     def task_id(self) -> str:
+        """Internal property used by the EEC."""
+
         return self._task_id
 
     @property
     def monitoring_config_id(self) -> str:
+        """Internal property used by the EEC.
+
+        Represents a unique identifier of the monitoring configuration.
+        that is assigned to this particular extension instance.
+        """
+
         return self._monitoring_config_id
 
     def run(self):
-        """
-        Extension main loop.
+        """Launch the extension instance.
+
+        Calling this method starts the main loop of the extension.
+
         This method must be invoked once to start the extension,
+
         if `--fastcheck` is set, the extension will run in fastcheck mode,
         otherwise the main loop is started, which periodically runs:
 
@@ -248,6 +274,7 @@ class Extension:
         * The heartbeat method
         * The metrics publisher method
         """
+
         self._setup_signal_handlers()
         if self._is_fastcheck:
             return self._run_fastcheck()
@@ -266,7 +293,8 @@ class Extension:
         sys.exit(0)
 
     def on_shutdown(self):
-        """
+        """Callback method to be invoked when the extension is shutting down.
+
         Called when extension exits after it has received shutdown signal from EEC
         This is executed before metrics are flushed to EEC
         """
@@ -295,15 +323,18 @@ class Extension:
         args: Optional[tuple] = None,
         activation_type: Optional[ActivationType] = None,
     ) -> None:
-        """
-        Schedules a method to be executed periodically,
-        the callback method will be periodically invoked in a separate thread.
+        """Schedule a method to be executed periodically.
+
+        The callback method will be periodically invoked in a separate thread.
         The callback method is always immediately scheduled for execution.
 
-        :param callback: The callback method to be invoked
-        :param interval: The time interval between invocations, can be a timedelta object, or an int representing the number of seconds
-        :param args: Arguments to the callback, if any
-        :param activation_type: Optional activation type when this callback should run, can be 'ActivationType.LOCAL' or 'ActivationType.REMOTE'
+        Args:
+            callback: The callback method to be invoked
+            interval: The time interval between invocations, can be a timedelta object,
+                or an int representing the number of seconds
+            args: Arguments to the callback, if any
+            activation_type: Optional activation type when this callback should run,
+                can be 'ActivationType.LOCAL' or 'ActivationType.REMOTE'
         """
 
         if isinstance(interval, int):
@@ -316,14 +347,16 @@ class Extension:
             self._schedule_callback(callback)
 
     def query(self):
-        """
+        """Callback to be executed every minute by default.
+
         Optional method that can be implemented by subclasses.
         The query method is always scheduled to run every minute.
         """
         pass
 
     def initialize(self):
-        """
+        """Callback to be executed when the extension starts.
+
         Called once after the extension starts and the processes arguments are parsed.
         Sometimes there are tasks the user needs to do that must happen before runtime,
         but after the activation config has been received, example: Setting the schedule frequency
@@ -332,23 +365,27 @@ class Extension:
         pass
 
     def fastcheck(self) -> Status:
-        """
-        Called if the extension is run in the `fastcheck` mode
+        """Callback executed when extension is launched.
 
-        This method is not called if fastcheck callback was already registered with Extension.register_fastcheck()
+        Called if the extension is run in the `fastcheck` mode. Only invoked for remote
+        extensions.
+        This method is not called if fastcheck callback was already registered with
+        Extension.register_fastcheck().
 
-        :return: status with optional message whether the fastcheck succeed or failed
+        Returns:
+            Status with optional message whether the fastcheck succeed or failed.
         """
         return Status(StatusValue.OK)
 
     def register_fastcheck(self, fast_check_callback: Callable[[ActivationConfig, str], Status]):
-        """
-        Registers fastcheck callback that is executed in the `fastcheck` mode
+        """Registers fastcheck callback that is executed in the `fastcheck` mode.
 
         Extension.fastcheck() is not called if fastcheck callback is registered with this method
 
-        :param fast_check_callback: callable called with activation_config: ActivationConfig and extension_config: str arguments
-        must return the Status with optional message whether the fastcheck succeed or failed
+        Args:
+            fast_check_callback: callable called with ActivationConfig and
+            extension_config arguments. Must return the Status with optional message
+            whether the fastcheck succeed or failed.
         """
         if self._fast_check_callback:
             api_logger.error("More than one function assigned to fastcheck, last registered one was kept.")
@@ -356,10 +393,10 @@ class Extension:
         self._fast_check_callback = fast_check_callback
 
     def _register_count_metrics(self, *count_metric_entries: CountMetricRegistrationEntry) -> None:
-        """
-        Sends request to EEC for count metric registration
+        """Send a count metric registration request to EEC.
 
-        :param count_metric_entries: CountMetricRegistrationEntry objects for each count metric to register
+        Args:
+            count_metric_entries: CountMetricRegistrationEntry objects for each count metric to register
         """
         json_pattern = {
             metric_entry.metric_key: metric_entry.registration_items_dict() for metric_entry in count_metric_entries
@@ -367,13 +404,13 @@ class Extension:
         self._client.register_count_metrics(json_pattern)
 
     def _send_count_delta_signal(self, metric_keys: set[str], force: bool = True) -> None:
-        """
-        Sends calculate-delta signal to EEC monotonic converter.
+        """Send calculate-delta signal to EEC monotonic converter.
 
-        :param metric_keys: List with metrics for which we want to calculate deltas
-        :param force: If true, it forces the metrics from cache to be pushed into EEC and then delta signal request is
-        sent. Otherwise, it puts delta signal request in cache and request is sent after nearest (in time) sending
-        metrics to EEC event
+        Args:
+            metric_keys: List with metrics for which we want to calculate deltas
+            force: If true, it forces the metrics from cache to be pushed into EEC and then delta signal request is
+                sent. Otherwise, it puts delta signal request in cache and request is sent after nearest (in time) sending
+                metrics to EEC event
         """
 
         with self._metrics_lock:
@@ -397,16 +434,20 @@ class Extension:
         timestamp: Optional[datetime] = None,
         metric_type: MetricType = MetricType.GAUGE,
     ) -> None:
-        """Reports a metric using the MINT protocol
-        By default, it reports a gauge metric
+        """Report a metric.
+
+        Metric is sent to EEC using an HTTP request and MINT protocol. EEC then
+        sends the metrics to the tenant.
 
+        By default, it reports a gauge metric.
 
-        :param key: The metric key, must follow the MINT specification
-        :param value: The metric value, can be a simple value or a SummaryStat
-        :param dimensions: A dictionary of dimensions
-        :param techrule: The technology rule string set by self.techrule setter.
-        :param timestamp: The timestamp of the metric, defaults to the current time
-        :param metric_type: The type of the metric, defaults to MetricType.GAUGE
+        Args:
+            key: The metric key, must follow the MINT specification
+            value: The metric value, can be a simple value or a SummaryStat
+            dimensions: A dictionary of dimensions
+            techrule: The technology rule string set by self.techrule setter.
+            timestamp: The timestamp of the metric, defaults to the current time
+            metric_type: The type of the metric, defaults to MetricType.GAUGE
         """
 
         if techrule:
@@ -419,9 +460,15 @@ class Extension:
         self._add_metric(metric)
 
     def report_mint_lines(self, lines: List[str]) -> None:
-        """Reports mint lines using the MINT protocol
+        """Report mint lines using the MINT protocol
 
-        :param lines: A list of mint lines, example: ["my_metric 1", "my_other_metric 2"]
+        Examples:
+            Metric lines must comply with the MINT format.
+
+            >>> self.report_mint_lines(["my_metric 1", "my_other_metric 2"])
+
+        Args:
+            lines: A list of mint lines
         """
         self._add_mint_lines(lines)
 
@@ -433,13 +480,14 @@ class Extension:
         timestamp: Optional[datetime] = None,
         severity: Union[Severity, str] = Severity.INFO,
     ) -> None:
-        """Reports an event using log ingest
-
-        :param title: The title of the event
-        :param description: The description of the event
-        :param properties: A dictionary of extra event properties
-        :param timestamp: The timestamp of the event, defaults to the current time
-        :param severity: The severity of the event, defaults to Severity.INFO
+        """Report an event using log ingest.
+
+        Args:
+            title: The title of the event
+            description: The description of the event
+            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
         """
         if timestamp is None:
             timestamp = datetime.now(tz=timezone.utc)
@@ -469,17 +517,22 @@ class Extension:
         properties: Optional[dict[str, str]] = None,
     ) -> None:
         """
-        Reports an event v2 using event ingest
-
-        For reference see: https://www.dynatrace.com/support/help/dynatrace-api/environment-api/events-v2/post-event
-
-        :param event_type: The event type chosen from type Enum (required)
-        :param title: The title of the event (required)
-        :param start_time: The start time of event in UTC ms, if not set, current timestamp (optional)
-        :param end_time: The end time of event in UTC ms, if not set, current timestamp + timeout (optional)
-        :param timeout: The timeout of event in minutes, if not set, 15 (optional)
-        :param entity_selector: The entity selector, if not set, the event is associated with environment entity (optional)
-        :param properties: A map of event properties (optional)
+        Reports an event using the v2 event ingest API.
+
+        Unlike ``report_event``, this directly raises an event or even a problem
+        based on the specified ``event_type``.
+
+        Note:
+            For reference see: https://www.dynatrace.com/support/help/dynatrace-api/environment-api/events-v2/post-event
+
+        Args:
+            event_type: The event type chosen from type Enum (required)
+            title: The title of the event (required)
+            start_time: The start time of event in UTC ms, if not set, current timestamp (optional)
+            end_time: The end time of event in UTC ms, if not set, current timestamp + timeout (optional)
+            timeout: The timeout of event in minutes, if not set, 15 (optional)
+            entity_selector: The entity selector, if not set, the event is associated with environment entity (optional)
+            properties: A map of event properties (optional)
         """
         event: Dict[str, Any] = {"eventType": event_type, "title": title}
         if start_time:
@@ -496,46 +549,50 @@ class Extension:
         self._send_dt_event(event)
 
     def report_dt_event_dict(self, event: dict):
-        """
-        Reports an event v2 using event ingest using provided dictionary resembling required json
-        For reference see: https://www.dynatrace.com/support/help/dynatrace-api/environment-api/events-v2/post-event
-        (see schema)
-        {
-            "type": "object",
-            "required": ["eventType", "title"],
-            "properties": {
-                "eventType": {
-                    "type": "string",
-                    "enum": [
-                        "CUSTOM_INFO",
-                        "CUSTOM_ANNOTATION",
-                        "CUSTOM_CONFIGURATION",
-                        "CUSTOM_DEPLOYMENT",
-                        "MARKED_FOR_TERMINATION",
-                        "ERROR_EVENT",
-                        "AVAILABILITY_EVENT",
-                        "PERFORMANCE_EVENT",
-                        "RESOURCE_CONTENTION_EVENT",
-                        "CUSTOM_ALERT"
-                    ]
-                },
-                "title": {
-                    "type": "string",
-                    "minLength": 1
-                },
-                "startTime": {"type": "integer"},
-                "endTime": {"type": "integer"},
-                "timeout": {"type": "integer"},
-                "entitySelector": {"type": "string"},
+        """Report an event using event ingest API with provided dictionary.
+
+        Note:
+            For reference see: https://www.dynatrace.com/support/help/dynatrace-api/environment-api/events-v2/post-event
+
+        Format of the event dictionary::
+
+            {
+                "type": "object",
+                "required": ["eventType", "title"],
                 "properties": {
-                    "type": "object",
-                    "patternProperties": {
-                        "^.*$": {"type": "string"}
+                    "eventType": {
+                        "type": "string",
+                        "enum": [
+                            "CUSTOM_INFO",
+                            "CUSTOM_ANNOTATION",
+                            "CUSTOM_CONFIGURATION",
+                            "CUSTOM_DEPLOYMENT",
+                            "MARKED_FOR_TERMINATION",
+                            "ERROR_EVENT",
+                            "AVAILABILITY_EVENT",
+                            "PERFORMANCE_EVENT",
+                            "RESOURCE_CONTENTION_EVENT",
+                            "CUSTOM_ALERT"
+                        ]
+                    },
+                    "title": {
+                        "type": "string",
+                        "minLength": 1
+                    },
+                    "startTime": {"type": "integer"},
+                    "endTime": {"type": "integer"},
+                    "timeout": {"type": "integer"},
+                    "entitySelector": {"type": "string"},
+                    "properties": {
+                        "type": "object",
+                        "patternProperties": {
+                            "^.*$": {"type": "string"}
+                        }
                     }
                 }
             }
-        }
         """
+
         if "eventType" not in event or "title" not in event:
             raise ValueError('"eventType" not present' if "eventType" not in event else '"title" not present in event')
         for key, value in event.items():
@@ -553,31 +610,40 @@ class Extension:
         self._send_dt_event(event)
 
     def report_log_event(self, log_event: dict):
-        """Reports a custom log event using log ingest
+        """Report a custom log event using log ingest.
 
-        :param log_event: The log event dictionary, reference: https://www.dynatrace.com/support/help/shortlink/log-monitoring-log-data-ingestion
+        Note:
+            See reference: https://www.dynatrace.com/support/help/shortlink/log-monitoring-log-data-ingestion
+
+        Args:
+            log_event: The log event dictionary.
         """
         self._send_events(log_event)
 
     def report_log_events(self, log_events: List[dict]):
-        """Reports a list of custom log events using log ingest
+        """Report a list of custom log events using log ingest.
 
-        :param log_events: The list of log events
+        Args:
+            log_events: The list of log events
         """
         self._send_events(log_events)
 
     def report_log_lines(self, log_lines: List[Union[str, bytes]]):
-        """Reports a list of log lines using log ingest
+        """Report a list of log lines using log ingest
 
-        :param log_lines: The list of log lines
+        Args:
+            log_lines: The list of log lines
         """
         events = [{"content": line} for line in log_lines]
         self._send_events(events)
 
     @property
     def enabled_feature_sets(self) -> dict[str, list[str]]:
-        """
-        Dictionary containing enabled feature sets with corresponding metrics defined in `extension.yaml`
+        """Map of enabled feautre sets and corresponding metrics.
+
+        Returns:
+            Dictionary containing enabled feature sets with corresponding
+            metrics defined in ``extension.yaml``.
         """
         return {
             feature_set_name: metric_keys
@@ -587,15 +653,19 @@ class Extension:
 
     @property
     def enabled_feature_sets_names(self) -> list[str]:
-        """
-        List containing names of enabled feature sets
+        """Names of enabled feature sets.
+
+        Returns:
+            List containing names of enabled feature sets.
         """
         return self.activation_config.feature_sets
 
     @property
     def enabled_feature_sets_metrics(self) -> list[str]:
-        """
-        List of all metric keys from enabled feature sets
+        """Enabled metrics.
+
+        Returns:
+            List of all metric keys from enabled feature sets
         """
         return list(chain(*self.enabled_feature_sets.values()))
 
@@ -651,10 +721,11 @@ class Extension:
                 if not self.is_helper:
                     self.schedule(self.query, timedelta(minutes=1))
             except Exception as e:
-                api_logger.exception(f"Error running initialize {self}: {e!r}")
-                status_message = "Python datasource initialization error: " + repr(e)
-                self._client.send_status(Status(StatusValue.GENERIC_ERROR, status_message))
-                self._initialization_error = status_message
+                msg = f"Error running self.initialize {self}: {e!r}"
+                api_logger.exception(msg)
+                self._client.send_status(Status(StatusValue.GENERIC_ERROR, msg))
+                self._initialization_error = msg
+                raise e
 
     @property
     def _metadata(self) -> dict:
@@ -750,9 +821,11 @@ class Extension:
                 self._metrics = []
 
     def _prepare_sfm_metrics(self) -> List[str]:
+        """Prepare self monitoring metrics.
+
+        Builds the list of mint metric lines to send as self monitoring metrics.
         """
-        Build the list of mint metric lines to send as self monitoring metrics
-        """
+
         sfm_metrics: List[Metric] = []
         sfm_dimensions = {"dt.extension.config.id": self.monitoring_config_id}
         _add_sfm_metric(
@@ -926,16 +999,28 @@ class Extension:
     def _send_dt_event(self, event: dict[str, str | int | dict[str, str]]):
         self._client.send_dt_event(event)
 
-    def get_version(self):
+    def get_version(self) -> str:
+        """Return the version of extensions sdk library."""
+
         return __version__
 
     @property
     def techrule(self) -> str:
+        """Internal property used by the EEC."""
+
         return self._techrule
 
     @techrule.setter
     def techrule(self, value):
         self._techrule = value
 
-    def get_activation_config(self):
+    def get_activation_config(self) -> ActivationConfig:
+        """Retrieve the activation config.
+
+        Represents activation configuration assigned to this particular
+        extension instance.
+
+        Returns:
+            ActivationConfig object.
+        """
         return self.activation_config

dynatrace_extension/sdk/metric.py

@@ -61,8 +61,6 @@ class Metric:
         return self._key_and_dimensions() == other._key_and_dimensions()
 
     def to_mint_line(self) -> str:
-        # https://bitbucket.lab.dynatrace.org/projects/ONE/repos/schemaless-metrics-spec/browse
-
         # Add key and dimensions
         line = f"{self._key_and_dimensions()}"