Merge branch 'dev' into proj/maintenance-policy

Author: ezilber-akamai

linode_api4/__init__.py

@@ -1,7 +1,7 @@
 # isort: skip_file
 from linode_api4.objects import *
 from linode_api4.errors import ApiError, UnexpectedResponseError
-from linode_api4.linode_client import LinodeClient
+from linode_api4.linode_client import LinodeClient, MonitorClient
 from linode_api4.login_client import LinodeLoginClient, OAuthScopes
 from linode_api4.paginated_list import PaginatedList
 from linode_api4.polling import EventPoller

linode_api4/groups/__init__.py

@@ -12,6 +12,7 @@
 from .longview import *
 from .maintenance import *
 from .monitor import *
+from .monitor_api import *
 from .networking import *
 from .nodebalancer import *
 from .object_storage import *

linode_api4/groups/group.py

@@ -3,9 +3,9 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from linode_api4 import LinodeClient
+    from linode_api4.linode_client import BaseClient
 
 
 class Group:
-    def __init__(self, client: LinodeClient):
+    def __init__(self, client: BaseClient):
         self.client = client

linode_api4/groups/monitor_api.py

@@ -0,0 +1,59 @@
+__all__ = [
+    "MetricsGroup",
+]
+
+from typing import Any, Dict, List, Optional, Union
+
+from linode_api4 import drop_null_keys
+from linode_api4.groups import Group
+from linode_api4.objects.base import _flatten_request_body_recursive
+from linode_api4.objects.monitor_api import EntityMetricOptions, EntityMetrics
+
+
+class MetricsGroup(Group):
+    """
+    Encapsulates Monitor-related methods of the :any:`MonitorClient`.
+
+    This group contains all features related to metrics in the API monitor-api.
+    """
+
+    def fetch_metrics(
+        self,
+        service_type: str,
+        entity_ids: list,
+        metrics: List[Union[EntityMetricOptions, Dict[str, Any]]],
+        **kwargs,
+    ) -> Optional[EntityMetrics]:
+        """
+        Returns metrics information for the individual entities within a specific service type.
+
+        API documentation: https://techdocs.akamai.com/linode-api/reference/post-read-metric
+
+        :param service_type: The service being monitored.
+                            Currently, only the Managed Databases (dbaas) service type is supported.
+        :type service_type: str
+
+        :param entity_ids: The id for each individual entity from a service_type.
+        :type entity_ids: list
+
+        :param metrics: A list of metric objects, each specifying a metric name and its corresponding aggregation function.
+        :type metrics: list of EntityMetricOptions or Dict[str, Any]
+
+        :param kwargs: Any other arguments accepted by the api. Please refer to the API documentation for full info.
+
+        :returns: Service metrics requested.
+        :rtype: EntityMetrics or None
+        """
+        params = {
+            "entity_ids": entity_ids,
+            "metrics": metrics,
+        }
+
+        params.update(kwargs)
+
+        result = self.client.post(
+            f"/monitor/services/{service_type}/metrics",
+            data=drop_null_keys(_flatten_request_body_recursive(params)),
+        )
+
+        return EntityMetrics.from_json(result)