mirror of
https://github.com/grafana/grafana.git
synced 2025-02-12 00:25:46 -06:00
ba3994d338
* Alerting: Repurpose rule testing endpoint to return potential alerts This feature replaces the existing no-longer in-use grafana ruler testing API endpoint /api/v1/rule/test/grafana. The new endpoint returns a list of potential alerts created by the given alert rule, including built-in + interpolated labels and annotations. The key priority of this endpoint is that it is intended to be as true as possible to what would be generated by the ruler except that the resulting alerts are not filtered to only Resolved / Firing and ready to be sent. This means that the endpoint will, among other things: - Attach static annotations and labels from the rule configuration to the alert instances. - Attach dynamic annotations from the datasource to the alert instances. - Attach built-in labels and annotations created by the Grafana Ruler (such as alertname and grafana_folder) to the alert instances. - Interpolate templated annotations / labels and accept allowed template functions.
64 lines
2.2 KiB
Go
64 lines
2.2 KiB
Go
package notifier
|
|
|
|
import (
|
|
"context"
|
|
|
|
alertingModels "github.com/grafana/alerting/models"
|
|
alertingNotify "github.com/grafana/alerting/notify"
|
|
amv2 "github.com/prometheus/alertmanager/api/v2/models"
|
|
prometheusModel "github.com/prometheus/common/model"
|
|
|
|
apimodels "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
|
|
)
|
|
|
|
type TestTemplatesResults = alertingNotify.TestTemplatesResults
|
|
|
|
var (
|
|
DefaultLabels = map[string]string{
|
|
prometheusModel.AlertNameLabel: `alert title`,
|
|
alertingModels.FolderTitleLabel: `folder title`,
|
|
}
|
|
DefaultAnnotations = map[string]string{
|
|
alertingModels.ValuesAnnotation: `{"B":22,"C":1}`,
|
|
alertingModels.ValueStringAnnotation: `[ var='B' labels={__name__=go_threads, instance=host.docker.internal:3000, job=grafana} value=22 ], [ var='C' labels={__name__=go_threads, instance=host.docker.internal:3000, job=grafana} value=1 ]`,
|
|
alertingModels.OrgIDAnnotation: `1`,
|
|
alertingModels.DashboardUIDAnnotation: `dashboard_uid`,
|
|
alertingModels.PanelIDAnnotation: `1`,
|
|
}
|
|
)
|
|
|
|
// TestTemplate tests the given template string against the given alerts. Existing templates are used to provide context for the test.
|
|
// If an existing template of the same filename as the one being tested is found, it will not be used as context.
|
|
func (am *Alertmanager) TestTemplate(ctx context.Context, c apimodels.TestTemplatesConfigBodyParams) (*TestTemplatesResults, error) {
|
|
for _, alert := range c.Alerts {
|
|
addDefaultLabelsAndAnnotations(alert)
|
|
}
|
|
|
|
return am.Base.TestTemplate(ctx, alertingNotify.TestTemplatesConfigBodyParams{
|
|
Alerts: c.Alerts,
|
|
Template: c.Template,
|
|
Name: c.Name,
|
|
})
|
|
}
|
|
|
|
// addDefaultLabelsAndAnnotations is a slimmed down version of state.StateToPostableAlert and state.GetRuleExtraLabels using default values.
|
|
func addDefaultLabelsAndAnnotations(alert *amv2.PostableAlert) {
|
|
if alert.Labels == nil {
|
|
alert.Labels = make(map[string]string)
|
|
}
|
|
for k, v := range DefaultLabels {
|
|
if _, ok := alert.Labels[k]; !ok {
|
|
alert.Labels[k] = v
|
|
}
|
|
}
|
|
|
|
if alert.Annotations == nil {
|
|
alert.Annotations = make(map[string]string)
|
|
}
|
|
for k, v := range DefaultAnnotations {
|
|
if _, ok := alert.Annotations[k]; !ok {
|
|
alert.Annotations[k] = v
|
|
}
|
|
}
|
|
}
|