ACLP Alerting go SDK #824

srbhaakamai · 2025-09-15T13:55:50Z

📝 Description

Provide go SDK support to ACLP clients to perform CRUD operations for Alerts.

✔️ How to Test

How do I run the relevant unit/integration tests?

Prerequisites
Go 1.19+ installed
Valid Linode API token with monitor permissions
Export LINODE_TOKEN environment variable for integration tests

Run all monitor alert definition unit tests:
UNIT TEST:
go test ./test/unit -run ".MonitorAlertDefinition." -v

Expected Output:

✅ TestCreateMonitorAlertDefinition
✅ TestCreateMonitorAlertDefinitionWithIdempotency
✅ TestGetMonitorAlertDefinition
✅ TestListMonitorAlertDefinitions
✅ TestUpdateMonitorAlertDefinition
✅ TestUpdateMonitorAlertDefinition_LabelOnly
✅ TestDeleteMonitorAlertDefinition

INTEGRATION TEST:
export LINODE_TOKEN="your-linode-api-token"
go test ./test/integration -run "TestMonitorAlertDefinition_smoke" -v

Test Coverage:

List Operations: Validates fetching existing alert definitions
Channel Discovery: Finds available alert channels for testing
Create: Tests complex alert definition creation with:
TriggerConditions (evaluation periods, polling intervals)
RuleCriteria with Rules (metrics, operators, thresholds)
DimensionFilters (node type filtering)
Update: Tests label-only updates with proper timing
Delete: Tests cleanup with exponential backoff retry logic
Expected Duration: ~102 seconds (includes API timing requirements)

📷 Preview

If applicable, include a screenshot or code snippet of this change. Otherwise, please remove this section.

Copilot

Pull Request Overview

This PR introduces ACLP (Alerting Linode Platform) SDK functionality to the linodego client library, adding support for monitor alert definitions and channels. The implementation includes API client methods, data structures, and comprehensive test coverage.

Adds monitor alert definitions CRUD operations with support for v4beta API endpoints
Implements monitor channels functionality for alert notification management
Provides comprehensive unit and integration test coverage for all new functionality

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
monitor_alert_definitions.go	Core implementation of alert definitions API client methods and data structures
monitor_channels.go	Monitor channels API client methods and channel management functionality
request_helpers.go	New helper function for v4beta API endpoint formatting
test/unit/base.go	Enhanced test base to support v4beta endpoint mocking
test/unit/monitor_alert_definitions_test.go	Comprehensive unit tests for alert definitions functionality
test/integration/monitor_alert_definitions_test.go	Integration test with real API interaction scenarios
test/integration/fixtures/TestMonitorAlertDefinition_instance.yaml	Test fixture data for integration testing

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

test/integration/monitor_alert_definitions_test.go

monitor_alert_definitions.go

Copilot

Pull Request Overview

Copilot reviewed 77 out of 81 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

yec-akamai

It seems some unrelated commits are added accidentally. Do you mind cleaning up the branch and fixing the conflicts?

lgarber-akamai · 2025-11-12T18:11:29Z

@srbhaakamai Just bumping Ye's comment — could you resolve the conflicts and unrelated comments on this branch? I'm happy to do it too and push up the new commit if you'd like

lgarber-akamai · 2025-11-13T16:05:01Z

@srbhaakamai I just finished up fixing up the commit history and will be providing a review shortly 👍

request_helpers.go

Copilot

Pull Request Overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

monitor_dashboards.go

test/integration/monitor_alert_definitions_test.go

srbhaakamai · 2025-11-27T11:03:28Z

All the review comments are addressed, tested. please continue to review/approve this.

Srinidhi

ezilber-akamai

The failure in TestInstance_GetMonthlyTransfer should be fixable by simply running make fixtures TEST_ARGS="-run TestInstance_GetMonthlyTransfer" and pushing up the newly generated fixture. The failure in TestMonitorAlertDefinition_smoke however seems like a potential issue.

srbhaakamai · 2025-12-04T04:09:27Z

=== RUN TestMonitorAlertDefinition_smoke
monitor_alert_definitions_test.go:48: failed to fetch monitor alert definitions: [401] Invalid Token
--- FAIL: TestMonitorAlertDefinition_smoke (0.18s)

@ezilber-akamai

LINODE_TOKEN token configured in integration_test_suite.go init() may not have read/write access to monitor.
the token that i have is generated from my account with read/write access to monitor. do we need to configure updated token here ?

e.g., token configured linode/linode_api4-python#589 in this seems to work.

Please suggest or make change as needed as i dont have access to change the environment details.

srbhaakamai · 2025-12-08T05:08:03Z

@ezilber-akamai
Any update on this ? let me know if i can do anything about it. else please proceed with fix and take this forward.

ezilber-akamai · 2025-12-08T16:38:39Z

@srbhaakamai I just checked and the token does have read/write access to monitor. I'm thinking it could be an issue with the fixtures. When I run against the fixture locally, I also get the 401 but when I run against the API it passes. I'm looking into this.

ezilber-akamai

Thanks for the contribution!

yec-akamai

Can you fix the comments as well as the merge conflicts? Thank you!

yec-akamai · 2025-12-09T16:35:53Z

go.mod

-toolchain go1.25.1
-


Can you revert the change to go mod? should not be necessary here

yec-akamai · 2025-12-09T16:39:22Z

monitor_alert_definitions.go

+	ServiceType       string                 `json:"service_type"`
+	Status            string                 `json:"status"`
+	HasMoreResources  bool                   `json:"has_more_resources"`
+	Rule              *Rule                  `json:"rule"`


I don't think this field rule is under this struct in the api doc. It should be removed from here.

yec-akamai · 2025-12-09T16:42:38Z

monitor_alert_definitions.go

+	Updated           *time.Time             `json:"-"`
+	UpdatedBy         string                 `json:"updated_by"`
+	CreatedBy         string                 `json:"created_by"`
+	EntityIDs         []string               `json:"entity_ids"`


Judging from the api doc, the entity_ids seems could be any type: The format type for an entity_id may vary, based on the Akamai Cloud service_type

You should build them as []any to accommodate that.

yec-akamai · 2025-12-09T16:44:35Z

monitor_alert_definitions.go

+	Threshold         *float64          `json:"threshold,omitempty"`
+	Unit              *string           `json:"unit,omitempty"`


Just curious why is is necessary to use pointer for these two fields?

yec-akamai · 2025-12-09T16:47:11Z

monitor_alert_definitions.go

+
+// AlertDefinitionCreateOptions are the options used to create a new alert definition.
+type AlertDefinitionCreateOptions struct {
+	ServiceType       string             `json:"service_type"`                 // mandatory


You don't need to include this field here since it's a path param.

yec-akamai · 2025-12-09T16:51:04Z

monitor_alert_definitions.go

+	if serviceType != "" {
+		endpoint = formatAPIPath("monitor/services/%s/alert-definitions", serviceType)
+	} else {
+		endpoint = formatAPIPath("monitor/alert-definitions")
+	}


You probably need to separate these two endpoints into two functions in linodego. Because go can't take optional parameters.

yec-akamai · 2025-12-09T17:03:26Z

alert_channels.go

+// AlertChannelCreateOptions are the options used to create a new Monitor Channel.
+type AlertChannelCreateOptions struct {
+	Label   string                    `json:"label"`
+	Type    string                    `json:"type"`
+	Details AlertChannelDetailOptions `json:"details"`
+}
+
+// AlertChannelDetailOptions are the options used to create the details of a new Monitor Channel.
+type AlertChannelDetailOptions struct {
+	To string `json:"to,omitempty"`
+}


It seems only GET endpoints are supported currently. Can you remove the CreateOptions?

yec-akamai · 2025-12-09T17:04:08Z

alert_channels.go

+func (c *Client) GetAlertChannel(ctx context.Context, channelID int) (*AlertChannel, error) {
+	e := formatAPIPath("monitor/alert-channels/%d", channelID)
+	return doGETRequest[AlertChannel](ctx, c, e)
+}


Just curious, is getting a single alert channel available now? Didn't see it in the api doc though

yec-akamai · 2025-12-09T17:14:15Z

test/integration/monitor_alert_definitions_test.go

+		},
+	}
+
+	createdAlert, err := client.CreateMonitorAlertDefinition(context.Background(), testMonitorAlertDefinitionServiceType, createOpts)


Can you add a test to the CreateMonitorAlertDefinitionWithIdempotency as well? Just want to make sure the API takes the request as expected

yec-akamai · 2025-12-09T17:15:30Z

test/integration/monitor_alert_definitions_test.go

@@ -0,0 +1,189 @@
+package integration


Can you add test cases to the list endpoints ListMonitorAlertDefinitions and ListMonitorAlertChannels?

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

yec-akamai · 2025-12-09T17:35:33Z

monitor_alert_definitions.go

+}
+
+// Rule represents a single rule for an alert.
+type Rule struct {


The Rule object is not the same as it is in the create options. i.e. unit and label is not part of the create body param. Can you double check it, and create a separate option struct RuleOptions to distinguish them? There could be other fields which diverge on read and write path that I may miss, can you double check them as well?

yec-akamai · 2025-12-09T17:37:22Z

monitor_alert_definitions.go

+// DimensionFilter represents a single dimension filter used inside a Rule.
+type DimensionFilter struct {
+	DimensionLabel string `json:"dimension_label"`
+	Label          string `json:"label"`


I find label should not be part of the create options too. It only in the return result

srbhaakamai requested a review from a team as a code owner September 15, 2025 13:55

srbhaakamai requested review from Copilot, jriddle-linode and yec-akamai and removed request for a team September 15, 2025 13:55

srbhaakamai marked this pull request as draft September 15, 2025 13:55

Copilot AI reviewed Sep 15, 2025

View reviewed changes

srbhaakamai closed this Oct 4, 2025

srbhaakamai reopened this Oct 4, 2025

srbhaakamai force-pushed the main branch 3 times, most recently from 9226cfb to 8e71881 Compare October 4, 2025 04:43

srbhaakamai marked this pull request as ready for review October 13, 2025 11:04

lgarber-akamai self-requested a review October 31, 2025 16:51

yec-akamai requested a review from Copilot November 4, 2025 19:01

Copilot AI reviewed Nov 4, 2025

View reviewed changes

yec-akamai reviewed Nov 4, 2025

View reviewed changes

lgarber-akamai force-pushed the main branch 2 times, most recently from 7818a6b to aed99f8 Compare November 13, 2025 16:02

DI-27070 Add support for ACLP alerting

3001996

lgarber-akamai force-pushed the main branch from aed99f8 to 3001996 Compare November 13, 2025 16:03

Fix lint

625296b

lgarber-akamai reviewed Nov 13, 2025

View reviewed changes

request_helpers.go Outdated Show resolved Hide resolved

lgarber-akamai requested a review from Copilot November 13, 2025 18:58

Copilot AI reviewed Nov 13, 2025

View reviewed changes

monitor_dashboards.go Show resolved Hide resolved

test/integration/monitor_alert_definitions_test.go Show resolved Hide resolved

test/integration/monitor_alert_definitions_test.go Show resolved Hide resolved

Fix deprecation formatting

926f2a0

lgarber-akamai requested a review from yec-akamai November 13, 2025 19:38

Fix lint

d72eefa

srbhaakamai added 6 commits November 27, 2025 16:05

fixed review comments

18272f3

fixed review comments

423915d

Merge branch 'main' into main

e933ea7

Delete request_helpers.go

e5b6ef1

fixed review comments

e836182

fixed review comments

5e17334

lgarber-akamai and others added 2 commits December 1, 2025 09:46

fix format

a066c29

formatting issues fixed

51b93c7

ezilber-akamai reviewed Dec 1, 2025

View reviewed changes

Fixed test failures

da18794

ezilber-akamai approved these changes Dec 8, 2025

View reviewed changes

yec-akamai requested changes Dec 9, 2025

View reviewed changes

yec-akamai requested a review from Copilot December 9, 2025 17:17

Copilot AI reviewed Dec 9, 2025

View reviewed changes

yec-akamai requested changes Dec 9, 2025

View reviewed changes

		Threshold *float64 `json:"threshold,omitempty"`
		Unit *string `json:"unit,omitempty"`

		toolchain go1.25.1

ACLP Alerting go SDK #824

Are you sure you want to change the base?

ACLP Alerting go SDK #824

Uh oh!

Conversation

srbhaakamai commented Sep 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Description

✔️ How to Test

📷 Preview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

yec-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

lgarber-akamai commented Nov 12, 2025

Uh oh!

lgarber-akamai commented Nov 13, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srbhaakamai commented Nov 27, 2025

Uh oh!

ezilber-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

srbhaakamai commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

srbhaakamai commented Dec 8, 2025

Uh oh!

ezilber-akamai commented Dec 8, 2025

Uh oh!

ezilber-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

yec-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

srbhaakamai commented Sep 15, 2025 •

edited

Loading

srbhaakamai commented Dec 4, 2025 •

edited

Loading

yec-akamai Dec 9, 2025 •

edited

Loading

yec-akamai Dec 9, 2025 •

edited

Loading