Alerting: Add MissingSeriesEvalsToResolve to the APIs (#102150)

What is this feature? A follow-up for #101184, adds AlertRule.MissingSeriesEvalsToResolve to the APIs. missing_series_evals_to_resolve must be specified too and it must be > 0. POST /api/ruler/grafana/api/v1/rules/{folderUID} works in the following way: If missing_series_evals_to_resolve is not sent or null, the rule keeps its existing value If missing_series_evals_to_resolve > 0: updates to that value If missing_series_evals_to_resolve = 0: resets to default (nil). AlertRule.MissingSeriesEvalsToResolve can't be 0, so I used it to reset In the Provisioning API, the value is just set if present and > 0. Otherwise it's reset: PUT to /api/v1/provisioning/alert-rules/{UID}: If missing_series_evals_to_resolve is nil, it's reset to the default value If missing_series_evals_to_resolve > 0, it's updated
2025-03-26 13:34:53 +01:00
parent f2fc1d8575
commit f49a88ab72
17 changed files with 462 additions and 116 deletions
@@ -17,24 +17,25 @@ import (
 // AlertRuleFromProvisionedAlertRule converts definitions.ProvisionedAlertRule to models.AlertRule
 func AlertRuleFromProvisionedAlertRule(a definitions.ProvisionedAlertRule) (models.AlertRule, error) {
 	rule := models.AlertRule{
-		ID:                   a.ID,
-		UID:                  a.UID,
-		OrgID:                a.OrgID,
-		NamespaceUID:         a.FolderUID,
-		RuleGroup:            a.RuleGroup,
-		Title:                a.Title,
-		Condition:            a.Condition,
-		Data:                 AlertQueriesFromApiAlertQueries(a.Data),
-		Updated:              a.Updated,
-		NoDataState:          models.NoDataState(a.NoDataState),          // TODO there must be a validation
-		ExecErrState:         models.ExecutionErrorState(a.ExecErrState), // TODO there must be a validation
-		For:                  time.Duration(a.For),
-		KeepFiringFor:        time.Duration(a.KeepFiringFor),
-		Annotations:          a.Annotations,
-		Labels:               a.Labels,
-		IsPaused:             a.IsPaused,
-		NotificationSettings: NotificationSettingsFromAlertRuleNotificationSettings(a.NotificationSettings),
-		Record:               ModelRecordFromApiRecord(a.Record),
+		ID:                          a.ID,
+		UID:                         a.UID,
+		OrgID:                       a.OrgID,
+		NamespaceUID:                a.FolderUID,
+		RuleGroup:                   a.RuleGroup,
+		Title:                       a.Title,
+		Condition:                   a.Condition,
+		Data:                        AlertQueriesFromApiAlertQueries(a.Data),
+		Updated:                     a.Updated,
+		NoDataState:                 models.NoDataState(a.NoDataState),          // TODO there must be a validation
+		ExecErrState:                models.ExecutionErrorState(a.ExecErrState), // TODO there must be a validation
+		For:                         time.Duration(a.For),
+		KeepFiringFor:               time.Duration(a.KeepFiringFor),
+		Annotations:                 a.Annotations,
+		Labels:                      a.Labels,
+		IsPaused:                    a.IsPaused,
+		NotificationSettings:        NotificationSettingsFromAlertRuleNotificationSettings(a.NotificationSettings),
+		Record:                      ModelRecordFromApiRecord(a.Record),
+		MissingSeriesEvalsToResolve: a.MissingSeriesEvalsToResolve,
 	}

 	if rule.Type() == models.RuleTypeRecording {
@@ -47,25 +48,26 @@ func AlertRuleFromProvisionedAlertRule(a definitions.ProvisionedAlertRule) (mode
 // ProvisionedAlertRuleFromAlertRule converts models.AlertRule to definitions.ProvisionedAlertRule and sets provided provenance status
 func ProvisionedAlertRuleFromAlertRule(rule models.AlertRule, provenance models.Provenance) definitions.ProvisionedAlertRule {
 	return definitions.ProvisionedAlertRule{
-		ID:                   rule.ID,
-		UID:                  rule.UID,
-		OrgID:                rule.OrgID,
-		FolderUID:            rule.NamespaceUID,
-		RuleGroup:            rule.RuleGroup,
-		Title:                rule.Title,
-		For:                  model.Duration(rule.For),
-		KeepFiringFor:        model.Duration(rule.KeepFiringFor),
-		Condition:            rule.Condition,
-		Data:                 ApiAlertQueriesFromAlertQueries(rule.Data),
-		Updated:              rule.Updated,
-		NoDataState:          definitions.NoDataState(rule.NoDataState),          // TODO there may be a validation
-		ExecErrState:         definitions.ExecutionErrorState(rule.ExecErrState), // TODO there may be a validation
-		Annotations:          rule.Annotations,
-		Labels:               rule.Labels,
-		Provenance:           definitions.Provenance(provenance), // TODO validate enum conversion?
-		IsPaused:             rule.IsPaused,
-		NotificationSettings: AlertRuleNotificationSettingsFromNotificationSettings(rule.NotificationSettings),
-		Record:               ApiRecordFromModelRecord(rule.Record),
+		ID:                          rule.ID,
+		UID:                         rule.UID,
+		OrgID:                       rule.OrgID,
+		FolderUID:                   rule.NamespaceUID,
+		RuleGroup:                   rule.RuleGroup,
+		Title:                       rule.Title,
+		For:                         model.Duration(rule.For),
+		KeepFiringFor:               model.Duration(rule.KeepFiringFor),
+		Condition:                   rule.Condition,
+		Data:                        ApiAlertQueriesFromAlertQueries(rule.Data),
+		Updated:                     rule.Updated,
+		NoDataState:                 definitions.NoDataState(rule.NoDataState),          // TODO there may be a validation
+		ExecErrState:                definitions.ExecutionErrorState(rule.ExecErrState), // TODO there may be a validation
+		Annotations:                 rule.Annotations,
+		Labels:                      rule.Labels,
+		Provenance:                  definitions.Provenance(provenance), // TODO validate enum conversion?
+		IsPaused:                    rule.IsPaused,
+		NotificationSettings:        AlertRuleNotificationSettingsFromNotificationSettings(rule.NotificationSettings),
+		Record:                      ApiRecordFromModelRecord(rule.Record),
+		MissingSeriesEvalsToResolve: rule.MissingSeriesEvalsToResolve,
 	}
 }

@@ -205,19 +207,20 @@ func AlertRuleExportFromAlertRule(rule models.AlertRule) (definitions.AlertRuleE
 	}

 	result := definitions.AlertRuleExport{
-		UID:                  rule.UID,
-		Title:                rule.Title,
-		For:                  model.Duration(rule.For),
-		KeepFiringFor:        model.Duration(rule.KeepFiringFor),
-		Condition:            cPtr,
-		Data:                 data,
-		DashboardUID:         rule.DashboardUID,
-		PanelID:              rule.PanelID,
-		NoDataState:          ndsPtr,
-		ExecErrState:         eesPtr,
-		IsPaused:             rule.IsPaused,
-		NotificationSettings: AlertRuleNotificationSettingsExportFromNotificationSettings(rule.NotificationSettings),
-		Record:               AlertRuleRecordExportFromRecord(rule.Record),
+		UID:                         rule.UID,
+		Title:                       rule.Title,
+		For:                         model.Duration(rule.For),
+		KeepFiringFor:               model.Duration(rule.KeepFiringFor),
+		Condition:                   cPtr,
+		Data:                        data,
+		DashboardUID:                rule.DashboardUID,
+		PanelID:                     rule.PanelID,
+		NoDataState:                 ndsPtr,
+		ExecErrState:                eesPtr,
+		IsPaused:                    rule.IsPaused,
+		NotificationSettings:        AlertRuleNotificationSettingsExportFromNotificationSettings(rule.NotificationSettings),
+		Record:                      AlertRuleRecordExportFromRecord(rule.Record),
+		MissingSeriesEvalsToResolve: rule.MissingSeriesEvalsToResolve,
 	}
 	if rule.For.Seconds() > 0 {
 		result.ForString = util.Pointer(model.Duration(rule.For).String())
@@ -231,6 +234,7 @@ func AlertRuleExportFromAlertRule(rule models.AlertRule) (definitions.AlertRuleE
 	if rule.Labels != nil {
 		result.Labels = &rule.Labels
 	}
+
 	return result, nil
 }