Support exclude_alerts parameter in Prometheus list rules endpoint

grafana · Sep 14, 2024 · 873ad49 · 873ad49
1 parent 85904a2
commit 873ad49
Show file tree

Hide file tree

Showing 7 changed files with 323 additions and 85 deletions.
diff --git a/docs/sources/mimir/references/http-api/index.md b/docs/sources/mimir/references/http-api/index.md
@@ -815,7 +815,7 @@ List all tenant rules. This endpoint is not part of ruler-API and is always avai
 ### List Prometheus rules
 
 ```
-GET <prometheus-http-prefix>/api/v1/rules?type={alert|record}&file={}&rule_group={}&rule_name={}
+GET <prometheus-http-prefix>/api/v1/rules?type={alert|record}&file={}&rule_group={}&rule_name={}&exclude_alerts={}
 ```
 
 Prometheus-compatible rules endpoint to list alerting and recording rules that are currently loaded.
@@ -824,6 +824,8 @@ The `type` parameter is optional. If set, only the specified type of rule is ret
 
 The `file`, `rule_group` and `rule_name` parameters are optional, and can accept multiple values. If set, the response content is filtered accordingly.
 
+The `exclude_alerts` parameter is optional. If set, only rules are returned, active alerts are excluded.
+
 For more information, refer to Prometheus [rules](https://prometheus.io/docs/prometheus/latest/querying/api/#rules).
 
 Requires [authentication](#authentication).

diff --git a/pkg/ruler/api.go b/pkg/ruler/api.go
@@ -166,11 +166,18 @@ func (a *API) PrometheusRules(w http.ResponseWriter, req *http.Request) {
 		return
 	}
 
+	excludeAlerts, err := parseExcludeAlerts(req)
+	if err != nil {
+		respondInvalidRequest(logger, w, "invalid exclude_alerts parameter")
+		return
+	}
+
 	rulesReq := RulesRequest{
-		Filter:    AnyRule,
-		RuleName:  req.URL.Query()["rule_name"],
-		RuleGroup: req.URL.Query()["rule_group"],
-		File:      req.URL.Query()["file"],
+		Filter:        AnyRule,
+		RuleName:      req.URL.Query()["rule_name"],
+		RuleGroup:     req.URL.Query()["rule_group"],
+		File:          req.URL.Query()["file"],
+		ExcludeAlerts: excludeAlerts,
 	}
 
 	ruleTypeFilter := strings.ToLower(req.URL.Query().Get("type"))
@@ -209,9 +216,12 @@ func (a *API) PrometheusRules(w http.ResponseWriter, req *http.Request) {
 
 		for i, rl := range g.ActiveRules {
 			if g.ActiveRules[i].Rule.Alert != "" {
-				alerts := make([]*Alert, 0, len(rl.Alerts))
-				for _, a := range rl.Alerts {
-					alerts = append(alerts, alertStateDescToPrometheusAlert(a))
+				var alerts []*Alert
+				if !excludeAlerts {
+					alerts = make([]*Alert, 0, len(rl.Alerts))
+					for _, a := range rl.Alerts {
+						alerts = append(alerts, alertStateDescToPrometheusAlert(a))
+					}
 				}
 				grp.Rules[i] = alertingRule{
 					State:          rl.GetState(),
@@ -265,6 +275,21 @@ func (a *API) PrometheusRules(w http.ResponseWriter, req *http.Request) {
 	}
 }
 
+func parseExcludeAlerts(req *http.Request) (bool, error) {
+	excludeAlerts := req.URL.Query().Get("exclude_alerts")
+	if excludeAlerts == "" {
+		return false, nil
+	}
+
+	value, err := strconv.ParseBool(excludeAlerts)
+	if err != nil {
+		return false, fmt.Errorf("unable to pase exclude_alerts value %w", err)
+	}
+
+	return value, nil
+
+}
+
 func (a *API) PrometheusAlerts(w http.ResponseWriter, req *http.Request) {
 	logger, ctx := spanlogger.NewWithLogger(req.Context(), a.logger, "API.PrometheusAlerts")
 	defer logger.Finish()

diff --git a/pkg/ruler/api_test.go b/pkg/ruler/api_test.go
@@ -542,6 +542,77 @@ func TestRuler_PrometheusRules(t *testing.T) {
 				},
 			},
 		},
+		"API request with exclude_alerts=true returns alerting rules without alerts": {
+			configuredRules: rulespb.RuleGroupList{
+				&rulespb.RuleGroupDesc{
+					Name:      "group1",
+					Namespace: "namespace1",
+					User:      userID,
+					Rules:     []*rulespb.RuleDesc{createAlertingRule("UP_ALERT", "up < 1")},
+					Interval:  interval,
+				},
+			},
+			expectedConfigured: 1,
+			queryParams:        "?exclude_alerts=true",
+			limits:             validation.MockDefaultOverrides(),
+			expectedRules: []*RuleGroup{
+				{
+					Name: "group1",
+					File: "namespace1",
+					Rules: []rule{
+						&alertingRule{
+							Name:   "UP_ALERT",
+							Query:  "up < 1",
+							State:  "inactive",
+							Health: "unknown",
+							Type:   "alerting",
+							Alerts: nil,
+						},
+					},
+					Interval: 60,
+				},
+			},
+		},
+		"API request with exclude_alerts=false returns alerting rules including alerts": {
+			configuredRules: rulespb.RuleGroupList{
+				&rulespb.RuleGroupDesc{
+					Name:      "group1",
+					Namespace: "namespace1",
+					User:      userID,
+					Rules:     []*rulespb.RuleDesc{createAlertingRule("UP_ALERT", "up < 1")},
+					Interval:  interval,
+				},
+			},
+			expectedConfigured: 1,
+			queryParams:        "?exclude_alerts=false",
+			limits:             validation.MockDefaultOverrides(),
+			expectedRules: []*RuleGroup{
+				{
+					Name: "group1",
+					File: "namespace1",
+					Rules: []rule{
+						&alertingRule{
+							Name:   "UP_ALERT",
+							Query:  "up < 1",
+							State:  "inactive",
+							Health: "unknown",
+							Type:   "alerting",
+							Alerts: []*Alert{},
+						},
+					},
+					Interval: 60,
+				},
+			},
+		},
+		"Invalid exlude_alerts param": {
+			configuredRules:    rulespb.RuleGroupList{},
+			expectedConfigured: 0,
+			queryParams:        "?exclude_alerts=foo",
+			limits:             validation.MockDefaultOverrides(),
+			expectedStatusCode: http.StatusBadRequest,
+			expectedErrorType:  v1.ErrBadData,
+			expectedRules:      []*RuleGroup{},
+		},
 		"Invalid type param": {
 			configuredRules:    rulespb.RuleGroupList{},
 			expectedConfigured: 0,

diff --git a/pkg/ruler/ruler.go b/pkg/ruler/ruler.go
@@ -1111,20 +1111,24 @@ func (r *Ruler) getLocalRules(ctx context.Context, userID string, req RulesReque
 					continue
 				}
 
-				alerts := []*AlertStateDesc{}
-				for _, a := range rule.ActiveAlerts() {
-					alerts = append(alerts, &AlertStateDesc{
-						State:           a.State.String(),
-						Labels:          mimirpb.FromLabelsToLabelAdapters(a.Labels),
-						Annotations:     mimirpb.FromLabelsToLabelAdapters(a.Annotations),
-						Value:           a.Value,
-						ActiveAt:        a.ActiveAt,
-						FiredAt:         a.FiredAt,
-						ResolvedAt:      a.ResolvedAt,
-						LastSentAt:      a.LastSentAt,
-						ValidUntil:      a.ValidUntil,
-						KeepFiringSince: a.KeepFiringSince,
-					})
+				var alerts []*AlertStateDesc
+				if !req.ExcludeAlerts {
+					activeAlerts := rule.ActiveAlerts()
+					alerts = make([]*AlertStateDesc, 0, len(activeAlerts))
+					for _, a := range activeAlerts {
+						alerts = append(alerts, &AlertStateDesc{
+							State:           a.State.String(),
+							Labels:          mimirpb.FromLabelsToLabelAdapters(a.Labels),
+							Annotations:     mimirpb.FromLabelsToLabelAdapters(a.Annotations),
+							Value:           a.Value,
+							ActiveAt:        a.ActiveAt,
+							FiredAt:         a.FiredAt,
+							ResolvedAt:      a.ResolvedAt,
+							LastSentAt:      a.LastSentAt,
+							ValidUntil:      a.ValidUntil,
+							KeepFiringSince: a.KeepFiringSince,
+						})
+					}
 				}
 				ruleDesc = &RuleStateDesc{
 					Rule: &rulespb.RuleDesc{