forked from grafana/grafana
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Alerting]: Grafana managed ruler API implementation (grafana#32537)
* [Alerting]: Grafana managed ruler API impl * Apply suggestions from code review * fix lint * Add validation for ruleGroup name length * Fix MySQL migration Co-authored-by: kyle <[email protected]>
- Loading branch information
1 parent
e499585
commit ee06970
Showing
19 changed files
with
1,433 additions
and
356 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,219 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "time" | ||
|
|
||
| "github.com/grafana/grafana/pkg/services/ngalert/store" | ||
|
|
||
| apimodels "github.com/grafana/alerting-api/pkg/api" | ||
| "github.com/grafana/grafana/pkg/api/response" | ||
| "github.com/grafana/grafana/pkg/infra/log" | ||
| "github.com/grafana/grafana/pkg/models" | ||
| ngmodels "github.com/grafana/grafana/pkg/services/ngalert/models" | ||
| "github.com/grafana/grafana/pkg/util" | ||
| "github.com/prometheus/common/model" | ||
| ) | ||
|
|
||
| type RulerSrv struct { | ||
| store store.RuleStore | ||
| log log.Logger | ||
| } | ||
|
|
||
| func (srv RulerSrv) RouteDeleteNamespaceRulesConfig(c *models.ReqContext) response.Response { | ||
| namespace := c.Params(":Namespace") | ||
| namespaceUID, err := srv.store.GetNamespaceUIDBySlug(namespace, c.SignedInUser.OrgId, c.SignedInUser) | ||
| if err != nil { | ||
| return response.Error(http.StatusInternalServerError, fmt.Sprintf("failed to get namespace: %s", namespace), err) | ||
| } | ||
| if err := srv.store.DeleteNamespaceAlertRules(c.SignedInUser.OrgId, namespaceUID); err != nil { | ||
| return response.Error(http.StatusInternalServerError, "failed to delete namespace alert rules", err) | ||
| } | ||
| return response.JSON(http.StatusAccepted, util.DynMap{"message": "namespace rules deleted"}) | ||
| } | ||
|
|
||
| func (srv RulerSrv) RouteDeleteRuleGroupConfig(c *models.ReqContext) response.Response { | ||
| namespace := c.Params(":Namespace") | ||
| namespaceUID, err := srv.store.GetNamespaceUIDBySlug(namespace, c.SignedInUser.OrgId, c.SignedInUser) | ||
| if err != nil { | ||
| return response.Error(http.StatusInternalServerError, fmt.Sprintf("failed to get namespace: %s", namespace), err) | ||
| } | ||
| ruleGroup := c.Params(":Groupname") | ||
| if err := srv.store.DeleteRuleGroupAlertRules(c.SignedInUser.OrgId, namespaceUID, ruleGroup); err != nil { | ||
| return response.Error(http.StatusInternalServerError, "failed to delete group alert rules", err) | ||
| } | ||
| return response.JSON(http.StatusAccepted, util.DynMap{"message": "rule group deleted"}) | ||
| } | ||
|
|
||
| func (srv RulerSrv) RouteGetNamespaceRulesConfig(c *models.ReqContext) response.Response { | ||
| namespace := c.Params(":Namespace") | ||
| namespaceUID, err := srv.store.GetNamespaceUIDBySlug(namespace, c.SignedInUser.OrgId, c.SignedInUser) | ||
| if err != nil { | ||
| return response.Error(http.StatusInternalServerError, fmt.Sprintf("failed to get namespace: %s", namespace), err) | ||
| } | ||
|
|
||
| q := ngmodels.ListNamespaceAlertRulesQuery{ | ||
| OrgID: c.SignedInUser.OrgId, | ||
| NamespaceUID: namespaceUID, | ||
| } | ||
| if err := srv.store.GetNamespaceAlertRules(&q); err != nil { | ||
| return response.Error(http.StatusInternalServerError, "failed to update rule group", err) | ||
| } | ||
|
|
||
| result := apimodels.NamespaceConfigResponse{} | ||
| ruleGroupConfigs := make(map[string]apimodels.GettableRuleGroupConfig) | ||
| for _, r := range q.Result { | ||
| ruleGroupConfig, ok := ruleGroupConfigs[r.RuleGroup] | ||
| if !ok { | ||
| ruleGroupInterval := model.Duration(time.Duration(r.IntervalSeconds) * time.Second) | ||
| ruleGroupConfigs[r.RuleGroup] = apimodels.GettableRuleGroupConfig{ | ||
| Name: r.RuleGroup, | ||
| Interval: ruleGroupInterval, | ||
| Rules: []apimodels.GettableExtendedRuleNode{ | ||
| toGettableExtendedRuleNode(*r), | ||
| }, | ||
| } | ||
| } else { | ||
| ruleGroupConfig.Rules = append(ruleGroupConfig.Rules, toGettableExtendedRuleNode(*r)) | ||
| ruleGroupConfigs[r.RuleGroup] = ruleGroupConfig | ||
| } | ||
| } | ||
|
|
||
| for _, ruleGroupConfig := range ruleGroupConfigs { | ||
| result[namespace] = append(result[namespace], ruleGroupConfig) | ||
| } | ||
|
|
||
| return response.JSON(http.StatusAccepted, result) | ||
| } | ||
|
|
||
| func (srv RulerSrv) RouteGetRulegGroupConfig(c *models.ReqContext) response.Response { | ||
| namespace := c.Params(":Namespace") | ||
| namespaceUID, err := srv.store.GetNamespaceUIDBySlug(namespace, c.SignedInUser.OrgId, c.SignedInUser) | ||
| if err != nil { | ||
| return response.Error(http.StatusInternalServerError, fmt.Sprintf("failed to get namespace: %s", namespace), err) | ||
| } | ||
|
|
||
| ruleGroup := c.Params(":Groupname") | ||
| q := ngmodels.ListRuleGroupAlertRulesQuery{ | ||
| OrgID: c.SignedInUser.OrgId, | ||
| NamespaceUID: namespaceUID, | ||
| RuleGroup: ruleGroup, | ||
| } | ||
| if err := srv.store.GetRuleGroupAlertRules(&q); err != nil { | ||
| return response.Error(http.StatusInternalServerError, "failed to get group alert rules", err) | ||
| } | ||
|
|
||
| var ruleGroupInterval model.Duration | ||
| ruleNodes := make([]apimodels.GettableExtendedRuleNode, 0, len(q.Result)) | ||
| for _, r := range q.Result { | ||
| ruleGroupInterval = model.Duration(time.Duration(r.IntervalSeconds) * time.Second) | ||
| ruleNodes = append(ruleNodes, toGettableExtendedRuleNode(*r)) | ||
| } | ||
|
|
||
| result := apimodels.RuleGroupConfigResponse{ | ||
| GettableRuleGroupConfig: apimodels.GettableRuleGroupConfig{ | ||
| Name: ruleGroup, | ||
| Interval: ruleGroupInterval, | ||
| Rules: ruleNodes, | ||
| }, | ||
| } | ||
| return response.JSON(http.StatusAccepted, result) | ||
| } | ||
|
|
||
| func (srv RulerSrv) RouteGetRulesConfig(c *models.ReqContext) response.Response { | ||
| q := ngmodels.ListAlertRulesQuery{ | ||
| OrgID: c.SignedInUser.OrgId, | ||
| } | ||
| if err := srv.store.GetOrgAlertRules(&q); err != nil { | ||
| return response.Error(http.StatusInternalServerError, "failed to get alert rules", err) | ||
| } | ||
|
|
||
| configs := make(map[string]map[string]apimodels.GettableRuleGroupConfig) | ||
| for _, r := range q.Result { | ||
| namespace, err := srv.store.GetNamespaceByUID(r.NamespaceUID, c.SignedInUser.OrgId, c.SignedInUser) | ||
| if err != nil { | ||
| return response.Error(http.StatusInternalServerError, fmt.Sprintf("failed to get namespace: %s", r.NamespaceUID), err) | ||
| } | ||
| _, ok := configs[namespace] | ||
| if !ok { | ||
| ruleGroupInterval := model.Duration(time.Duration(r.IntervalSeconds) * time.Second) | ||
| configs[namespace] = make(map[string]apimodels.GettableRuleGroupConfig) | ||
| configs[namespace][r.RuleGroup] = apimodels.GettableRuleGroupConfig{ | ||
| Name: r.RuleGroup, | ||
| Interval: ruleGroupInterval, | ||
| Rules: []apimodels.GettableExtendedRuleNode{ | ||
| toGettableExtendedRuleNode(*r), | ||
| }, | ||
| } | ||
| } else { | ||
| ruleGroupConfig, ok := configs[namespace][r.RuleGroup] | ||
| if !ok { | ||
| ruleGroupInterval := model.Duration(time.Duration(r.IntervalSeconds) * time.Second) | ||
| configs[namespace][r.RuleGroup] = apimodels.GettableRuleGroupConfig{ | ||
| Name: r.RuleGroup, | ||
| Interval: ruleGroupInterval, | ||
| Rules: []apimodels.GettableExtendedRuleNode{ | ||
| toGettableExtendedRuleNode(*r), | ||
| }, | ||
| } | ||
| } else { | ||
| ruleGroupConfig.Rules = append(ruleGroupConfig.Rules, toGettableExtendedRuleNode(*r)) | ||
| configs[namespace][r.RuleGroup] = ruleGroupConfig | ||
| } | ||
| } | ||
| } | ||
|
|
||
| result := apimodels.NamespaceConfigResponse{} | ||
| for namespace, m := range configs { | ||
| for _, ruleGroupConfig := range m { | ||
| result[namespace] = append(result[namespace], ruleGroupConfig) | ||
| } | ||
| } | ||
| return response.JSON(http.StatusAccepted, result) | ||
| } | ||
|
|
||
| func (srv RulerSrv) RoutePostNameRulesConfig(c *models.ReqContext, ruleGroupConfig apimodels.PostableRuleGroupConfig) response.Response { | ||
| namespace := c.Params(":Namespace") | ||
| namespaceUID, err := srv.store.GetNamespaceUIDBySlug(namespace, c.SignedInUser.OrgId, c.SignedInUser) | ||
| if err != nil { | ||
| return response.Error(http.StatusInternalServerError, fmt.Sprintf("failed to get namespace: %s", namespace), err) | ||
| } | ||
|
|
||
| // TODO check permissions | ||
| // TODO check quota | ||
| // TODO validate UID uniqueness in the payload | ||
|
|
||
| ruleGroup := ruleGroupConfig.Name | ||
|
|
||
| if err := srv.store.UpdateRuleGroup(store.UpdateRuleGroupCmd{ | ||
| OrgID: c.SignedInUser.OrgId, | ||
| NamespaceUID: namespaceUID, | ||
| RuleGroup: ruleGroup, | ||
| RuleGroupConfig: ruleGroupConfig, | ||
| }); err != nil { | ||
| return response.Error(http.StatusInternalServerError, "failed to update rule group", err) | ||
| } | ||
|
|
||
| return response.JSON(http.StatusAccepted, util.DynMap{"message": "rule group updated successfully"}) | ||
| } | ||
|
|
||
| func toGettableExtendedRuleNode(r ngmodels.AlertRule) apimodels.GettableExtendedRuleNode { | ||
| return apimodels.GettableExtendedRuleNode{ | ||
| GrafanaManagedAlert: &apimodels.GettableGrafanaRule{ | ||
| ID: r.ID, | ||
| OrgID: r.OrgID, | ||
| Title: r.Title, | ||
| Condition: r.Condition, | ||
| Data: r.Data, | ||
| Updated: r.Updated, | ||
| IntervalSeconds: r.IntervalSeconds, | ||
| Version: r.Version, | ||
| UID: r.UID, | ||
| NamespaceUID: r.NamespaceUID, | ||
| RuleGroup: r.RuleGroup, | ||
| NoDataState: apimodels.NoDataState(r.NoDataState), | ||
| ExecErrState: apimodels.ExecutionErrorState(r.ExecErrState), | ||
| }, | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.