mirror of
https://github.com/grafana/grafana.git
synced 2024-11-26 02:40:26 -06:00
b198559225
* Wire up to full alert rule struct * Extract group change detection logic to dedicated file * GroupDiff -> GroupDelta for consistency * Calculate deltas and handle backwards compatible requests * Separate changes and insert/update/delete as needed * Regenerate files * Don't touch the DB if there are no changes * Quota checking, delete unused file * Mark modified records as provisioned * Validation + a couple API layer tests * Address linter errors * Fix issue with UID assignment and rule creation * Propagate top level group fields to all rules * Tests for repeated updates and versioning * Tests for quota and provenance checks * Fix linter errors * Regenerate * Factor out some shared logic * Drop unnecessary multiple nilchecks * Use alternative strategy for rolling UIDs on inserted rules * Fix tests, add back nilcheck, refresh UIDs during test * Address feedback * Add missing nil-check
410 lines
14 KiB
Go
410 lines
14 KiB
Go
/*Package api contains base API implementation of unified alerting
|
|
*
|
|
*Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
|
*
|
|
*Do not manually edit these files, please find ngalert/api/swagger-codegen/ for commands on how to generate them.
|
|
*/
|
|
package api
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/grafana/grafana/pkg/api/response"
|
|
"github.com/grafana/grafana/pkg/api/routing"
|
|
"github.com/grafana/grafana/pkg/middleware"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
apimodels "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
|
|
"github.com/grafana/grafana/pkg/services/ngalert/metrics"
|
|
"github.com/grafana/grafana/pkg/web"
|
|
)
|
|
|
|
type ProvisioningApi interface {
|
|
RouteDeleteAlertRule(*models.ReqContext) response.Response
|
|
RouteDeleteContactpoints(*models.ReqContext) response.Response
|
|
RouteDeleteMuteTiming(*models.ReqContext) response.Response
|
|
RouteDeleteTemplate(*models.ReqContext) response.Response
|
|
RouteGetAlertRule(*models.ReqContext) response.Response
|
|
RouteGetAlertRuleGroup(*models.ReqContext) response.Response
|
|
RouteGetContactpoints(*models.ReqContext) response.Response
|
|
RouteGetMuteTiming(*models.ReqContext) response.Response
|
|
RouteGetMuteTimings(*models.ReqContext) response.Response
|
|
RouteGetPolicyTree(*models.ReqContext) response.Response
|
|
RouteGetTemplate(*models.ReqContext) response.Response
|
|
RouteGetTemplates(*models.ReqContext) response.Response
|
|
RoutePostAlertRule(*models.ReqContext) response.Response
|
|
RoutePostContactpoints(*models.ReqContext) response.Response
|
|
RoutePostMuteTiming(*models.ReqContext) response.Response
|
|
RoutePutAlertRule(*models.ReqContext) response.Response
|
|
RoutePutAlertRuleGroup(*models.ReqContext) response.Response
|
|
RoutePutContactpoint(*models.ReqContext) response.Response
|
|
RoutePutMuteTiming(*models.ReqContext) response.Response
|
|
RoutePutPolicyTree(*models.ReqContext) response.Response
|
|
RoutePutTemplate(*models.ReqContext) response.Response
|
|
RouteResetPolicyTree(*models.ReqContext) response.Response
|
|
}
|
|
|
|
func (f *ProvisioningApiHandler) RouteDeleteAlertRule(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
uIDParam := web.Params(ctx.Req)[":UID"]
|
|
return f.handleRouteDeleteAlertRule(ctx, uIDParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteDeleteContactpoints(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
uIDParam := web.Params(ctx.Req)[":UID"]
|
|
return f.handleRouteDeleteContactpoints(ctx, uIDParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteDeleteMuteTiming(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
nameParam := web.Params(ctx.Req)[":name"]
|
|
return f.handleRouteDeleteMuteTiming(ctx, nameParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteDeleteTemplate(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
nameParam := web.Params(ctx.Req)[":name"]
|
|
return f.handleRouteDeleteTemplate(ctx, nameParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteGetAlertRule(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
uIDParam := web.Params(ctx.Req)[":UID"]
|
|
return f.handleRouteGetAlertRule(ctx, uIDParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteGetAlertRuleGroup(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
folderUIDParam := web.Params(ctx.Req)[":FolderUID"]
|
|
groupParam := web.Params(ctx.Req)[":Group"]
|
|
return f.handleRouteGetAlertRuleGroup(ctx, folderUIDParam, groupParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteGetContactpoints(ctx *models.ReqContext) response.Response {
|
|
return f.handleRouteGetContactpoints(ctx)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteGetMuteTiming(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
nameParam := web.Params(ctx.Req)[":name"]
|
|
return f.handleRouteGetMuteTiming(ctx, nameParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteGetMuteTimings(ctx *models.ReqContext) response.Response {
|
|
return f.handleRouteGetMuteTimings(ctx)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteGetPolicyTree(ctx *models.ReqContext) response.Response {
|
|
return f.handleRouteGetPolicyTree(ctx)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteGetTemplate(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
nameParam := web.Params(ctx.Req)[":name"]
|
|
return f.handleRouteGetTemplate(ctx, nameParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteGetTemplates(ctx *models.ReqContext) response.Response {
|
|
return f.handleRouteGetTemplates(ctx)
|
|
}
|
|
func (f *ProvisioningApiHandler) RoutePostAlertRule(ctx *models.ReqContext) response.Response {
|
|
// Parse Request Body
|
|
conf := apimodels.ProvisionedAlertRule{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRoutePostAlertRule(ctx, conf)
|
|
}
|
|
func (f *ProvisioningApiHandler) RoutePostContactpoints(ctx *models.ReqContext) response.Response {
|
|
// Parse Request Body
|
|
conf := apimodels.EmbeddedContactPoint{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRoutePostContactpoints(ctx, conf)
|
|
}
|
|
func (f *ProvisioningApiHandler) RoutePostMuteTiming(ctx *models.ReqContext) response.Response {
|
|
// Parse Request Body
|
|
conf := apimodels.MuteTimeInterval{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRoutePostMuteTiming(ctx, conf)
|
|
}
|
|
func (f *ProvisioningApiHandler) RoutePutAlertRule(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
uIDParam := web.Params(ctx.Req)[":UID"]
|
|
// Parse Request Body
|
|
conf := apimodels.ProvisionedAlertRule{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRoutePutAlertRule(ctx, conf, uIDParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RoutePutAlertRuleGroup(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
folderUIDParam := web.Params(ctx.Req)[":FolderUID"]
|
|
groupParam := web.Params(ctx.Req)[":Group"]
|
|
// Parse Request Body
|
|
conf := apimodels.AlertRuleGroup{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRoutePutAlertRuleGroup(ctx, conf, folderUIDParam, groupParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RoutePutContactpoint(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
uIDParam := web.Params(ctx.Req)[":UID"]
|
|
// Parse Request Body
|
|
conf := apimodels.EmbeddedContactPoint{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRoutePutContactpoint(ctx, conf, uIDParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RoutePutMuteTiming(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
nameParam := web.Params(ctx.Req)[":name"]
|
|
// Parse Request Body
|
|
conf := apimodels.MuteTimeInterval{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRoutePutMuteTiming(ctx, conf, nameParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RoutePutPolicyTree(ctx *models.ReqContext) response.Response {
|
|
// Parse Request Body
|
|
conf := apimodels.Route{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRoutePutPolicyTree(ctx, conf)
|
|
}
|
|
func (f *ProvisioningApiHandler) RoutePutTemplate(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
nameParam := web.Params(ctx.Req)[":name"]
|
|
// Parse Request Body
|
|
conf := apimodels.MessageTemplateContent{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRoutePutTemplate(ctx, conf, nameParam)
|
|
}
|
|
func (f *ProvisioningApiHandler) RouteResetPolicyTree(ctx *models.ReqContext) response.Response {
|
|
return f.handleRouteResetPolicyTree(ctx)
|
|
}
|
|
|
|
func (api *API) RegisterProvisioningApiEndpoints(srv ProvisioningApi, m *metrics.API) {
|
|
api.RouteRegister.Group("", func(group routing.RouteRegister) {
|
|
group.Delete(
|
|
toMacaronPath("/api/v1/provisioning/alert-rules/{UID}"),
|
|
api.authorize(http.MethodDelete, "/api/v1/provisioning/alert-rules/{UID}"),
|
|
metrics.Instrument(
|
|
http.MethodDelete,
|
|
"/api/v1/provisioning/alert-rules/{UID}",
|
|
srv.RouteDeleteAlertRule,
|
|
m,
|
|
),
|
|
)
|
|
group.Delete(
|
|
toMacaronPath("/api/v1/provisioning/contact-points/{UID}"),
|
|
api.authorize(http.MethodDelete, "/api/v1/provisioning/contact-points/{UID}"),
|
|
metrics.Instrument(
|
|
http.MethodDelete,
|
|
"/api/v1/provisioning/contact-points/{UID}",
|
|
srv.RouteDeleteContactpoints,
|
|
m,
|
|
),
|
|
)
|
|
group.Delete(
|
|
toMacaronPath("/api/v1/provisioning/mute-timings/{name}"),
|
|
api.authorize(http.MethodDelete, "/api/v1/provisioning/mute-timings/{name}"),
|
|
metrics.Instrument(
|
|
http.MethodDelete,
|
|
"/api/v1/provisioning/mute-timings/{name}",
|
|
srv.RouteDeleteMuteTiming,
|
|
m,
|
|
),
|
|
)
|
|
group.Delete(
|
|
toMacaronPath("/api/v1/provisioning/templates/{name}"),
|
|
api.authorize(http.MethodDelete, "/api/v1/provisioning/templates/{name}"),
|
|
metrics.Instrument(
|
|
http.MethodDelete,
|
|
"/api/v1/provisioning/templates/{name}",
|
|
srv.RouteDeleteTemplate,
|
|
m,
|
|
),
|
|
)
|
|
group.Get(
|
|
toMacaronPath("/api/v1/provisioning/alert-rules/{UID}"),
|
|
api.authorize(http.MethodGet, "/api/v1/provisioning/alert-rules/{UID}"),
|
|
metrics.Instrument(
|
|
http.MethodGet,
|
|
"/api/v1/provisioning/alert-rules/{UID}",
|
|
srv.RouteGetAlertRule,
|
|
m,
|
|
),
|
|
)
|
|
group.Get(
|
|
toMacaronPath("/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}"),
|
|
api.authorize(http.MethodGet, "/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}"),
|
|
metrics.Instrument(
|
|
http.MethodGet,
|
|
"/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}",
|
|
srv.RouteGetAlertRuleGroup,
|
|
m,
|
|
),
|
|
)
|
|
group.Get(
|
|
toMacaronPath("/api/v1/provisioning/contact-points"),
|
|
api.authorize(http.MethodGet, "/api/v1/provisioning/contact-points"),
|
|
metrics.Instrument(
|
|
http.MethodGet,
|
|
"/api/v1/provisioning/contact-points",
|
|
srv.RouteGetContactpoints,
|
|
m,
|
|
),
|
|
)
|
|
group.Get(
|
|
toMacaronPath("/api/v1/provisioning/mute-timings/{name}"),
|
|
api.authorize(http.MethodGet, "/api/v1/provisioning/mute-timings/{name}"),
|
|
metrics.Instrument(
|
|
http.MethodGet,
|
|
"/api/v1/provisioning/mute-timings/{name}",
|
|
srv.RouteGetMuteTiming,
|
|
m,
|
|
),
|
|
)
|
|
group.Get(
|
|
toMacaronPath("/api/v1/provisioning/mute-timings"),
|
|
api.authorize(http.MethodGet, "/api/v1/provisioning/mute-timings"),
|
|
metrics.Instrument(
|
|
http.MethodGet,
|
|
"/api/v1/provisioning/mute-timings",
|
|
srv.RouteGetMuteTimings,
|
|
m,
|
|
),
|
|
)
|
|
group.Get(
|
|
toMacaronPath("/api/v1/provisioning/policies"),
|
|
api.authorize(http.MethodGet, "/api/v1/provisioning/policies"),
|
|
metrics.Instrument(
|
|
http.MethodGet,
|
|
"/api/v1/provisioning/policies",
|
|
srv.RouteGetPolicyTree,
|
|
m,
|
|
),
|
|
)
|
|
group.Get(
|
|
toMacaronPath("/api/v1/provisioning/templates/{name}"),
|
|
api.authorize(http.MethodGet, "/api/v1/provisioning/templates/{name}"),
|
|
metrics.Instrument(
|
|
http.MethodGet,
|
|
"/api/v1/provisioning/templates/{name}",
|
|
srv.RouteGetTemplate,
|
|
m,
|
|
),
|
|
)
|
|
group.Get(
|
|
toMacaronPath("/api/v1/provisioning/templates"),
|
|
api.authorize(http.MethodGet, "/api/v1/provisioning/templates"),
|
|
metrics.Instrument(
|
|
http.MethodGet,
|
|
"/api/v1/provisioning/templates",
|
|
srv.RouteGetTemplates,
|
|
m,
|
|
),
|
|
)
|
|
group.Post(
|
|
toMacaronPath("/api/v1/provisioning/alert-rules"),
|
|
api.authorize(http.MethodPost, "/api/v1/provisioning/alert-rules"),
|
|
metrics.Instrument(
|
|
http.MethodPost,
|
|
"/api/v1/provisioning/alert-rules",
|
|
srv.RoutePostAlertRule,
|
|
m,
|
|
),
|
|
)
|
|
group.Post(
|
|
toMacaronPath("/api/v1/provisioning/contact-points"),
|
|
api.authorize(http.MethodPost, "/api/v1/provisioning/contact-points"),
|
|
metrics.Instrument(
|
|
http.MethodPost,
|
|
"/api/v1/provisioning/contact-points",
|
|
srv.RoutePostContactpoints,
|
|
m,
|
|
),
|
|
)
|
|
group.Post(
|
|
toMacaronPath("/api/v1/provisioning/mute-timings"),
|
|
api.authorize(http.MethodPost, "/api/v1/provisioning/mute-timings"),
|
|
metrics.Instrument(
|
|
http.MethodPost,
|
|
"/api/v1/provisioning/mute-timings",
|
|
srv.RoutePostMuteTiming,
|
|
m,
|
|
),
|
|
)
|
|
group.Put(
|
|
toMacaronPath("/api/v1/provisioning/alert-rules/{UID}"),
|
|
api.authorize(http.MethodPut, "/api/v1/provisioning/alert-rules/{UID}"),
|
|
metrics.Instrument(
|
|
http.MethodPut,
|
|
"/api/v1/provisioning/alert-rules/{UID}",
|
|
srv.RoutePutAlertRule,
|
|
m,
|
|
),
|
|
)
|
|
group.Put(
|
|
toMacaronPath("/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}"),
|
|
api.authorize(http.MethodPut, "/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}"),
|
|
metrics.Instrument(
|
|
http.MethodPut,
|
|
"/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}",
|
|
srv.RoutePutAlertRuleGroup,
|
|
m,
|
|
),
|
|
)
|
|
group.Put(
|
|
toMacaronPath("/api/v1/provisioning/contact-points/{UID}"),
|
|
api.authorize(http.MethodPut, "/api/v1/provisioning/contact-points/{UID}"),
|
|
metrics.Instrument(
|
|
http.MethodPut,
|
|
"/api/v1/provisioning/contact-points/{UID}",
|
|
srv.RoutePutContactpoint,
|
|
m,
|
|
),
|
|
)
|
|
group.Put(
|
|
toMacaronPath("/api/v1/provisioning/mute-timings/{name}"),
|
|
api.authorize(http.MethodPut, "/api/v1/provisioning/mute-timings/{name}"),
|
|
metrics.Instrument(
|
|
http.MethodPut,
|
|
"/api/v1/provisioning/mute-timings/{name}",
|
|
srv.RoutePutMuteTiming,
|
|
m,
|
|
),
|
|
)
|
|
group.Put(
|
|
toMacaronPath("/api/v1/provisioning/policies"),
|
|
api.authorize(http.MethodPut, "/api/v1/provisioning/policies"),
|
|
metrics.Instrument(
|
|
http.MethodPut,
|
|
"/api/v1/provisioning/policies",
|
|
srv.RoutePutPolicyTree,
|
|
m,
|
|
),
|
|
)
|
|
group.Put(
|
|
toMacaronPath("/api/v1/provisioning/templates/{name}"),
|
|
api.authorize(http.MethodPut, "/api/v1/provisioning/templates/{name}"),
|
|
metrics.Instrument(
|
|
http.MethodPut,
|
|
"/api/v1/provisioning/templates/{name}",
|
|
srv.RoutePutTemplate,
|
|
m,
|
|
),
|
|
)
|
|
group.Delete(
|
|
toMacaronPath("/api/v1/provisioning/policies"),
|
|
api.authorize(http.MethodDelete, "/api/v1/provisioning/policies"),
|
|
metrics.Instrument(
|
|
http.MethodDelete,
|
|
"/api/v1/provisioning/policies",
|
|
srv.RouteResetPolicyTree,
|
|
m,
|
|
),
|
|
)
|
|
}, middleware.ReqSignedIn)
|
|
}
|