feat: add the ability to configure partialResponseStrategy

Signed-off-by: Zach Robinson <[email protected]>

Author: zach-robinson-dev

jsonnet/controller-gen/pyrra.dev_servicelevelobjectives.json

@@ -232,6 +232,16 @@
                     },
                     "type": "object"
                   },
+                  "partial_response_strategy": {
+                    "default": "abort",
+                    "description": "PartialResponseStrategy is only used by ThanosRuler and will\nbe ignored by Prometheus instances.\nMore info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response",
+                    "enum": [
+                      "abort",
+                      "warn",
+                      ""
+                    ],
+                    "type": "string"
+                  },
                   "target": {
                     "description": "Target is a string that's casted to a float64 between 0 - 100.\nIt represents the desired availability of the service in the given window.\nfloat64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245",
                     "type": "string"

kubernetes/api/v1alpha1/servicelevelobjective_types.go

@@ -90,6 +90,14 @@ type ServiceLevelObjectiveSpec struct {
 	// +optional
 	// Alerting customizes the alerting rules generated by Pyrra.
 	Alerting Alerting `json:"alerting"`
+
+	// +optional
+	// +kubebuilder:validation:Enum:=abort;warn;""
+	// +kubebuilder:default:=abort
+	// PartialResponseStrategy is only used by ThanosRuler and will
+	// be ignored by Prometheus instances.
+	// More info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response
+	PartialResponseStrategy string `json:"partial_response_strategy,omitempty"`
 }
 
 // ServiceLevelIndicator defines the underlying indicator that is a Prometheus metric.

kubernetes/controllers/servicelevelobjective.go

@@ -250,6 +250,10 @@ func makeConfigMap(name string, kubeObjective pyrrav1alpha1.ServiceLevelObjectiv
 		}
 	}
 
+	for i := range rule.Groups {
+		rule.Groups[i].PartialResponseStrategy = kubeObjective.Spec.PartialResponseStrategy
+	}
+
 	bytes, err := yaml.Marshal(rule)
 	if err != nil {
 		return nil, fmt.Errorf("failed to marshal recording rule: %w", err)
@@ -406,6 +410,10 @@ func makePrometheusRule(kubeObjective pyrrav1alpha1.ServiceLevelObjective, gener
 		}
 	}
 
+	for i := range rule.Groups {
+		rule.Groups[i].PartialResponseStrategy = kubeObjective.Spec.PartialResponseStrategy
+	}
+
 	isController := true
 	return &monitoringv1.PrometheusRule{
 		TypeMeta: metav1.TypeMeta{

kubernetes/controllers/servicelevelobjective_test.go

@@ -47,6 +47,7 @@ var (
 					},
 				},
 			},
+			PartialResponseStrategy: "warn",
 		},
 	}
 )
@@ -84,8 +85,9 @@ func Test_makePrometheusRule(t *testing.T) {
 				Spec: monitoringv1.PrometheusRuleSpec{
 					Groups: []monitoringv1.RuleGroup{
 						{
-							Name:     "http-increase",
-							Interval: monitoringDuration("2m30s"),
+							Name:                    "http-increase",
+							PartialResponseStrategy: "warn",
+							Interval:                monitoringDuration("2m30s"),
 							Rules: []monitoringv1.Rule{
 								{
 									Record: "http_requests:increase4w",
@@ -113,8 +115,9 @@ func Test_makePrometheusRule(t *testing.T) {
 							},
 						},
 						{
-							Name:     "http",
-							Interval: monitoringDuration("30s"),
+							Name:                    "http",
+							PartialResponseStrategy: "warn",
+							Interval:                monitoringDuration("30s"),
 							Rules: []monitoringv1.Rule{
 								{
 									Record: "http_requests:burnrate5m",
@@ -199,6 +202,7 @@ func Test_makeConfigMap(t *testing.T) {
 	rules := `groups:
 - interval: 2m30s
   name: http-increase
+  partial_response_strategy: warn
   rules:
   - expr: sum by (status) (increase(http_requests_total{job="app"}[4w]))
     labels:
@@ -218,6 +222,7 @@ func Test_makeConfigMap(t *testing.T) {
       team: foo
 - interval: 30s
   name: http
+  partial_response_strategy: warn
   rules:
   - expr: sum(rate(http_requests_total{job="app",status=~"5.."}[5m])) / sum(rate(http_requests_total{job="app"}[5m]))
     labels: