Resource alerts: threshold alert rules for VMs, volumes, hosts and storage pools

.github/workflows/ci.yml

@@ -128,6 +128,7 @@ jobs:
                   smoke/test_nested_virtualization
                   smoke/test_set_sourcenat
                   smoke/test_webhook_lifecycle
+                  smoke/test_resource_alerts
                   smoke/test_purge_expunged_vms
                   smoke/test_extension_lifecycle
                   smoke/test_extension_custom_action_lifecycle

api/src/main/java/com/cloud/alert/AlertCondition.java

@@ -0,0 +1,33 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package com.cloud.alert;
+
+public enum AlertCondition {
+    GT, GTE, LT, LTE, EQ;
+
+    public boolean evaluate(double value, double threshold) {
+        switch (this) {
+            case GT:  return value > threshold;
+            case GTE: return value >= threshold;
+            case LT:  return value < threshold;
+            case LTE: return value <= threshold;
+            case EQ:  return Double.compare(value, threshold) == 0;
+            default:  return false;
+        }
+    }
+}

api/src/main/java/com/cloud/alert/AlertSeverity.java

@@ -0,0 +1,22 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package com.cloud.alert;
+
+public enum AlertSeverity {
+    CRITICAL, HIGH, MEDIUM, LOW
+}

api/src/main/java/com/cloud/alert/ResourceAlert.java

@@ -0,0 +1,34 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package com.cloud.alert;
+
+import java.util.Date;
+
+import org.apache.cloudstack.api.Identity;
+import org.apache.cloudstack.api.InternalIdentity;
+
+public interface ResourceAlert extends Identity, InternalIdentity {
+
+    long getAlertRuleId();
+    Long getResourceId();
+    String getMetricType();
+    double getMetricValue();
+    AlertSeverity getSeverity();
+    String getMessage();
+    Date getAlertTimestamp();
+}

api/src/main/java/com/cloud/alert/ResourceAlertMetric.java

@@ -0,0 +1,52 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package com.cloud.alert;
+
+import java.util.Arrays;
+import java.util.EnumSet;
+import java.util.Set;
+
+public enum ResourceAlertMetric {
+    CPU_UTILIZATION(ResourceAlertRule.ResourceType.VirtualMachine, ResourceAlertRule.ResourceType.Host),
+    MEMORY_UTILIZATION(ResourceAlertRule.ResourceType.VirtualMachine, ResourceAlertRule.ResourceType.Host),
+    DISK_READ_IOPS(ResourceAlertRule.ResourceType.VirtualMachine),
+    DISK_WRITE_IOPS(ResourceAlertRule.ResourceType.VirtualMachine),
+    DISK_READ_KBPS(ResourceAlertRule.ResourceType.VirtualMachine),
+    DISK_WRITE_KBPS(ResourceAlertRule.ResourceType.VirtualMachine),
+    STORAGE_UTILIZATION(ResourceAlertRule.ResourceType.StoragePool),
+    NETWORK_READ_KBPS(ResourceAlertRule.ResourceType.VirtualMachine, ResourceAlertRule.ResourceType.Host),
+    NETWORK_WRITE_KBPS(ResourceAlertRule.ResourceType.VirtualMachine, ResourceAlertRule.ResourceType.Host),
+    LOAD_AVERAGE(ResourceAlertRule.ResourceType.Host),
+    VOLUME_USED_GB(ResourceAlertRule.ResourceType.Volume),
+    VOLUME_UTILIZATION(ResourceAlertRule.ResourceType.Volume),
+    STORAGE_USED_IOPS(ResourceAlertRule.ResourceType.StoragePool);
+
+    private final Set<ResourceAlertRule.ResourceType> applicableTypes;
+
+    ResourceAlertMetric(ResourceAlertRule.ResourceType... types) {
+        this.applicableTypes = EnumSet.copyOf(Arrays.asList(types));
+    }
+
+    public boolean appliesTo(ResourceAlertRule.ResourceType type) {
+        return applicableTypes.contains(type);
+    }
+
+    public boolean isPercentage() {
+        return this == CPU_UTILIZATION || this == MEMORY_UTILIZATION || this == STORAGE_UTILIZATION || this == VOLUME_UTILIZATION;
+    }
+}

api/src/main/java/com/cloud/alert/ResourceAlertRule.java

@@ -0,0 +1,48 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package com.cloud.alert;
+
+import java.util.Date;
+
+import org.apache.cloudstack.acl.ControlledEntity;
+import org.apache.cloudstack.api.Identity;
+import org.apache.cloudstack.api.InternalIdentity;
+
+public interface ResourceAlertRule extends ControlledEntity, Identity, InternalIdentity {
+
+    enum ResourceType {
+        VirtualMachine, Volume, Host, StoragePool
+    }
+
+    enum State {
+        Enabled, Disabled
+    }
+
+    String getName();
+    ResourceType getResourceType();
+    Long getResourceId();
+    String getMetric();
+    AlertCondition getCondition();
+    double getThreshold();
+    AlertSeverity getSeverity();
+    String getMessage();
+    boolean isEmail();
+    int getResetInterval();
+    State getState();
+    Date getCreated();
+}

api/src/main/java/com/cloud/event/EventTypes.java

@@ -824,6 +824,11 @@ public class EventTypes {
     public static final String EVENT_QUOTA_TARIFF_DELETE = "QUOTA.TARIFF.DELETE";
     public static final String EVENT_QUOTA_TARIFF_UPDATE = "QUOTA.TARIFF.UPDATE";
 
+    // Resource alert rules
+    public static final String EVENT_RESOURCE_ALERT_RULE_CREATE = "RESOURCE.ALERT.RULE.CREATE";
+    public static final String EVENT_RESOURCE_ALERT_RULE_UPDATE = "RESOURCE.ALERT.RULE.UPDATE";
+    public static final String EVENT_RESOURCE_ALERT_RULE_DELETE = "RESOURCE.ALERT.RULE.DELETE";
+
     // Routing
     public static final String EVENT_ZONE_IP4_SUBNET_CREATE = "ZONE.IP4.SUBNET.CREATE";
     public static final String EVENT_ZONE_IP4_SUBNET_UPDATE = "ZONE.IP4.SUBNET.UPDATE";

api/src/main/java/org/apache/cloudstack/alert/ResourceAlertService.java

@@ -0,0 +1,38 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package org.apache.cloudstack.alert;
+
+import org.apache.cloudstack.api.response.ListResponse;
+import org.apache.cloudstack.api.command.user.resourcealert.CreateResourceAlertRuleCmd;
+import org.apache.cloudstack.api.command.user.resourcealert.DeleteResourceAlertRuleCmd;
+import org.apache.cloudstack.api.command.user.resourcealert.ListResourceAlertRulesCmd;
+import org.apache.cloudstack.api.command.user.resourcealert.ListResourceAlertsCmd;
+import org.apache.cloudstack.api.command.user.resourcealert.UpdateResourceAlertRuleCmd;
+import org.apache.cloudstack.api.response.ResourceAlertResponse;
+import org.apache.cloudstack.api.response.ResourceAlertRuleResponse;
+
+import com.cloud.utils.component.PluggableService;
+
+public interface ResourceAlertService extends PluggableService {
+
+    ResourceAlertRuleResponse createResourceAlertRule(CreateResourceAlertRuleCmd cmd);
+    ListResponse<ResourceAlertRuleResponse> listResourceAlertRules(ListResourceAlertRulesCmd cmd);
+    ResourceAlertRuleResponse updateResourceAlertRule(UpdateResourceAlertRuleCmd cmd);
+    boolean deleteResourceAlertRule(DeleteResourceAlertRuleCmd cmd);
+    ListResponse<ResourceAlertResponse> listResourceAlerts(ListResourceAlertsCmd cmd);
+}

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -1107,6 +1107,14 @@ public class ApiConstants {
     public static final String AGGR_FUNCTION = "aggrfunction";
     public static final String AGGR_VALUE = "aggrvalue";
     public static final String THRESHOLD = "threshold";
+    public static final String METRIC = "metric";
+    public static final String CONDITION = "condition";
+    public static final String SEVERITY = "severity";
+    public static final String RESET_INTERVAL = "resetinterval";
+    public static final String WEBHOOK_IDS = "webhookids";
+    public static final String WEBHOOK_NAMES = "webhooknames";
+    public static final String CLEANUP_WEBHOOKS = "cleanupwebhooks";
+    public static final String ALERT_RULE_ID = "alertruleid";
     public static final String RELATIONAL_OPERATOR = "relationaloperator";
     public static final String OTHER_DEPLOY_PARAMS = "otherdeployparams";
     public static final String MIN_MEMBERS = "minmembers";