adding SDK changes for ACLP APIs #528

pmajali · 2025-04-11T06:20:23Z

📝 Description

The PR adds Monitor API for ACLP Product

✔️ How to Test

import os
import logging
from linode_api4 import LinodeClient

logger = logging.getLogger(__name__)

client = LinodeClient(os.environ.get("MY_PERSONAL_ACCESS_TOKEN"))
client.base_url = "https://api.linode.com/v4beta"


print("Listing services supported by ACLP")
services = client.monitor.supported_services()
for service in services:
        print("Label:", service.label)

How do I run the relevant unit/integration tests?

Run unit test as follows
pytest test/unit

Run integration test as follows
make testint TEST_SUITE=monitor

yec-akamai · 2025-04-16T19:40:05Z

@pmajali Thank you for starting contributing to python SDK! Do you mind filling the PR description and test steps?

linode_api4/groups/__init__.py

pmajali · 2025-04-23T14:16:53Z

linode_api4/objects/__init__.py

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


updated the group and object to include 'all'

test/integration/models/monitor/test_monitor.py

test/unit/objects/monitor_test.py

yec-akamai

Can you fix the PR given the suggestion from code scanning?

linode_api4/groups/monitor.py

linode_api4/objects/monitor.py

Co-authored-by: Lena Garber <[email protected]>

yec-akamai · 2025-05-08T18:54:48Z

linode_api4/groups/__init__.py

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


To address this issue, I'd suggest to change the namespace to a less general one, i.e., monitor_service.

yec-akamai · 2025-05-08T18:54:48Z

linode_api4/groups/__init__.py

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


To address this issue, I'd suggest to change the namespace to a less general one, i.e., monitor_service.

yec-akamai · 2025-05-08T19:00:06Z

linode_api4/objects/monitor.py

+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),
+    }


This object seems has the exact same properties as Dashboard. It's not necessary to create a separate class here

yec-akamai · 2025-05-08T19:00:31Z

linode_api4/groups/monitor.py

+        """
+
+        return self.client._get_and_filter(
+            DashboardByService,


The return type can be Dashboard

yec-akamai · 2025-05-08T19:02:10Z

linode_api4/groups/monitor.py

+    This group contains all features beneath the `/monitor` group in the API v4.
+    """
+
+    def dashboards(self, *filters):


Can you explicitly declare the return type please? Same for all functions in this PR

yec-akamai · 2025-05-08T19:02:43Z

linode_api4/objects/monitor.py

+from linode_api4.objects import Base, Property
+
+
+class Dashboard(Base):


Can you add a brief description to each class please?

yec-akamai · 2025-05-08T19:17:19Z

linode_api4/objects/monitor.py

+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(),
+    }


It seems there is not an endpoint for getting a single metric. In this case, I think we can build it as an json object instead of class. Also personally i think it'd be better to name this type as ServiceMetric

Suggested change

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 ServiceMetric(JSONObject):

# .. declare the attributes and their corresponding types

yec-akamai · 2025-05-08T19:19:18Z

linode_api4/objects/monitor.py

+class CreateToken(Base):
+    """
+    API Documentation: https://techdocs.akamai.com/linode-api/reference/post-get-token
+    """
+
+    properties = {"token": Property(mutable=True)}


This class is not necessary to have. You can build a MetricServiceToken as a JSONObject

yec-akamai · 2025-05-08T19:19:44Z

linode_api4/groups/monitor.py

+            endpoint=f"/monitor/services/{service_type}/metric-definitions",
+        )
+
+    def create_token(self, service_type: str, entity_ids: list, *filters):


filter is not needed since it's a post endpoint

yec-akamai · 2025-05-08T19:20:48Z

linode_api4/groups/monitor.py

+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+


Can you better describe the params needed?

yec-akamai · 2025-05-08T19:24:48Z

linode_api4/objects/monitor.py

There are many properties that are enums in the objects. Can you build them as StrEnum, like we did in the linodego https://github.com/linode/linodego/pull/722/files?

Plus, it might be good to align the naming with lindoego too

yec-akamai

You'll have to sign all of you commits (make sure each commit has the green Verified tag) before merging this PR. To save troubles in the end, I'd suggest to do it sooner than later. You can look for github official docs to add signatures to all your commits

adding monitor APIs

3eb7651

pmajali requested a review from a team as a code owner April 11, 2025 06:20

pmajali requested review from jriddle-linode and lgarber-akamai and removed request for a team April 11, 2025 06:20

lgarber-akamai added the new-feature for new features in the changelog. label Apr 11, 2025

updating doc

e18ccc9

github-advanced-security bot found potential problems Apr 16, 2025

View reviewed changes

updating tests

b181c81

yec-akamai self-requested a review April 18, 2025 15:27

yec-akamai reviewed Apr 18, 2025

View reviewed changes

linode_api4/groups/monitor.py Outdated Show resolved Hide resolved

updating lint errors

d51d300

lgarber-akamai reviewed Apr 21, 2025

View reviewed changes

linode_api4/groups/monitor.py Outdated Show resolved Hide resolved

lgarber-akamai reviewed Apr 21, 2025

View reviewed changes

linode_api4/objects/monitor.py Outdated Show resolved Hide resolved

pmajali and others added 5 commits April 23, 2025 19:44

Updating method name

9084a05

Co-authored-by: Lena Garber <[email protected]>

updating code with review comments

69de940

Merge branch 'dev' into monitor-api

15a49f5

Merge branch 'dev' into monitor-api

081275e

sorting imports

7b8348b

github-advanced-security bot found potential problems May 5, 2025

View reviewed changes

updating with make format changes

fe4a6bd

yec-akamai requested changes May 8, 2025

View reviewed changes

yec-akamai reviewed May 8, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding SDK changes for ACLP APIs #528

adding SDK changes for ACLP APIs #528

pmajali commented Apr 11, 2025 •

edited

Loading

yec-akamai commented Apr 16, 2025

Check notice

pmajali Apr 23, 2025

yec-akamai left a comment

Check notice

yec-akamai May 8, 2025

yec-akamai May 8, 2025

yec-akamai May 8, 2025

yec-akamai May 8, 2025

yec-akamai May 8, 2025

yec-akamai May 8, 2025

yec-akamai May 8, 2025

yec-akamai May 8, 2025

yec-akamai May 8, 2025

yec-akamai May 8, 2025

yec-akamai May 8, 2025 •

edited

Loading

yec-akamai left a comment •

edited

Loading

		from linode_api4.objects import Base, Property


		class Dashboard(Base):

adding SDK changes for ACLP APIs #528

Are you sure you want to change the base?

adding SDK changes for ACLP APIs #528

Conversation

pmajali commented Apr 11, 2025 • edited Loading

📝 Description

✔️ How to Test

yec-akamai commented Apr 16, 2025

Check notice

Choose a reason for hiding this comment

yec-akamai left a comment

Choose a reason for hiding this comment

Check notice

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yec-akamai May 8, 2025 • edited Loading

Choose a reason for hiding this comment

yec-akamai left a comment • edited Loading

Choose a reason for hiding this comment

pmajali commented Apr 11, 2025 •

edited

Loading

yec-akamai May 8, 2025 •

edited

Loading

yec-akamai left a comment •

edited

Loading