mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 17:42:35 +08:00

What is this feature? This PR introduces a new alert rule configuration option, keep_firing_for (Prometheus documentation). keep_firing_for prevents alerts from resolving immediately after the alert condition returns to normal. Instead, they transition into a "Recovering" state and are not considered resolved by the Alertmanager. Once the recovery period ends (or after the next evaluation if it is bigger than keep_firing_for), the alert transitions to "Normal" if it doesn't start alerting again: Before +----------+ +----------+ | Alerting |---->| Normal | +----------+ +----------+ ----- After +----------+ +------------+ +----------+ | Alerting |----->| Recovering |---->| Normal | +----------+ +------------+ +----------+ Why do we need this feature? This feature prevents flapping alerts by adding a recovery period. This helps avoid false resolutions caused by brief alert
182 lines
5.0 KiB
Go
182 lines
5.0 KiB
Go
package api
|
|
|
|
import (
|
|
"testing"
|
|
"time"
|
|
|
|
prommodel "github.com/prometheus/common/model"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
|
|
"github.com/grafana/grafana/pkg/services/ngalert/models"
|
|
)
|
|
|
|
func TestToModel(t *testing.T) {
|
|
t.Run("if no rules are provided the rule field should be nil", func(t *testing.T) {
|
|
ruleGroup := definitions.AlertRuleGroup{
|
|
Title: "123",
|
|
FolderUID: "123",
|
|
Interval: 10,
|
|
}
|
|
tm, err := AlertRuleGroupFromApiAlertRuleGroup(ruleGroup)
|
|
require.NoError(t, err)
|
|
require.Nil(t, tm.Rules)
|
|
})
|
|
t.Run("if rules are provided the rule field should be not nil", func(t *testing.T) {
|
|
ruleGroup := definitions.AlertRuleGroup{
|
|
Title: "123",
|
|
FolderUID: "123",
|
|
Interval: 10,
|
|
Rules: []definitions.ProvisionedAlertRule{
|
|
{
|
|
UID: "1",
|
|
},
|
|
},
|
|
}
|
|
tm, err := AlertRuleGroupFromApiAlertRuleGroup(ruleGroup)
|
|
require.NoError(t, err)
|
|
require.Len(t, tm.Rules, 1)
|
|
})
|
|
t.Run("should clear recording rule ignored fields correctly", func(t *testing.T) {
|
|
ruleGroup := definitions.AlertRuleGroup{
|
|
Title: "123",
|
|
FolderUID: "123",
|
|
Interval: 10,
|
|
Rules: []definitions.ProvisionedAlertRule{
|
|
{
|
|
UID: "1",
|
|
Condition: "A",
|
|
ExecErrState: definitions.ErrorErrState,
|
|
NoDataState: definitions.NoData,
|
|
For: 10,
|
|
KeepFiringFor: 20,
|
|
NotificationSettings: &definitions.AlertRuleNotificationSettings{
|
|
Receiver: "receiver",
|
|
},
|
|
Record: &definitions.Record{
|
|
Metric: "metric",
|
|
From: "A",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
tm, err := AlertRuleGroupFromApiAlertRuleGroup(ruleGroup)
|
|
require.NoError(t, err)
|
|
require.Len(t, tm.Rules, 1)
|
|
rule := tm.Rules[0]
|
|
require.Empty(t, rule.NoDataState)
|
|
require.Empty(t, rule.For)
|
|
require.Empty(t, rule.KeepFiringFor)
|
|
require.Empty(t, rule.Condition)
|
|
require.Empty(t, rule.ExecErrState)
|
|
require.Nil(t, rule.NotificationSettings)
|
|
})
|
|
|
|
t.Run("should copy the fields correctly", func(t *testing.T) {
|
|
ruleGroup := definitions.AlertRuleGroup{
|
|
Title: "123",
|
|
FolderUID: "456",
|
|
Interval: int64(10),
|
|
Rules: []definitions.ProvisionedAlertRule{
|
|
{
|
|
UID: "1",
|
|
For: prommodel.Duration(5 * time.Second),
|
|
KeepFiringFor: prommodel.Duration(15 * time.Second),
|
|
},
|
|
},
|
|
}
|
|
|
|
tm, err := AlertRuleGroupFromApiAlertRuleGroup(ruleGroup)
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, "123", tm.Title)
|
|
require.Equal(t, "456", tm.FolderUID)
|
|
require.Equal(t, int64(10), tm.Interval)
|
|
require.Len(t, tm.Rules, 1)
|
|
require.Equal(t, "1", tm.Rules[0].UID)
|
|
require.Equal(t, time.Second*5, tm.Rules[0].For)
|
|
require.Equal(t, time.Second*15, tm.Rules[0].KeepFiringFor)
|
|
})
|
|
|
|
t.Run("should handle empty keep firing for", func(t *testing.T) {
|
|
ruleGroup := definitions.AlertRuleGroup{
|
|
Title: "123",
|
|
FolderUID: "456",
|
|
Interval: int64(10),
|
|
Rules: []definitions.ProvisionedAlertRule{
|
|
{
|
|
UID: "1",
|
|
},
|
|
},
|
|
}
|
|
tm, err := AlertRuleGroupFromApiAlertRuleGroup(ruleGroup)
|
|
require.NoError(t, err)
|
|
require.Equal(t, time.Duration(0), tm.Rules[0].KeepFiringFor)
|
|
})
|
|
}
|
|
|
|
func TestAlertRuleMetadataFromModelMetadata(t *testing.T) {
|
|
t.Run("should convert model metadata to api metadata", func(t *testing.T) {
|
|
modelMetadata := models.AlertRuleMetadata{
|
|
EditorSettings: models.EditorSettings{
|
|
SimplifiedQueryAndExpressionsSection: true,
|
|
SimplifiedNotificationsSection: true,
|
|
},
|
|
}
|
|
|
|
apiMetadata := AlertRuleMetadataFromModelMetadata(modelMetadata)
|
|
|
|
require.True(t, apiMetadata.EditorSettings.SimplifiedQueryAndExpressionsSection)
|
|
require.True(t, apiMetadata.EditorSettings.SimplifiedNotificationsSection)
|
|
})
|
|
}
|
|
|
|
func TestApiAlertRuleGroupFromAlertRuleGroup(t *testing.T) {
|
|
t.Run("should convert keepfiringfor duration correctly", func(t *testing.T) {
|
|
keepFiringFor := 30 * time.Second
|
|
modelGroup := models.AlertRuleGroup{
|
|
Title: "test_group",
|
|
FolderUID: "folder123",
|
|
Interval: int64(10),
|
|
Rules: []models.AlertRule{
|
|
{
|
|
UID: "rule1",
|
|
Title: "Test Rule",
|
|
For: 10 * time.Second,
|
|
KeepFiringFor: keepFiringFor,
|
|
},
|
|
},
|
|
}
|
|
|
|
apiGroup := ApiAlertRuleGroupFromAlertRuleGroup(modelGroup)
|
|
|
|
require.Equal(t, "test_group", apiGroup.Title)
|
|
require.Equal(t, "folder123", apiGroup.FolderUID)
|
|
require.Equal(t, int64(10), apiGroup.Interval)
|
|
require.Len(t, apiGroup.Rules, 1)
|
|
|
|
rule := apiGroup.Rules[0]
|
|
require.Equal(t, "rule1", rule.UID)
|
|
require.Equal(t, prommodel.Duration(keepFiringFor), rule.KeepFiringFor)
|
|
})
|
|
|
|
t.Run("handles empty keep_firing_for", func(t *testing.T) {
|
|
modelGroup := models.AlertRuleGroup{
|
|
Title: "test_group",
|
|
FolderUID: "folder123",
|
|
Interval: int64(10),
|
|
Rules: []models.AlertRule{
|
|
{
|
|
UID: "rule1",
|
|
Title: "Test Rule",
|
|
For: 10 * time.Second,
|
|
},
|
|
},
|
|
}
|
|
|
|
apiGroup := ApiAlertRuleGroupFromAlertRuleGroup(modelGroup)
|
|
require.Len(t, apiGroup.Rules, 1)
|
|
require.Equal(t, prommodel.Duration(0), apiGroup.Rules[0].KeepFiringFor)
|
|
})
|
|
}
|