Let resource alert rules be disabled and enabled again

Author: Damans227

engine/schema/src/main/resources/META-INF/db/schema-42300to2400.sql

@@ -35,6 +35,7 @@ CREATE TABLE IF NOT EXISTS `cloud`.`resource_alert_rules` (
     `message` varchar(4096) DEFAULT NULL,
     `email` tinyint(1) NOT NULL DEFAULT 0,
     `reset_interval` int unsigned NOT NULL DEFAULT 600 COMMENT 'minimum seconds between repeat firings of this rule',
+    `state` varchar(32) NOT NULL DEFAULT 'Enabled' COMMENT 'Enabled or Disabled; disabled rules are not checked',
     `created` datetime DEFAULT NULL,
     `updated` datetime DEFAULT NULL,
     `removed` datetime DEFAULT NULL,

engine/schema/src/main/resources/META-INF/db/views/cloud.resource_alert_rule_view.sql

@@ -32,6 +32,7 @@ CREATE VIEW `cloud`.`resource_alert_rule_view` AS
         r.message,
         r.email,
         r.reset_interval,
+        r.state,
         r.created,
         r.updated,
         r.removed,

plugins/resource-alerts/src/main/java/org/apache/cloudstack/resourcealert/ResourceAlertManagerImpl.java

@@ -214,6 +214,9 @@ public void evaluateRules() {
                         ruleDao.remove(rule.getId());
                         continue;
                     }
+                    if (ResourceAlertRule.State.Disabled.equals(rule.getState())) {
+                        continue;
+                    }
                     evaluateRule(rule);
                 } catch (Exception e) {
                     logger.warn("Failed to evaluate resource alert rule {}", rule.getUuid(), e);

plugins/resource-alerts/src/main/java/org/apache/cloudstack/resourcealert/ResourceAlertRule.java

@@ -29,6 +29,10 @@ enum ResourceType {
         VirtualMachine, Volume, Host, StoragePool
     }
 
+    enum State {
+        Enabled, Disabled
+    }
+
     String getName();
     ResourceType getResourceType();
     Long getResourceId();
@@ -39,5 +43,6 @@ enum ResourceType {
     String getMessage();
     boolean isEmail();
     int getResetInterval();
+    State getState();
     Date getCreated();
 }

plugins/resource-alerts/src/main/java/org/apache/cloudstack/resourcealert/ResourceAlertServiceImpl.java

@@ -214,6 +214,7 @@ public ResourceAlertRuleResponse updateResourceAlertRule(UpdateResourceAlertRule
             validateResetInterval(cmd.getResetInterval());
             rule.setResetInterval(cmd.getResetInterval());
         }
+        if (StringUtils.isNotBlank(cmd.getState())) rule.setState(parseState(cmd.getState()));
         rule.setUpdated(new Date());
 
         if (cmd.isCleanupWebhooks()) {
@@ -318,6 +319,7 @@ private ResourceAlertRuleResponse toRuleResponse(ResourceAlertRuleJoinVO vo) {
         r.setMessage(vo.getMessage());
         r.setEmail(vo.isEmail());
         r.setResetInterval(vo.getResetInterval());
+        r.setState(vo.getState() != null ? vo.getState().name() : null);
         List<Pair<String, String>> webhooks = describeWebhooks(vo.getId());
         r.setWebhookIds(webhooks.stream().map(Pair::first).collect(Collectors.toList()));
         // Left out when empty so the UI hides it
@@ -553,6 +555,14 @@ private ResourceAlertRule.ResourceType parseResourceType(String value) {
         return type;
     }
 
+    private ResourceAlertRule.State parseState(String value) {
+        ResourceAlertRule.State state = EnumUtils.getEnumIgnoreCase(ResourceAlertRule.State.class, value);
+        if (state == null) {
+            throw new InvalidParameterValueException("Invalid state: " + value + ". Valid values: Enabled, Disabled");
+        }
+        return state;
+    }
+
     private AlertCondition parseCondition(String value) {
         AlertCondition cond = EnumUtils.getEnum(AlertCondition.class, value != null ? value.toUpperCase() : null);
         if (cond == null) {

plugins/resource-alerts/src/main/java/org/apache/cloudstack/resourcealert/api/command/user/UpdateResourceAlertRuleCmd.java

@@ -79,6 +79,10 @@ public class UpdateResourceAlertRuleCmd extends BaseCmd {
             description = "new minimum seconds between repeat firings")
     private Integer resetInterval;
 
+    @Parameter(name = ApiConstants.STATE, type = CommandType.STRING,
+            description = "Enabled or Disabled; a disabled rule is not checked and fires no alerts")
+    private String state;
+
     @Parameter(name = ApiConstants.WEBHOOK_IDS, type = CommandType.LIST, collectionType = CommandType.STRING,
             description = "UUIDs of webhooks to deliver alerts of this rule to; replaces the current list")
     private List<String> webhookIds;
@@ -95,6 +99,7 @@ public class UpdateResourceAlertRuleCmd extends BaseCmd {
     public String getMessage() { return message; }
     public Boolean getEmail() { return email; }
     public Integer getResetInterval() { return resetInterval; }
+    public String getState() { return state; }
     public List<String> getWebhookIds() { return webhookIds; }
     public boolean isCleanupWebhooks() { return Boolean.TRUE.equals(cleanupWebhooks); }
 

plugins/resource-alerts/src/main/java/org/apache/cloudstack/resourcealert/api/response/ResourceAlertRuleResponse.java

@@ -79,6 +79,10 @@ public class ResourceAlertRuleResponse extends BaseResponse {
     @Param(description = "minimum seconds between repeat firings of this rule")
     private int resetInterval;
 
+    @SerializedName(ApiConstants.STATE)
+    @Param(description = "Enabled or Disabled; disabled rules are not checked")
+    private String state;
+
     @SerializedName(ApiConstants.WEBHOOK_IDS)
     @Param(description = "UUIDs of webhooks the rule delivers alerts to")
     private List<String> webhookIds;
@@ -123,6 +127,7 @@ public class ResourceAlertRuleResponse extends BaseResponse {
     public void setMessage(String message) { this.message = message; }
     public void setEmail(boolean email) { this.email = email; }
     public void setResetInterval(int resetInterval) { this.resetInterval = resetInterval; }
+    public void setState(String state) { this.state = state; }
     public void setWebhookIds(List<String> webhookIds) { this.webhookIds = webhookIds; }
     public void setWebhookNames(List<String> webhookNames) { this.webhookNames = webhookNames; }
     public void setAccountName(String accountName) { this.accountName = accountName; }

plugins/resource-alerts/src/main/java/org/apache/cloudstack/resourcealert/dao/ResourceAlertRuleDaoImpl.java

@@ -69,6 +69,7 @@ public ResourceAlertRuleDaoImpl() {
         specificRuleSearch.and("resourceId", specificRuleSearch.entity().getResourceId(), SearchCriteria.Op.EQ);
         specificRuleSearch.and("accountId", specificRuleSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
         specificRuleSearch.and("removed", specificRuleSearch.entity().getRemoved(), SearchCriteria.Op.NULL);
+        specificRuleSearch.and("state", specificRuleSearch.entity().getState(), SearchCriteria.Op.EQ);
         specificRuleSearch.done();
 
         resourceTypeSearch = createSearchBuilder();
@@ -136,6 +137,7 @@ public boolean existsSpecificRule(ResourceAlertRule.ResourceType resourceType, S
         sc.setParameters("metric", metric);
         sc.setParameters("resourceId", resourceId);
         sc.setParameters("accountId", accountId);
+        sc.setParameters("state", ResourceAlertRule.State.Enabled);
         return getCount(sc) > 0;
     }
 

plugins/resource-alerts/src/main/java/org/apache/cloudstack/resourcealert/vo/ResourceAlertRuleJoinVO.java

@@ -79,6 +79,10 @@ public class ResourceAlertRuleJoinVO implements ControlledEntity {
     @Column(name = "reset_interval")
     private int resetInterval;
 
+    @Column(name = "state")
+    @Enumerated(value = EnumType.STRING)
+    private ResourceAlertRule.State state;
+
     @Column(name = "created")
     private Date created;
 
@@ -134,6 +138,7 @@ public ResourceAlertRuleJoinVO() {}
     public String getMessage() { return message; }
     public boolean isEmail() { return email; }
     public int getResetInterval() { return resetInterval; }
+    public ResourceAlertRule.State getState() { return state; }
     public Date getCreated() { return created; }
     public Date getUpdated() { return updated; }
     public Date getRemoved() { return removed; }

plugins/resource-alerts/src/main/java/org/apache/cloudstack/resourcealert/vo/ResourceAlertRuleVO.java

@@ -88,6 +88,10 @@ public class ResourceAlertRuleVO implements ResourceAlertRule {
     @Column(name = "reset_interval")
     private int resetInterval;
 
+    @Column(name = "state")
+    @Enumerated(value = EnumType.STRING)
+    private State state = State.Enabled;
+
     @Column(name = GenericDao.CREATED_COLUMN)
     private Date created;
 
@@ -134,6 +138,7 @@ public ResourceAlertRuleVO(String name, ResourceType resourceType, Long resource
     @Override public String getMessage() { return message; }
     @Override public boolean isEmail() { return email; }
     @Override public int getResetInterval() { return resetInterval; }
+    @Override public State getState() { return state; }
     @Override public Date getCreated() { return created; }
 
     @Override
@@ -151,6 +156,7 @@ public Class<?> getEntityType() {
     public void setMessage(String message) { this.message = message; }
     public void setEmail(boolean email) { this.email = email; }
     public void setResetInterval(int resetInterval) { this.resetInterval = resetInterval; }
+    public void setState(State state) { this.state = state; }
     public void setUpdated(Date updated) { this.updated = updated; }
     public void setRemoved(Date removed) { this.removed = removed; }
 }