Skip to content

ACLP clone alert definition and addition of group by field in alerting APIs #985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shkaruna wants to merge 2 commits into
base: main
Choose a base branch
from
Open

ACLP clone alert definition and addition of group by field in alerting APIs #985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19f2838
feat: add aclp clone api and group_by field
shkaruna Jun 5, 2026
1ad2bea
Merge branch 'main' of https://github.com/linode/linodego into feat/c…
shkaruna Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions monitor_alert_definitions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ type AlertDefinition struct {
Scope AlertDefinitionScope `json:"scope"`
Regions []string `json:"regions"`
Entities AlertDefinitionEntities `json:"entities"`
GroupBy []string `json:"group_by"`
}

// TriggerConditions represents the trigger conditions for an alert.
Expand Down Expand Up @@ -167,6 +168,7 @@ type AlertDefinitionCreateOptions struct {
Description *string `json:"description,omitzero"`
Scope AlertDefinitionScope `json:"scope,omitzero"`
Regions []string `json:"regions,omitzero"`
GroupBy []string `json:"group_by,omitzero"`
}

// AlertDefinitionUpdateOptions are the options used to update an alert definition.
Expand All @@ -180,6 +182,21 @@ type AlertDefinitionUpdateOptions struct {
Description *string `json:"description,omitzero"`
Status *AlertDefinitionStatus `json:"status,omitzero"`
Regions []string `json:"regions,omitzero"`
GroupBy []string `json:"group_by,omitzero"`
}

// AlertDefinitionCloneOptions are the options used to clone an existing alert definition.
type AlertDefinitionCloneOptions struct {
Label string `json:"label"`
Severity *int `json:"severity,omitzero"`
ChannelIDs []int `json:"channel_ids,omitzero"`
RuleCriteria *RuleCriteriaOptions `json:"rule_criteria,omitzero"`
TriggerConditions *TriggerConditions `json:"trigger_conditions,omitzero"`
EntityIDs []string `json:"entity_ids,omitzero"`
Description *string `json:"description,omitzero"`
Scope AlertDefinitionScope `json:"scope,omitzero"`
Regions []string `json:"regions,omitzero"`
GroupBy []string `json:"group_by,omitzero"`
}

// UnmarshalJSON implements the json.Unmarshaler interface
Expand Down Expand Up @@ -307,3 +324,14 @@ func (c *Client) ListMonitorAlertDefinitionEntities(
e := formatAPIPath("monitor/services/%s/alert-definitions/%d/entities", serviceType, alertID)
return getPaginatedResults[AlertDefinitionEntity](ctx, c, e, opts)
}

// CloneMonitorAlertDefinition clones an ACLP Monitor Alert Definition.
Comment thread
shkaruna marked this conversation as resolved.
func (c *Client) CloneMonitorAlertDefinition(
ctx context.Context,
serviceType string,
alertID int,
opts AlertDefinitionCloneOptions,
) (*AlertDefinition, error) {
e := formatAPIPath("monitor/services/%s/alert-definitions/%d/clone", serviceType, alertID)
return doPOSTRequest[AlertDefinition](ctx, c, e, opts)
}
140 changes: 60 additions & 80 deletions test/integration/fixtures/TestMonitorAlertDefinition.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,54 +14,31 @@ interactions:
url: https://api.linode.com/v4beta/monitor/alert-definitions?page=1
method: GET
response:
body: '{"pages": 1, "page": 1, "results": 4, "data": [{"id": 10000, "label":
body: '{"pages": 1, "page": 1, "results": 2, "data": [{"id": 10000, "label":
"High Memory Usage Plan Dedicated", "description": "Alert triggers when dedicated
plan nodes consistently reach critical memory usage, risking application performance
degradation.", "service_type": "dbaas", "type": "system", "scope": "entity",
"class": "dedicated", "regions": [], "status": "enabled", "severity":
2, "rule_criteria": {"rules": [{"label": "Memory Usage", "metric": "memory_usage",
"unit": "percent", "aggregate_function": "avg", "operator": "gt", "threshold":
95, "dimension_filters": []}]}, "alert_channels": [{"id": 10000, "label": "Read-Write
Channel", "url": "/monitor/alert-channels/10000", "type": "alert-channels"}],
"trigger_conditions": {"criteria_condition": "ALL", "polling_interval_seconds":
300, "evaluation_period_seconds": 300, "trigger_occurrences": 3}, "created":
"2018-01-02T03:04:05", "updated": "2018-01-02T03:04:05", "created_by": "system",
"updated_by": "system", "entities": {"url": "/monitor/services/dbaas/alert-definitions/10000/entities",
"has_more_resources": false, "count": 5}}, {"id": 10001, "label": "High Memory
Usage Plan Shared", "description": "Alert triggers when shared plan nodes consistently
reach critical memory usage, risking application performance degradation.",
"service_type": "dbaas", "type": "system", "scope": "entity", "class": "shared",
"regions": [], "status": "enabled", "severity": 2, "rule_criteria": {"rules": [{"label": "Memory Usage",
plan nodes consistently reach critical memory usage.", "service_type": "dbaas",
"type": "system", "scope": "entity", "class": "dedicated", "regions": [], "status":
"enabled", "severity": 2, "rule_criteria": {"rules": [{"label": "Memory Usage",
"metric": "memory_usage", "unit": "percent", "aggregate_function": "avg", "operator":
"gt", "threshold": 90, "dimension_filters": []}]}, "alert_channels": [{"id":
"gt", "threshold": 95, "dimension_filters": []}]}, "alert_channels": [{"id":
10000, "label": "Read-Write Channel", "url": "/monitor/alert-channels/10000",
"type": "alert-channels"}], "trigger_conditions": {"criteria_condition": "ALL",
"polling_interval_seconds": 300, "evaluation_period_seconds": 300, "trigger_occurrences":
3}, "created": "2018-01-02T03:04:05", "updated": "2018-01-02T03:04:05", "created_by":
"system", "updated_by": "system", "entities": {"url": "/monitor/services/dbaas/alert-definitions/10001/entities",
"has_more_resources": false, "count": 2}}, {"id": 11001, "label": "test_alert_logs_prod",
"description": "some desc1", "service_type": "logs", "type": "user", "scope":
"entity", "class": null, "regions": [], "status": "enabled", "severity": 2, "rule_criteria": {"rules": [{"label":
"Successful Upload Count", "metric": "success_upload_count", "unit": "count",
"aggregate_function": "sum", "operator": "lt", "threshold": 100000, "dimension_filters":
[]}]}, "alert_channels": [{"id": 10004, "label": "Alert Channel", "url":
"system", "updated_by": "system", "group_by": ["entity_id"], "entities": {"url":
"/monitor/services/dbaas/alert-definitions/10000/entities", "has_more_resources":
false, "count": 5}}, {"id": 11184, "label": "Test alert", "description":
"Test alert", "service_type": "dbaas", "type": "user", "scope":
"entity", "class": null, "regions": [], "status": "disabled", "severity": 3,
"rule_criteria": {"rules": [{"label": "CPU Usage", "metric": "cpu_usage", "unit":
"percent", "aggregate_function": "avg", "operator": "gt", "threshold": 0, "dimension_filters":
[]}]}, "alert_channels": [{"id": 10004, "label": "Team Channel", "url":
"/monitor/alert-channels/10004", "type": "alert-channels"}], "trigger_conditions":
{"criteria_condition": "ALL", "polling_interval_seconds": 300, "evaluation_period_seconds":
300, "trigger_occurrences": 1}, "created": "2018-01-02T03:04:05", "updated":
"2018-01-02T03:04:05", "created_by": "tester", "updated_by":
"tester", "entities": {"url": "/monitor/services/logs/alert-definitions/11001/entities",
"has_more_resources": false, "count": 1}}, {"id": 11021, "label": "Test Alert", "description": "Test Alert", "service_type":
"dbaas", "type": "user", "scope": "entity", "class": null, "regions": [], "status":
"enabled", "severity": 1, "rule_criteria": {"rules": [{"label": "Memory Usage", "metric":
"memory_usage", "unit": "percent", "aggregate_function": "sum", "operator":
"gt", "threshold": 100, "dimension_filters": []}]}, "alert_channels": [{"id":
10004, "label": "Alert Channel", "url": "/monitor/alert-channels/10004",
"type": "alert-channels"}], "trigger_conditions": {"criteria_condition": "ALL",
"polling_interval_seconds": 1800, "evaluation_period_seconds": 900, "trigger_occurrences":
10}, "created": "2018-01-02T03:04:05", "updated": "2018-01-02T03:04:05", "created_by":
"tester", "updated_by": "tester", "entities":
{"url": "/monitor/services/dbaas/alert-definitions/11021/entities", "has_more_resources":
false, "count": 2}}]}'
"tester", "group_by": ["entity_id"], "entities": {"url": "/monitor/services/dbaas/alert-definitions/11184/entities",
"has_more_resources": false, "count": 1}}]}'
headers:
Access-Control-Allow-Credentials:
- "true"
Expand All @@ -84,7 +61,7 @@ interactions:
Content-Type:
- application/json
Expires:
- Mon, 27 Apr 2026 12:32:17 GMT
- Thu, 04 Jun 2026 10:41:16 GMT
Pragma:
- no-cache
Strict-Transport-Security:
Expand Down Expand Up @@ -114,7 +91,7 @@ interactions:
duration: ""
- request:
body: '{"label":"go-test-alert-definition-create","severity":2,"channel_ids":[10000],"rule_criteria":{"rules":[{"aggregate_function":"avg","dimension_filters":[{"dimension_label":"node_type","operator":"eq","value":"primary"}],"metric":"memory_usage","operator":"gt","threshold":90}]},"trigger_conditions":{"criteria_condition":"ALL","evaluation_period_seconds":300,"polling_interval_seconds":300,"trigger_occurrences":1},"description":"Test
alert definition creation"}'
alert definition creation","group_by":["entity_id"]}'
form: {}
headers:
Accept:
Expand All @@ -126,18 +103,19 @@ interactions:
url: https://api.linode.com/v4beta/monitor/services/dbaas/alert-definitions
method: POST
response:
body: '{"id": 11072, "label": "go-test-alert-definition-create", "description":
body: '{"id": 11230, "label": "go-test-alert-definition-create", "description":
"Test alert definition creation", "service_type": "dbaas", "type": "user", "scope":
"entity", "class": null, "regions": [], "status": "provisioning", "severity": 2, "rule_criteria": {"rules": [{"label":
"Memory Usage", "metric": "memory_usage", "unit": "percent", "aggregate_function":
"avg", "operator": "gt", "threshold": 90, "dimension_filters": [{"label": "Node
Type", "dimension_label": "node_type", "operator": "eq", "value": "primary"}]}]},
"alert_channels": [{"id": 10000, "label": "Read-Write Channel", "url": "/monitor/alert-channels/10000",
"type": "alert-channels"}], "trigger_conditions": {"criteria_condition": "ALL",
"polling_interval_seconds": 300, "evaluation_period_seconds": 300, "trigger_occurrences":
1}, "created": "2018-01-02T03:04:05", "updated": "2018-01-02T03:04:05", "created_by":
"tester", "updated_by": "tester", "entities":
{"url": "/monitor/services/dbaas/alert-definitions/11072/entities", "has_more_resources":
"entity", "class": null, "regions": [], "status": "provisioning", "severity":
2, "rule_criteria": {"rules": [{"label": "Memory Usage", "metric": "memory_usage",
"unit": "percent", "aggregate_function": "avg", "operator": "gt", "threshold":
90, "dimension_filters": [{"label": "Node Type", "dimension_label": "node_type",
"operator": "eq", "value": "primary"}]}]}, "alert_channels": [{"id": 10000,
"label": "Read-Write Channel", "url": "/monitor/alert-channels/10000", "type":
"alert-channels"}], "trigger_conditions": {"criteria_condition": "ALL", "polling_interval_seconds":
300, "evaluation_period_seconds": 300, "trigger_occurrences": 1}, "created":
"2018-01-02T03:04:05", "updated": "2018-01-02T03:04:05", "created_by": "tester",
"updated_by": "tester", "group_by": ["entity_id"], "entities":
{"url": "/monitor/services/dbaas/alert-definitions/11230/entities", "has_more_resources":
false, "count": 0}}'
headers:
Access-Control-Allow-Credentials:
Expand All @@ -161,7 +139,7 @@ interactions:
Content-Type:
- application/json
Expires:
- Mon, 27 Apr 2026 12:32:18 GMT
- Thu, 04 Jun 2026 10:41:17 GMT
Pragma:
- no-cache
Strict-Transport-Security:
Expand Down Expand Up @@ -198,21 +176,22 @@ interactions:
- application/json
User-Agent:
- linodego/dev https://github.com/linode/linodego
url: https://api.linode.com/v4beta/monitor/services/dbaas/alert-definitions/11072
url: https://api.linode.com/v4beta/monitor/services/dbaas/alert-definitions/11230
method: GET
response:
body: '{"id": 11072, "label": "go-test-alert-definition-create", "description":
body: '{"id": 11230, "label": "go-test-alert-definition-create", "description":
"Test alert definition creation", "service_type": "dbaas", "type": "user", "scope":
"entity", "class": null, "regions": [], "status": "enabled", "severity": 2, "rule_criteria": {"rules": [{"label":
"Memory Usage", "metric": "memory_usage", "unit": "percent", "aggregate_function":
"avg", "operator": "gt", "threshold": 90, "dimension_filters": [{"label": "Node
Type", "dimension_label": "node_type", "operator": "eq", "value": "primary"}]}]},
"alert_channels": [{"id": 10000, "label": "Read-Write Channel", "url": "/monitor/alert-channels/10000",
"type": "alert-channels"}], "trigger_conditions": {"criteria_condition": "ALL",
"polling_interval_seconds": 300, "evaluation_period_seconds": 300, "trigger_occurrences":
1}, "created": "2018-01-02T03:04:05", "updated": "2018-01-02T03:04:05", "created_by":
"tester", "updated_by": "tester", "entities":
{"url": "/monitor/services/dbaas/alert-definitions/11072/entities", "has_more_resources":
"entity", "class": null, "regions": [], "status": "enabled", "severity": 2,
"rule_criteria": {"rules": [{"label": "Memory Usage", "metric": "memory_usage",
"unit": "percent", "aggregate_function": "avg", "operator": "gt", "threshold":
90, "dimension_filters": [{"label": "Node Type", "dimension_label": "node_type",
"operator": "eq", "value": "primary"}]}]}, "alert_channels": [{"id": 10000,
"label": "Read-Write Channel", "url": "/monitor/alert-channels/10000", "type":
"alert-channels"}], "trigger_conditions": {"criteria_condition": "ALL", "polling_interval_seconds":
300, "evaluation_period_seconds": 300, "trigger_occurrences": 1}, "created":
"2018-01-02T03:04:05", "updated": "2018-01-02T03:04:05", "created_by": "tester",
"updated_by": "tester", "group_by": ["entity_id"], "entities":
{"url": "/monitor/services/dbaas/alert-definitions/11230/entities", "has_more_resources":
false, "count": 0}}'
headers:
Access-Control-Allow-Credentials:
Expand All @@ -236,7 +215,7 @@ interactions:
Content-Type:
- application/json
Expires:
- Mon, 27 Apr 2026 12:32:35 GMT
- Thu, 04 Jun 2026 10:41:33 GMT
Pragma:
- no-cache
Strict-Transport-Security:
Expand Down Expand Up @@ -275,21 +254,22 @@ interactions:
- application/json
User-Agent:
- linodego/dev https://github.com/linode/linodego
url: https://api.linode.com/v4beta/monitor/services/dbaas/alert-definitions/11072
url: https://api.linode.com/v4beta/monitor/services/dbaas/alert-definitions/11230
method: PUT
response:
body: '{"id": 11072, "label": "go-test-alert-definition-create-updated", "description":
body: '{"id": 11230, "label": "go-test-alert-definition-create-updated", "description":
"Test alert definition creation", "service_type": "dbaas", "type": "user", "scope":
"entity", "class": null, "regions": [], "status": "enabled", "severity": 2, "rule_criteria": {"rules": [{"label":
"Memory Usage", "metric": "memory_usage", "unit": "percent", "aggregate_function":
"avg", "operator": "gt", "threshold": 90, "dimension_filters": [{"label": "Node
Type", "dimension_label": "node_type", "operator": "eq", "value": "primary"}]}]},
"alert_channels": [{"id": 10000, "label": "Read-Write Channel", "url": "/monitor/alert-channels/10000",
"type": "alert-channels"}], "trigger_conditions": {"criteria_condition": "ALL",
"polling_interval_seconds": 300, "evaluation_period_seconds": 300, "trigger_occurrences":
1}, "created": "2018-01-02T03:04:05", "updated": "2018-01-02T03:04:05", "created_by":
"tester", "updated_by": "tester", "entities":
{"url": "/monitor/services/dbaas/alert-definitions/11072/entities", "has_more_resources":
"entity", "class": null, "regions": [], "status": "enabled", "severity": 2,
"rule_criteria": {"rules": [{"label": "Memory Usage", "metric": "memory_usage",
"unit": "percent", "aggregate_function": "avg", "operator": "gt", "threshold":
90, "dimension_filters": [{"label": "Node Type", "dimension_label": "node_type",
"operator": "eq", "value": "primary"}]}]}, "alert_channels": [{"id": 10000,
"label": "Read-Write Channel", "url": "/monitor/alert-channels/10000", "type":
"alert-channels"}], "trigger_conditions": {"criteria_condition": "ALL", "polling_interval_seconds":
300, "evaluation_period_seconds": 300, "trigger_occurrences": 1}, "created":
"2018-01-02T03:04:05", "updated": "2018-01-02T03:04:05", "created_by": "tester",
"updated_by": "tester", "group_by": ["entity_id"], "entities":
{"url": "/monitor/services/dbaas/alert-definitions/11230/entities", "has_more_resources":
false, "count": 0}}'
headers:
Access-Control-Allow-Credentials:
Expand All @@ -313,7 +293,7 @@ interactions:
Content-Type:
- application/json
Expires:
- Mon, 27 Apr 2026 12:32:36 GMT
- Thu, 04 Jun 2026 10:41:35 GMT
Pragma:
- no-cache
Strict-Transport-Security:
Expand Down Expand Up @@ -350,7 +330,7 @@ interactions:
- application/json
User-Agent:
- linodego/dev https://github.com/linode/linodego
url: https://api.linode.com/v4beta/monitor/services/dbaas/alert-definitions/11072
url: https://api.linode.com/v4beta/monitor/services/dbaas/alert-definitions/11230
method: DELETE
response:
body: '{}'
Expand Down Expand Up @@ -378,7 +358,7 @@ interactions:
Content-Type:
- application/json
Expires:
- Mon, 27 Apr 2026 12:32:37 GMT
- Thu, 04 Jun 2026 10:41:36 GMT
Pragma:
- no-cache
Strict-Transport-Security:
Expand Down
Loading