feat(GrafanaAlertRuleGroup): add support for Grafana-managed recording rules

api/v1beta1/grafanaalertrulegroup_types.go

@@ -81,6 +81,8 @@ type AlertRule struct {
 	// +kubebuilder:validation:Enum=Alerting;NoData;OK;KeepLast
 	NoDataState *string `json:"noDataState"`
 
+	Record *Record `json:"record,omitempty"`
+
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=190
 	// +kubebuilder:example="Always firing"
@@ -101,6 +103,14 @@ type NotificationSettings struct {
 	RepeatInterval    string   `json:"repeat_interval,omitempty"`
 }
 
+type Record struct {
+	// +kubebuilder:validation:Required
+	From string `json:"from"`
+
+	// +kubebuilder:validation:Required
+	Metric string `json:"metric"`
+}
+
 type AlertQuery struct {
 	// Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation.
 	DatasourceUID string `json:"datasourceUid,omitempty"`

config/crd/bases/grafana.integreatly.org_grafanaalertrulegroups.yaml

@@ -225,6 +225,16 @@ spec:
                       required:
                       - receiver
                       type: object
+                    record:
+                      properties:
+                        from:
+                          type: string
+                        metric:
+                          type: string
+                      required:
+                      - from
+                      - metric
+                      type: object
                     title:
                       example: Always firing
                       maxLength: 190

controllers/grafanaalertrulegroup_controller.go

@@ -209,6 +209,12 @@ func (r *GrafanaAlertRuleGroupReconciler) reconcileWithInstance(ctx context.Cont
 				RepeatInterval: rule.NotificationSettings.RepeatInterval,
 			}
 		}
+		if rule.Record != nil {
+			apiRule.Record = &models.Record{
+				From:   &rule.Record.From,
+				Metric: &rule.Record.Metric,
+			}
+		}
 		for idx, q := range rule.Data {
 			apiRule.Data[idx] = &models.AlertQuery{
 				DatasourceUID:     q.DatasourceUID,

deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanaalertrulegroups.yaml

@@ -225,6 +225,16 @@ spec:
                       required:
                       - receiver
                       type: object
+                    record:
+                      properties:
+                        from:
+                          type: string
+                        metric:
+                          type: string
+                      required:
+                      - from
+                      - metric
+                      type: object
                     title:
                       example: Always firing
                       maxLength: 190

deploy/kustomize/base/crds.yaml

@@ -224,6 +224,16 @@ spec:
                       required:
                       - receiver
                       type: object
+                    record:
+                      properties:
+                        from:
+                          type: string
+                        metric:
+                          type: string
+                      required:
+                      - from
+                      - metric
+                      type: object
                     title:
                       example: Always firing
                       maxLength: 190

docs/docs/api.md

@@ -368,6 +368,13 @@ AlertRule defines a specific rule to be evaluated. It is based on the upstream m
           <br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b><a href="#grafanaalertrulegroupspecrulesindexrecord">record</a></b></td>
+        <td>object</td>
+        <td>
+          <br/>
+        </td>
+        <td>false</td>
       </tr></tbody>
 </table>
 
@@ -528,6 +535,40 @@ relative time range
 </table>
 
 
+### GrafanaAlertRuleGroup.spec.rules[index].record
+<sup><sup>[↩ Parent](#grafanaalertrulegroupspecrulesindex)</sup></sup>
+
+
+
+
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+            <th>Required</th>
+        </tr>
+    </thead>
+    <tbody><tr>
+        <td><b>from</b></td>
+        <td>string</td>
+        <td>
+          <br/>
+        </td>
+        <td>true</td>
+      </tr><tr>
+        <td><b>metric</b></td>
+        <td>string</td>
+        <td>
+          <br/>
+        </td>
+        <td>true</td>
+      </tr></tbody>
+</table>
+
+
 ### GrafanaAlertRuleGroup.status
 <sup><sup>[↩ Parent](#grafanaalertrulegroup)</sup></sup>
 

examples/alertrulegroups/resources.yaml

@@ -15,6 +15,14 @@ spec:
       admin_user: root
       admin_password: secret
 
+    ## Below, we enable Grafana-managed recording rules, which is an opt-in feature used in the GrafanaAlertRuleGroup below
+    feature_toggles:
+      # Disabled in OSS / Enterprise Grafana by default
+      grafanaManagedRecordingRules: "true"
+    recording_rules:
+      enabled: "true"
+      url: http://prometheus:9090/api/prom/push
+
     ## Starting from Grafana 11.3.0, it is possible to enforce
     ## a limit on how many alert rule versions should be stored
     ## in a database (including the current version of the rule).
@@ -94,3 +102,8 @@ spec:
       noDataState: NoData
       title: Temperature below zero
       uid: 4843de5c-4f8a-4af0-9509-23526a04faf8
+
+      ## Grafana-managed recording rule (opt-in feature)
+      record:
+        from: A
+        metric: "weather:temperature:celsius"

tests/e2e/example-test/00-create-grafana.yaml

@@ -15,3 +15,9 @@ spec:
     security:
       admin_user: root
       admin_password: secret
+    ## Required to test creation of Grafana-managed recording rules
+    feature_toggles:
+      grafanaManagedRecordingRules: "true"
+    recording_rules:
+      enabled: "true"
+      url: http://prometheus:9090/api/prom/push

tests/e2e/example-test/08-alert-rule-group.yaml

@@ -25,8 +25,8 @@ spec:
         - datasourceUid: grafanacloud-demoinfra-prom
           model:
             datasource:
-                type: prometheus
-                uid: grafanacloud-demoinfra-prom
+              type: prometheus
+              uid: grafanacloud-demoinfra-prom
             editorMode: code
             expr: weather_temp_c{location="Toronto"}
             instant: true
@@ -41,22 +41,22 @@ spec:
         - datasourceUid: __expr__
           model:
             conditions:
-                - evaluator:
-                    params:
-                        - 10
-                    type: gt
-                  operator:
-                    type: and
-                  query:
-                    params:
-                        - C
-                  reducer:
-                    params: []
-                    type: last
-                  type: query
+              - evaluator:
+                  params:
+                    - 10
+                  type: gt
+                operator:
+                  type: and
+                query:
+                  params:
+                    - C
+                reducer:
+                  params: []
+                  type: last
+                type: query
             datasource:
-                type: __expr__
-                uid: __expr__
+              type: __expr__
+              uid: __expr__
             expression: A
             intervalMs: 1000
             maxDataPoints: 43200
@@ -70,3 +70,7 @@ spec:
       noDataState: NoData
       title: test rule from operator updated
       uid: 4843de5c-4f8a-4af0-9509-23526a04faf8
+      ## Grafana-managed recording rule, which is an opt-in feature that must be first enabled and configured in a Grafana instance
+      record:
+        from: A
+        metric: "weather:temperature:celsius"