Adding support to filter rules

Signed-off-by: Anand Rajagopal <anrajag@amazon.com>

Author: rajagopalanand

CHANGELOG.md

@@ -32,6 +32,7 @@
 * [ENHANCEMENT] Store Gateway: Add new metrics `cortex_bucket_store_sent_chunk_size_bytes`, `cortex_bucket_store_postings_size_bytes` and `cortex_bucket_store_empty_postings_total`. #5397
 * [ENHANCEMENT] Add jitter to lifecycler heartbeat. #5404
 * [ENHANCEMENT] Store Gateway: Add config `estimated_max_series_size_bytes` and `estimated_max_chunk_size_bytes` to address data overfetch. #5401
+* [ENHANCEMENT] Ruler: Support for filtering rules. #5417
 * [BUGFIX] Ruler: Validate if rule group can be safely converted back to rule group yaml from protobuf message #5265
 * [BUGFIX] Querier: Convert gRPC `ResourceExhausted` status code from store gateway to 422 limit error. #5286
 * [BUGFIX] Alertmanager: Route web-ui requests to the alertmanager distributor when sharding is enabled. #5293

docs/contributing/how-integration-tests-work.md

@@ -20,13 +20,13 @@ This will locally build the `quay.io/cortexproject/cortex:latest` image used by
 Once the Docker image is built, you can run integration tests:
 
 ```
-go test -v -tags=requires_docker ./integration/...
+go test -v -tags=integration,requires_docker,integration_alertmanager,integration_memberlist,integration_querier,integration_ruler,integration_query_fuzz ./integration/...
 ```
 
-If you want to run a single test you can use a filter. For example, to only run `TestChunksStorageAllIndexBackends`:
+If you want to run a single test you can use a filter. For example, to only run `TestRulerMetricsWhenIngesterFails`:
 
 ```
-go test -v -tags=requires_docker ./integration -run "^TestChunksStorageAllIndexBackends$"
+go test -v -tags=integration,requires_docker,integration_ruler ./integration/ -run "^TestRulerMetricsWhenIngesterFails$" -count=1
 ```
 
 ### Supported environment variables

pkg/ruler/api.go

@@ -284,7 +284,7 @@ func (a *API) PrometheusAlerts(w http.ResponseWriter, req *http.Request) {
 
 	w.Header().Set("Content-Type", "application/json")
 	rulesRequest := RulesRequest{
-		//Type: AlertingRuleFilter,
+		Type: AlertingRuleFilter,
 	}
 	rgs, err := a.ruler.GetRules(req.Context(), rulesRequest)
 

pkg/ruler/ruler.go

@@ -726,7 +726,7 @@ func (r *Ruler) getLocalRules(userID string, rulesRequest RulesRequest) ([]*Grou
 			switch rule := r.(type) {
 			case *promRules.AlertingRule:
 				if !returnAlerts {
-					break
+					continue
 				}
 				alerts := []*AlertStateDesc{}
 				for _, a := range rule.ActiveAlerts() {
@@ -760,7 +760,7 @@ func (r *Ruler) getLocalRules(userID string, rulesRequest RulesRequest) ([]*Grou
 				}
 			case *promRules.RecordingRule:
 				if !returnRecording {
-					break
+					continue
 				}
 				ruleDesc = &RuleStateDesc{
 					Rule: &rulespb.RuleDesc{
@@ -776,9 +776,7 @@ func (r *Ruler) getLocalRules(userID string, rulesRequest RulesRequest) ([]*Grou
 			default:
 				return nil, errors.Errorf("failed to assert type of rule '%v'", rule.Name())
 			}
-			if ruleDesc != nil {
-				groupDesc.ActiveRules = append(groupDesc.ActiveRules, ruleDesc)
-			}
+			groupDesc.ActiveRules = append(groupDesc.ActiveRules, ruleDesc)
 		}
 		if len(groupDesc.ActiveRules) > 0 {
 			groupDescs = append(groupDescs, groupDesc)

pkg/ruler/ruler_test.go

@@ -325,7 +325,6 @@ func compareRuleGroupDescToStateDesc(t *testing.T, expected *rulespb.RuleGroupDe
 func TestGetRules(t *testing.T) {
 	// ruler ID -> (user ID -> list of groups).
 	type expectedRulesMap map[string]map[string]rulespb.RuleGroupList
-	type ruleExecutionMap map[string]map[string]rulespb.RuleGroupList
 	type rulesMap map[string][]*rulespb.RuleDesc
 
 	type testCase struct {
@@ -486,6 +485,33 @@ func TestGetRules(t *testing.T) {
 				"user3": 1,
 			},
 		},
+		"Shuffle Sharding and ShardSize = 2 and Rule Group Name Filter": {
+			sharding:         true,
+			shuffleShardSize: 2,
+			shardingStrategy: util.ShardingStrategyShuffle,
+			rulesRequest: RulesRequest{
+				RuleGroupNames: []string{"third"},
+			},
+			expectedCount: map[string]int{
+				"user1": 2,
+				"user2": 1,
+				"user3": 2,
+			},
+		},
+		"Shuffle Sharding and ShardSize = 2 and Rule Group Name and Rule Type Filter": {
+			sharding:         true,
+			shuffleShardSize: 2,
+			shardingStrategy: util.ShardingStrategyShuffle,
+			rulesRequest: RulesRequest{
+				RuleGroupNames: []string{"second", "third"},
+				Type:           RecordingRuleFilter,
+			},
+			expectedCount: map[string]int{
+				"user1": 2,
+				"user2": 2,
+				"user3": 1,
+			},
+		},
 	}
 
 	for name, tc := range testCases {