Add filtering by health and state in list rules

Author: euniceek

pkg/ruler/api.go

@@ -135,11 +135,25 @@ func (a *API) PrometheusRules(w http.ResponseWriter, req *http.Request) {
 		return
 	}
 
+	state := strings.TrimSpace(strings.ToLower(req.URL.Query().Get("state")))
+	if state != "" && !AlertState(state).Valid() {
+		util_api.RespondError(logger, w, v1.ErrBadData, fmt.Sprintf("unsupported state value %q", state), http.StatusBadRequest)
+		return
+	}
+
+	health := strings.TrimSpace(strings.ToLower(req.URL.Query().Get("health")))
+	if health != "" && !RuleHealth(health).Valid() {
+		util_api.RespondError(logger, w, v1.ErrBadData, fmt.Sprintf("unsupported health value %q", health), http.StatusBadRequest)
+		return
+	}
+
 	rulesRequest := RulesRequest{
 		RuleNames:      req.Form["rule_name[]"],
 		RuleGroupNames: req.Form["rule_group[]"],
 		Files:          req.Form["file[]"],
 		Type:           typ,
+		State:          state,
+		Health:         health,
 	}
 
 	w.Header().Set("Content-Type", "application/json")

pkg/ruler/ruler.go

@@ -75,6 +75,19 @@ const (
 	recordingRuleFilter string = "record"
 )
 
+type AlertState string
+type RuleHealth string
+
+const (
+	firing   AlertState = "firing"
+	pending  AlertState = "pending"
+	inactive AlertState = "inactive"
+
+	unknown RuleHealth = "unknown"
+	ok      RuleHealth = "ok"
+	err     RuleHealth = "err"
+)
+
 type DisabledRuleGroupErr struct {
 	Message string
 }
@@ -874,9 +887,11 @@ func (r *Ruler) getLocalRules(userID string, rulesRequest RulesRequest, includeB
 	ruleGroupNameSet := sliceToSet(rulesRequest.RuleGroupNames)
 	fileSet := sliceToSet(rulesRequest.Files)
 	ruleType := rulesRequest.Type
+	alertState := rulesRequest.State
+	health := rulesRequest.Health
 
 	returnAlerts := ruleType == "" || ruleType == alertingRuleFilter
-	returnRecording := ruleType == "" || ruleType == recordingRuleFilter
+	returnRecording := (ruleType == "" || ruleType == recordingRuleFilter) && alertState == ""
 
 	for _, group := range groups {
 		// The mapped filename is url path escaped encoded to make handling `/` characters easier
@@ -915,6 +930,9 @@ func (r *Ruler) getLocalRules(userID string, rulesRequest RulesRequest, includeB
 					continue
 				}
 			}
+			if !returnByHealth(health, string(r.Health())) {
+				continue
+			}
 			lastError := ""
 			if r.LastError() != nil {
 				lastError = r.LastError().Error()
@@ -926,6 +944,9 @@ func (r *Ruler) getLocalRules(userID string, rulesRequest RulesRequest, includeB
 				if !returnAlerts {
 					continue
 				}
+				if !returnByState(alertState, rule.State().String()) {
+					continue
+				}
 				alerts := []*AlertStateDesc{}
 				for _, a := range rule.ActiveAlerts() {
 					alerts = append(alerts, &AlertStateDesc{
@@ -1296,3 +1317,27 @@ func (r *Ruler) ListAllRules(w http.ResponseWriter, req *http.Request) {
 	close(iter)
 	<-done
 }
+
+func returnByState(requestState string, alertState string) bool {
+	return requestState == "" || requestState == alertState
+}
+
+func returnByHealth(requestHealth string, ruleHealth string) bool {
+	return requestHealth == "" || requestHealth == ruleHealth
+}
+
+func (r AlertState) Valid() bool {
+	switch r {
+	case firing, pending, inactive:
+		return true
+	}
+	return false
+}
+
+func (r RuleHealth) Valid() bool {
+	switch r {
+	case unknown, ok, err:
+		return true
+	}
+	return false
+}

pkg/ruler/ruler.pb.go

@@ -24,6 +24,8 @@ message RulesRequest {
   repeated string ruleGroupNames = 2;
   repeated string files = 3;
   string type = 4;
+  string state = 5;
+  string health = 6;
 }
 
 message RulesResponse {