Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion observability-lib/grafana/alerts.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@

const (
RuleQueryTypeInstant RuleQueryType = "instant"

// DefaultRuleQueryInterval is the default Prometheus query interval for alert rule models.
DefaultRuleQueryInterval = "30s"

Check failure on line 18 in observability-lib/grafana/alerts.go

View workflow job for this annotation

GitHub Actions / lint-module (observability-lib)

File is not properly formatted (goimports)
defaultRuleQueryIntervalMs = 30 * 1000
)
Comment thread
cawthorne marked this conversation as resolved.

type RuleQuery struct {
Expand All @@ -23,6 +27,9 @@
TimeRange int64
Instant bool
QueryType RuleQueryType
// Interval sets the Prometheus query interval in the alert rule model (e.g. "30s").
// When empty, DefaultRuleQueryInterval is used.
Interval string
}

func newRuleQuery(query RuleQuery) *alerting.QueryBuilder {
Expand Down Expand Up @@ -51,6 +58,12 @@
model.QueryType(string(query.QueryType))
}

interval := query.Interval
if interval == "" {
interval = DefaultRuleQueryInterval
}
model.Interval(interval)

return res.Model(model)
}

Expand Down Expand Up @@ -125,7 +138,7 @@
func newConditionQuery(options ConditionQuery) *alerting.QueryBuilder {
if options.IntervalMs == nil {
// Recommended value for intervalMs is 30s
options.IntervalMs = Pointer[float64](30 * 1000)
options.IntervalMs = Pointer[float64](defaultRuleQueryIntervalMs)
}

if options.MaxDataPoints == nil {
Expand Down
18 changes: 18 additions & 0 deletions observability-lib/grafana/builder_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (

"github.com/grafana/grafana-foundation-sdk/go/alerting"
"github.com/grafana/grafana-foundation-sdk/go/expr"
"github.com/grafana/grafana-foundation-sdk/go/prometheus"
"github.com/stretchr/testify/require"

"github.com/grafana/grafana-foundation-sdk/go/dashboard"
Expand Down Expand Up @@ -546,3 +547,20 @@ func TestBuilder_AddTimeSeriesPanelWithAlert(t *testing.T) {
require.Equal(t, "Panel Title", o.Alerts[0].RuleGroup)
})
}

func TestNewAlertRule_DefaultRuleQueryInterval(t *testing.T) {
rule, err := grafana.NewAlertRule(&grafana.AlertOptions{
Title: "CPU High",
Query: []grafana.RuleQuery{{
Expr: "up",
RefID: "A",
Datasource: "prometheus-uid",
}},
}).Build()
require.NoError(t, err)
require.Len(t, rule.Data, 1)
model, ok := rule.Data[0].Model.(prometheus.Dataquery)
require.True(t, ok)
require.NotNil(t, model.Interval)
require.Equal(t, grafana.DefaultRuleQueryInterval, *model.Interval)
}
Loading