mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
ad09feed83
* Implement backtesting engine that can process regular rule specification (with queries to datasource) as well as special kind of rules that have data frame instead of query. * declare a new API endpoint and model * add feature toggle `alertingBacktesting`
107 lines
3.4 KiB
Go
107 lines
3.4 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 TestingApi interface {
|
|
BacktestConfig(*models.ReqContext) response.Response
|
|
RouteEvalQueries(*models.ReqContext) response.Response
|
|
RouteTestRuleConfig(*models.ReqContext) response.Response
|
|
RouteTestRuleGrafanaConfig(*models.ReqContext) response.Response
|
|
}
|
|
|
|
func (f *TestingApiHandler) BacktestConfig(ctx *models.ReqContext) response.Response {
|
|
// Parse Request Body
|
|
conf := apimodels.BacktestConfig{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleBacktestingConfig(ctx, conf)
|
|
}
|
|
func (f *TestingApiHandler) RouteEvalQueries(ctx *models.ReqContext) response.Response {
|
|
// Parse Request Body
|
|
conf := apimodels.EvalQueriesPayload{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRouteEvalQueries(ctx, conf)
|
|
}
|
|
func (f *TestingApiHandler) RouteTestRuleConfig(ctx *models.ReqContext) response.Response {
|
|
// Parse Path Parameters
|
|
datasourceUIDParam := web.Params(ctx.Req)[":DatasourceUID"]
|
|
// Parse Request Body
|
|
conf := apimodels.TestRulePayload{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRouteTestRuleConfig(ctx, conf, datasourceUIDParam)
|
|
}
|
|
func (f *TestingApiHandler) RouteTestRuleGrafanaConfig(ctx *models.ReqContext) response.Response {
|
|
// Parse Request Body
|
|
conf := apimodels.TestRulePayload{}
|
|
if err := web.Bind(ctx.Req, &conf); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
return f.handleRouteTestRuleGrafanaConfig(ctx, conf)
|
|
}
|
|
|
|
func (api *API) RegisterTestingApiEndpoints(srv TestingApi, m *metrics.API) {
|
|
api.RouteRegister.Group("", func(group routing.RouteRegister) {
|
|
group.Post(
|
|
toMacaronPath("/api/v1/rule/backtest"),
|
|
api.authorize(http.MethodPost, "/api/v1/rule/backtest"),
|
|
metrics.Instrument(
|
|
http.MethodPost,
|
|
"/api/v1/rule/backtest",
|
|
srv.BacktestConfig,
|
|
m,
|
|
),
|
|
)
|
|
group.Post(
|
|
toMacaronPath("/api/v1/eval"),
|
|
api.authorize(http.MethodPost, "/api/v1/eval"),
|
|
metrics.Instrument(
|
|
http.MethodPost,
|
|
"/api/v1/eval",
|
|
srv.RouteEvalQueries,
|
|
m,
|
|
),
|
|
)
|
|
group.Post(
|
|
toMacaronPath("/api/v1/rule/test/{DatasourceUID}"),
|
|
api.authorize(http.MethodPost, "/api/v1/rule/test/{DatasourceUID}"),
|
|
metrics.Instrument(
|
|
http.MethodPost,
|
|
"/api/v1/rule/test/{DatasourceUID}",
|
|
srv.RouteTestRuleConfig,
|
|
m,
|
|
),
|
|
)
|
|
group.Post(
|
|
toMacaronPath("/api/v1/rule/test/grafana"),
|
|
api.authorize(http.MethodPost, "/api/v1/rule/test/grafana"),
|
|
metrics.Instrument(
|
|
http.MethodPost,
|
|
"/api/v1/rule/test/grafana",
|
|
srv.RouteTestRuleGrafanaConfig,
|
|
m,
|
|
),
|
|
)
|
|
}, middleware.ReqSignedIn)
|
|
}
|