Adding a query parameter to filter out active alerts

rajagopalanand · Oct 9, 2023 · 4d7141f · 4d7141f
1 parent ea3ad74
commit 4d7141f
Show file tree

Hide file tree

Showing 2 changed files with 279 additions and 26 deletions.
diff --git a/web/api/v1/api.go b/web/api/v1/api.go
@@ -1373,6 +1373,18 @@ func (api *API) rules(r *http.Request) apiFuncResult {
 	returnAlerts := typ == "" || typ == "alert"
 	returnRecording := typ == "" || typ == "record"
 
+	excludeAlertsParam := strings.ToLower(r.URL.Query().Get("exclude_active_alerts"))
+
+	if excludeAlertsParam == "" {
+		excludeAlertsParam = "false"
+	}
+
+	excludeAlerts, err := strconv.ParseBool(excludeAlertsParam)
+
+	if err != nil {
+		excludeAlerts = false
+	}
+
 	rgs := make([]*RuleGroup, 0, len(ruleGroups))
 	for _, grp := range ruleGroups {
 		if len(rgSet) > 0 {
@@ -1414,6 +1426,12 @@ func (api *API) rules(r *http.Request) apiFuncResult {
 				if !returnAlerts {
 					break
 				}
+				var activeAlerts []*Alert
+				if excludeAlerts {
+					activeAlerts = []*Alert{}
+				} else {
+					activeAlerts = rulesAlertsToAPIAlerts(rule.ActiveAlerts())
+				}
 				enrichedRule = AlertingRule{
 					State:          rule.State().String(),
 					Name:           rule.Name(),
@@ -1422,7 +1440,7 @@ func (api *API) rules(r *http.Request) apiFuncResult {
 					KeepFiringFor:  rule.KeepFiringFor().Seconds(),
 					Labels:         rule.Labels(),
 					Annotations:    rule.Annotations(),
-					Alerts:         rulesAlertsToAPIAlerts(rule.ActiveAlerts()),
+					Alerts:         activeAlerts,
 					Health:         rule.Health(),
 					LastError:      lastError,
 					EvaluationTime: rule.GetEvaluationDuration().Seconds(),