adding SDK changes for ACLP APIs

linode_api4/groups/__init__.py

@@ -10,6 +10,7 @@
 from .lke import *
 from .lke_tier import *
 from .longview import *
+from .monitor import *
 from .networking import *
 from .nodebalancer import *
 from .object_storage import *

linode_api4/groups/monitor.py

@@ -0,0 +1,149 @@
+from linode_api4.errors import UnexpectedResponseError
+from linode_api4.groups import Group
+from linode_api4.objects import (
+    CreateToken,
+    Dashboard,
+    DashboardByService,
+    MetricDefinition,
+    MonitorServiceSupported,
+    ServiceDetails,
+)
+
+
+class MonitorGroup(Group):
+    """
+    Encapsulates Monitor-related methods of the :any:`LinodeClient`.  This
+    should not be instantiated on its own, but should instead be used through
+    an instance of :any:`LinodeClient`::
+
+       client = LinodeClient(token)
+       instances = client.monitor.dashboards() # use the LKEGroup
+
+    This group contains all features beneath the `/monitor` group in the API v4.
+    """
+
+    def dashboards(self, *filters):
+        """
+        Returns a list of dashboards on your account.
+
+        .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-dashboards-all
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: A list of Dashboards.
+        :rtype: PaginatedList of Dashboard
+        """
+        return self.client._get_and_filter(Dashboard, *filters)
+
+    def dashboards_by_service(self, service_type: str, *filters):
+        """
+        Returns a dashboards on your account based on the service passed.
+
+        .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-dashboards
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: A Dashboards filtered by Service Type.
+        :rtype: PaginatedList of the Dashboards
+        """
+
+        return self.client._get_and_filter(
+            DashboardByService,
+            *filters,
+            endpoint=f"/monitor/services/{service_type}/dashboards",
+        )
+
+    def supported_services(self, *filters):
+        """
+        Returns a list of services supported by ACLP.
+
+        .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: A list of Supported Services
+        :rtype: PaginatedList of the Dashboards
+        """
+
+        return self.client._get_and_filter(MonitorServiceSupported, *filters)
+
+    def details_by_service(self, service_type: str, *filters):
+        """
+        Returns a details about a particular service.
+
+        .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services-for-service-type
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: Details about a  Supported Services
+        :rtype: PaginatedList of the Service
+        """
+        return self.client._get_and_filter(
+            ServiceDetails,
+            *filters,
+            endpoint=f"/monitor/services/{service_type}",
+        )
+
+    def metric_definitions(self, service_type: str, *filters):
+        """
+        Returns metrics for a specific service type.
+
+        .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-information
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: Returns a  List of metrics for a service
+        :rtype: PaginatedList of metrics
+        """
+        return self.client._get_and_filter(
+            MetricDefinition,
+            *filters,
+            endpoint=f"/monitor/services/{service_type}/metric-definitions",
+        )
+
+    def create_token(self, service_type: str, entity_ids: list, *filters):
+        """
+        Returns a JWE Token for a specific service type.
+
+        .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/post-get-token
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: Returns a token for a service
+        :rtype: str
+        """
+
+        params = {"entity_ids": entity_ids}
+
+        result = self.client.post(
+            f"/monitor/services/{service_type}/token", data=params
+        )
+
+        if "token" not in result:
+            raise UnexpectedResponseError(
+                "Unexpected response when creating token!", json=result
+            )
+        return CreateToken(self.client, result["token"], result)

linode_api4/linode_client.py

@@ -19,6 +19,7 @@
     LinodeGroup,
     LKEGroup,
     LongviewGroup,
+    MonitorGroup,
     NetworkingGroup,
     NodeBalancerGroup,
     ObjectStorageGroup,
@@ -201,6 +202,8 @@ def __init__(
         #: Access methods related to VM placement - See :any:`PlacementAPIGroup` for more information.
         self.placement = PlacementAPIGroup(self)
 
+        self.monitor = MonitorGroup(self)
+
     @property
     def _user_agent(self):
         return "{}python-linode_api4/{} {}".format(

linode_api4/objects/__init__.py

@@ -21,3 +21,4 @@
 from .vpc import *
 from .beta import *
 from .placement import *
+from .monitor import *

linode_api4/objects/monitor.py

@@ -0,0 +1,82 @@
+from linode_api4.objects import Base, Property
+
+
+class Dashboard(Base):
+    """
+    List dashboards: https://techdocs.akamai.com/linode-api/get-dashboards-all
+    """
+
+    api_endpoint = "/monitor/dashboards/{id}"
+    properties = {
+        "id": Property(identifier=True),
+        "created": Property(is_datetime=True),
+        "label": Property(),
+        "service_type": Property(),
+        "type": Property(),
+        "widgets": Property(mutable=True),
+        "updated": Property(is_datetime=True),
+    }
+
+
+class DashboardByService(Base):
+    """
+    Get a dashboard: https://techdocs.akamai.com/linode-api/reference/get-dashboards
+    """
+
+    properties = {
+        "id": Property(identifier=True),
+        "created": Property(is_datetime=True),
+        "label": Property(),
+        "service_type": Property(),
+        "type": Property(),
+        "widgets": Property(mutable=True),
+        "updated": Property(is_datetime=True),
+    }
+
+
+class MonitorServiceSupported(Base):
+
+    api_endpoint = "/monitor/services/"
+    id_attribute = "service_type"
+    properties = {
+        "service_type": Property(),
+        "label": Property(mutable=True),
+    }
+
+
+class ServiceDetails(Base):
+    """
+    API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services-for-service-type
+    """
+
+    id_attribute = "service_type"
+    properties = {
+        "label": Property(),
+        "service_type": Property(),
+    }
+
+
+class MetricDefinition(Base):
+    """
+    API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-information
+    """
+
+    id_attribute = "metric"
+    properties = {
+        "available_aggregate_functions": Property(),
+        "dimensions": Property(mutable=True),
+        "label": Property(),
+        "is_alertable": Property(),
+        "metric": Property(),
+        "metric_type": Property(),
+        "scrape_interval": Property(),
+        "unit": Property(),
+    }
+
+
+class CreateToken(Base):
+    """
+    API Documentation: https://techdocs.akamai.com/linode-api/reference/post-get-token
+    """
+
+    properties = {"token": Property(mutable=True)}

test/fixtures/monitor_dashboards.json

@@ -0,0 +1,37 @@
+{
+    "data": [
+      {
+        "created": "2024-10-10T05:01:58",
+        "id": 1,
+        "label": "Resource Usage",
+        "service_type": "dbaas",
+        "type": "standard",
+        "updated": "2024-10-10T05:01:58",
+        "widgets": [
+          {
+            "aggregate_function": "sum",
+            "chart_type": "area",
+            "color": "default",
+            "label": "CPU Usage",
+            "metric": "cpu_usage",
+            "size": 12,
+            "unit": "%",
+            "y_label": "cpu_usage"
+          },
+          {
+            "aggregate_function": "sum",
+            "chart_type": "area",
+            "color": "default",
+            "label": "Disk I/O Write",
+            "metric": "write_iops",
+            "size": 6,
+            "unit": "IOPS",
+            "y_label": "write_iops"
+          }
+        ]
+      }
+    ],
+    "page": 1,
+    "pages": 1,
+    "results": 1
+  }

test/fixtures/monitor_dashboards_1.json

@@ -0,0 +1,30 @@
+{
+    "created": "2024-10-10T05:01:58",
+    "id": 1,
+    "label": "Resource Usage",
+    "service_type": "dbaas",
+    "type": "standard",
+    "updated": "2024-10-10T05:01:58",
+    "widgets": [
+      {
+        "aggregate_function": "sum",
+        "chart_type": "area",
+        "color": "default",
+        "label": "CPU Usage",
+        "metric": "cpu_usage",
+        "size": 12,
+        "unit": "%",
+        "y_label": "cpu_usage"
+      },
+      {
+        "aggregate_function": "sum",
+        "chart_type": "area",
+        "color": "default",
+        "label": "Available Memory",
+        "metric": "available_memory",
+        "size": 6,
+        "unit": "GB",
+        "y_label": "available_memory"
+      }
+    ]
+  }

test/fixtures/monitor_services.json

@@ -0,0 +1,11 @@
+{
+    "data": [
+      {
+        "label": "Databases",
+        "service_type": "dbaas"
+      }
+    ],
+    "page": 1,
+    "pages": 1,
+    "results": 1
+  }

test/fixtures/monitor_services_dbaas.json

@@ -0,0 +1,11 @@
+{
+    "data": [
+      {
+        "label": "Databases",
+        "service_type": "dbaas"
+      }
+    ],
+    "page": 1,
+    "pages": 1,
+    "results": 1
+  }

test/fixtures/monitor_services_dbaas_dashboards.json

@@ -0,0 +1,37 @@
+{
+    "data": [
+      {
+        "created": "2024-10-10T05:01:58",
+        "id": 1,
+        "label": "Resource Usage",
+        "service_type": "dbaas",
+        "type": "standard",
+        "updated": "2024-10-10T05:01:58",
+        "widgets": [
+          {
+            "aggregate_function": "sum",
+            "chart_type": "area",
+            "color": "default",
+            "label": "CPU Usage",
+            "metric": "cpu_usage",
+            "size": 12,
+            "unit": "%",
+            "y_label": "cpu_usage"
+          },
+          {
+            "aggregate_function": "sum",
+            "chart_type": "area",
+            "color": "default",
+            "label": "Memory Usage",
+            "metric": "memory_usage",
+            "size": 6,
+            "unit": "%",
+            "y_label": "memory_usage"
+          }
+        ]
+      }
+    ],
+    "page": 1,
+    "pages": 1,
+    "results": 1
+  }