mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
c006df375a
This adds provisioning endpoints for downloading alert rules and alert rule groups in a format that is compatible with file provisioning. Each endpoint supports both json and yaml response types via Accept header as well as a query parameter download=true/false that will set Content-Disposition to recommend initiating a download or inline display. This also makes some package changes to keep structs with potential to drift closer together. Eventually, other alerting file structs should also move into this new file package, but the rest require some refactoring that is out of scope for this PR.
290 lines
8.1 KiB
Go
290 lines
8.1 KiB
Go
package definitions
|
||
|
||
import (
|
||
"time"
|
||
|
||
"github.com/grafana/grafana/pkg/services/ngalert/models"
|
||
"github.com/grafana/grafana/pkg/services/provisioning/alerting/file"
|
||
|
||
"github.com/prometheus/common/model"
|
||
)
|
||
|
||
// swagger:route GET /api/v1/provisioning/alert-rules provisioning stable RouteGetAlertRules
|
||
//
|
||
// Get all the alert rules.
|
||
//
|
||
// Responses:
|
||
// 200: ProvisionedAlertRules
|
||
|
||
// swagger:route GET /api/v1/provisioning/alert-rules/export provisioning stable RouteGetAlertRulesExport
|
||
//
|
||
// Export all alert rules in provisioning file format.
|
||
//
|
||
// Responses:
|
||
// 200: AlertingFileExport
|
||
// 404: description: Not found.
|
||
|
||
// swagger:route GET /api/v1/provisioning/alert-rules/{UID} provisioning stable RouteGetAlertRule
|
||
//
|
||
// Get a specific alert rule by UID.
|
||
//
|
||
// Responses:
|
||
// 200: ProvisionedAlertRule
|
||
// 404: description: Not found.
|
||
|
||
// swagger:route GET /api/v1/provisioning/alert-rules/{UID}/export provisioning stable RouteGetAlertRuleExport
|
||
//
|
||
// Export an alert rule in provisioning file format.
|
||
//
|
||
// Produces:
|
||
// - application/json
|
||
// - application/yaml
|
||
// - text/yaml
|
||
//
|
||
// Responses:
|
||
// 200: AlertingFileExport
|
||
// 404: description: Not found.
|
||
|
||
// swagger:route POST /api/v1/provisioning/alert-rules provisioning stable RoutePostAlertRule
|
||
//
|
||
// Create a new alert rule.
|
||
//
|
||
// Consumes:
|
||
// - application/json
|
||
//
|
||
// Responses:
|
||
// 201: ProvisionedAlertRule
|
||
// 400: ValidationError
|
||
|
||
// swagger:route PUT /api/v1/provisioning/alert-rules/{UID} provisioning stable RoutePutAlertRule
|
||
//
|
||
// Update an existing alert rule.
|
||
//
|
||
// Consumes:
|
||
// - application/json
|
||
//
|
||
// Responses:
|
||
// 200: ProvisionedAlertRule
|
||
// 400: ValidationError
|
||
|
||
// swagger:route DELETE /api/v1/provisioning/alert-rules/{UID} provisioning stable RouteDeleteAlertRule
|
||
//
|
||
// Delete a specific alert rule by UID.
|
||
//
|
||
// Responses:
|
||
// 204: description: The alert rule was deleted successfully.
|
||
|
||
// swagger:parameters RouteGetAlertRule RoutePutAlertRule RouteDeleteAlertRule RouteGetAlertRuleExport
|
||
type AlertRuleUIDReference struct {
|
||
// Alert rule UID
|
||
// in:path
|
||
UID string
|
||
}
|
||
|
||
// swagger:parameters RoutePostAlertRule RoutePutAlertRule
|
||
type AlertRulePayload struct {
|
||
// in:body
|
||
Body ProvisionedAlertRule
|
||
}
|
||
|
||
// swagger:parameters RoutePostAlertRule RoutePutAlertRule
|
||
type AlertRuleHeaders struct {
|
||
// in:header
|
||
XDisableProvenance string `json:"X-Disable-Provenance"`
|
||
}
|
||
|
||
// swagger:model
|
||
type ProvisionedAlertRules []ProvisionedAlertRule
|
||
|
||
type ProvisionedAlertRule struct {
|
||
ID int64 `json:"id"`
|
||
UID string `json:"uid"`
|
||
// required: true
|
||
OrgID int64 `json:"orgID"`
|
||
// required: true
|
||
// example: project_x
|
||
FolderUID string `json:"folderUID"`
|
||
// required: true
|
||
// minLength: 1
|
||
// maxLength: 190
|
||
// example: eval_group_1
|
||
RuleGroup string `json:"ruleGroup"`
|
||
// required: true
|
||
// minLength: 1
|
||
// maxLength: 190
|
||
// example: Always firing
|
||
Title string `json:"title"`
|
||
// required: true
|
||
// example: A
|
||
Condition string `json:"condition"`
|
||
// required: true
|
||
// example: [{"refId":"A","queryType":"","relativeTimeRange":{"from":0,"to":0},"datasourceUid":"-100","model":{"conditions":[{"evaluator":{"params":[0,0],"type":"gt"},"operator":{"type":"and"},"query":{"params":[]},"reducer":{"params":[],"type":"avg"},"type":"query"}],"datasource":{"type":"__expr__","uid":"__expr__"},"expression":"1 == 1","hide":false,"intervalMs":1000,"maxDataPoints":43200,"refId":"A","type":"math"}}]
|
||
Data []models.AlertQuery `json:"data"`
|
||
// readonly: true
|
||
Updated time.Time `json:"updated,omitempty"`
|
||
// required: true
|
||
NoDataState models.NoDataState `json:"noDataState"`
|
||
// required: true
|
||
ExecErrState models.ExecutionErrorState `json:"execErrState"`
|
||
// required: true
|
||
For model.Duration `json:"for"`
|
||
// example: {"runbook_url": "https://supercoolrunbook.com/page/13"}
|
||
Annotations map[string]string `json:"annotations,omitempty"`
|
||
// example: {"team": "sre-team-1"}
|
||
Labels map[string]string `json:"labels,omitempty"`
|
||
// readonly: true
|
||
Provenance models.Provenance `json:"provenance,omitempty"`
|
||
}
|
||
|
||
func (a *ProvisionedAlertRule) UpstreamModel() (models.AlertRule, error) {
|
||
return models.AlertRule{
|
||
ID: a.ID,
|
||
UID: a.UID,
|
||
OrgID: a.OrgID,
|
||
NamespaceUID: a.FolderUID,
|
||
RuleGroup: a.RuleGroup,
|
||
Title: a.Title,
|
||
Condition: a.Condition,
|
||
Data: a.Data,
|
||
Updated: a.Updated,
|
||
NoDataState: a.NoDataState,
|
||
ExecErrState: a.ExecErrState,
|
||
For: time.Duration(a.For),
|
||
Annotations: a.Annotations,
|
||
Labels: a.Labels,
|
||
}, nil
|
||
}
|
||
|
||
func NewAlertRule(rule models.AlertRule, provenance models.Provenance) ProvisionedAlertRule {
|
||
return ProvisionedAlertRule{
|
||
ID: rule.ID,
|
||
UID: rule.UID,
|
||
OrgID: rule.OrgID,
|
||
FolderUID: rule.NamespaceUID,
|
||
RuleGroup: rule.RuleGroup,
|
||
Title: rule.Title,
|
||
For: model.Duration(rule.For),
|
||
Condition: rule.Condition,
|
||
Data: rule.Data,
|
||
Updated: rule.Updated,
|
||
NoDataState: rule.NoDataState,
|
||
ExecErrState: rule.ExecErrState,
|
||
Annotations: rule.Annotations,
|
||
Labels: rule.Labels,
|
||
Provenance: provenance,
|
||
}
|
||
}
|
||
|
||
func NewAlertRules(rules []*models.AlertRule) ProvisionedAlertRules {
|
||
result := make([]ProvisionedAlertRule, 0, len(rules))
|
||
for _, r := range rules {
|
||
result = append(result, NewAlertRule(*r, models.ProvenanceNone))
|
||
}
|
||
return result
|
||
}
|
||
|
||
// swagger:route GET /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group} provisioning stable RouteGetAlertRuleGroup
|
||
//
|
||
// Get a rule group.
|
||
//
|
||
// Responses:
|
||
// 200: AlertRuleGroup
|
||
// 404: description: Not found.
|
||
|
||
// swagger:route GET /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}/export provisioning stable RouteGetAlertRuleGroupExport
|
||
//
|
||
// Export an alert rule group in provisioning file format.
|
||
//
|
||
// Produces:
|
||
// - application/json
|
||
// - application/yaml
|
||
// - text/yaml
|
||
//
|
||
// Responses:
|
||
// 200: AlertingFileExport
|
||
// 404: description: Not found.
|
||
|
||
// swagger:route PUT /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group} provisioning stable RoutePutAlertRuleGroup
|
||
//
|
||
// Update the interval of a rule group.
|
||
//
|
||
// Consumes:
|
||
// - application/json
|
||
//
|
||
// Responses:
|
||
// 200: AlertRuleGroup
|
||
// 400: ValidationError
|
||
|
||
// swagger:parameters RouteGetAlertRuleGroup RoutePutAlertRuleGroup RouteGetAlertRuleGroupExport
|
||
type FolderUIDPathParam struct {
|
||
// in:path
|
||
FolderUID string `json:"FolderUID"`
|
||
}
|
||
|
||
// swagger:parameters RouteGetAlertRuleGroup RoutePutAlertRuleGroup RouteGetAlertRuleGroupExport
|
||
type RuleGroupPathParam struct {
|
||
// in:path
|
||
Group string `json:"Group"`
|
||
}
|
||
|
||
// swagger:parameters RoutePutAlertRuleGroup
|
||
type AlertRuleGroupPayload struct {
|
||
// in:body
|
||
Body AlertRuleGroup
|
||
}
|
||
|
||
// swagger:model
|
||
type AlertRuleGroupMetadata struct {
|
||
Interval int64 `json:"interval"`
|
||
}
|
||
|
||
// swagger:parameters RouteGetAlertRuleGroupExport RouteGetAlertRuleExport RouteGetAlertRulesExport
|
||
type ExportQueryParams struct {
|
||
// Whether to initiate a download of the file or not.
|
||
// in: query
|
||
// required: false
|
||
// default: false
|
||
Download bool `json:"download"`
|
||
}
|
||
|
||
// swagger:model
|
||
type AlertRuleGroup struct {
|
||
Title string `json:"title"`
|
||
FolderUID string `json:"folderUid"`
|
||
Interval int64 `json:"interval"`
|
||
Rules []ProvisionedAlertRule `json:"rules"`
|
||
}
|
||
|
||
// AlertingFileExport is the full provisioned file export.
|
||
// swagger:model
|
||
type AlertingFileExport = file.AlertingFileExport
|
||
|
||
func (a *AlertRuleGroup) ToModel() (models.AlertRuleGroup, error) {
|
||
ruleGroup := models.AlertRuleGroup{
|
||
Title: a.Title,
|
||
FolderUID: a.FolderUID,
|
||
Interval: a.Interval,
|
||
}
|
||
for i := range a.Rules {
|
||
converted, err := a.Rules[i].UpstreamModel()
|
||
if err != nil {
|
||
return models.AlertRuleGroup{}, err
|
||
}
|
||
ruleGroup.Rules = append(ruleGroup.Rules, converted)
|
||
}
|
||
return ruleGroup, nil
|
||
}
|
||
|
||
func NewAlertRuleGroupFromModel(d models.AlertRuleGroup) AlertRuleGroup {
|
||
rules := make([]ProvisionedAlertRule, 0, len(d.Rules))
|
||
for i := range d.Rules {
|
||
rules = append(rules, NewAlertRule(d.Rules[i], d.Provenance))
|
||
}
|
||
return AlertRuleGroup{
|
||
Title: d.Title,
|
||
FolderUID: d.FolderUID,
|
||
Interval: d.Interval,
|
||
Rules: rules,
|
||
}
|
||
}
|