mirror of https://github.com/grafana/grafana.git
291 lines
10 KiB
Go
291 lines
10 KiB
Go
package api
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"net/http"
|
|
"net/url"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/benbjohnson/clock"
|
|
amv2 "github.com/prometheus/alertmanager/api/v2/models"
|
|
|
|
"github.com/grafana/alerting/models"
|
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
|
|
|
"github.com/grafana/grafana-plugin-sdk-go/data"
|
|
|
|
"github.com/grafana/grafana/pkg/api/response"
|
|
"github.com/grafana/grafana/pkg/apimachinery/identity"
|
|
"github.com/grafana/grafana/pkg/infra/log"
|
|
"github.com/grafana/grafana/pkg/infra/tracing"
|
|
contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model"
|
|
"github.com/grafana/grafana/pkg/services/dashboards"
|
|
"github.com/grafana/grafana/pkg/services/datasources"
|
|
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
|
"github.com/grafana/grafana/pkg/services/folder"
|
|
. "github.com/grafana/grafana/pkg/services/ngalert/api/compat"
|
|
apimodels "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
|
|
apivalidation "github.com/grafana/grafana/pkg/services/ngalert/api/validation"
|
|
"github.com/grafana/grafana/pkg/services/ngalert/backtesting"
|
|
"github.com/grafana/grafana/pkg/services/ngalert/eval"
|
|
ngmodels "github.com/grafana/grafana/pkg/services/ngalert/models"
|
|
"github.com/grafana/grafana/pkg/services/ngalert/state"
|
|
"github.com/grafana/grafana/pkg/services/ngalert/store"
|
|
"github.com/grafana/grafana/pkg/setting"
|
|
"github.com/grafana/grafana/pkg/util"
|
|
)
|
|
|
|
type folderService interface {
|
|
GetNamespaceByUID(ctx context.Context, uid string, orgID int64, user identity.Requester) (*folder.Folder, error)
|
|
}
|
|
|
|
type TestingApiSrv struct {
|
|
*AlertingProxy
|
|
DatasourceCache datasources.CacheService
|
|
log log.Logger
|
|
authz RuleAccessControlService
|
|
evaluator eval.EvaluatorFactory
|
|
cfg *setting.UnifiedAlertingSettings
|
|
backtesting *backtesting.Engine
|
|
featureManager featuremgmt.FeatureToggles
|
|
appUrl *url.URL
|
|
tracer tracing.Tracer
|
|
folderService folderService
|
|
}
|
|
|
|
// RouteTestGrafanaRuleConfig returns a list of potential alerts for a given rule configuration. This 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 send.
|
|
func (srv TestingApiSrv) RouteTestGrafanaRuleConfig(c *contextmodel.ReqContext, body apimodels.PostableExtendedRuleNodeExtended) response.Response {
|
|
folder, err := srv.folderService.GetNamespaceByUID(c.Req.Context(), body.NamespaceUID, c.OrgID, c.SignedInUser)
|
|
if err != nil {
|
|
return toNamespaceErrorResponse(dashboards.ErrFolderAccessDenied)
|
|
}
|
|
rule, err := apivalidation.ValidateRuleNode(
|
|
&body.Rule,
|
|
body.RuleGroup,
|
|
srv.cfg.BaseInterval,
|
|
c.GetOrgID(),
|
|
folder.UID,
|
|
apivalidation.RuleLimitsFromConfig(srv.cfg, srv.featureManager),
|
|
)
|
|
if err != nil {
|
|
return ErrResp(http.StatusBadRequest, err, "")
|
|
}
|
|
|
|
if err := srv.authz.AuthorizeDatasourceAccessForRule(c.Req.Context(), c.SignedInUser, rule); err != nil {
|
|
return response.ErrOrFallback(http.StatusInternalServerError, "failed to authorize access to rule group", err)
|
|
}
|
|
|
|
if srv.featureManager.IsEnabled(c.Req.Context(), featuremgmt.FlagAlertingQueryOptimization) {
|
|
if _, err := store.OptimizeAlertQueries(rule.Data); err != nil {
|
|
return ErrResp(http.StatusInternalServerError, err, "Failed to optimize query")
|
|
}
|
|
}
|
|
|
|
evaluator, err := srv.evaluator.Create(eval.NewContext(c.Req.Context(), c.SignedInUser), rule.GetEvalCondition().WithSource("preview"))
|
|
if err != nil {
|
|
return ErrResp(http.StatusBadRequest, err, "Failed to build evaluator for queries and expressions")
|
|
}
|
|
|
|
now := time.Now()
|
|
results, err := evaluator.Evaluate(c.Req.Context(), now)
|
|
if err != nil {
|
|
return ErrResp(http.StatusInternalServerError, err, "Failed to evaluate queries")
|
|
}
|
|
|
|
cfg := state.ManagerCfg{
|
|
Metrics: nil,
|
|
ExternalURL: srv.appUrl,
|
|
InstanceStore: nil,
|
|
Images: &backtesting.NoopImageService{},
|
|
Clock: clock.New(),
|
|
Historian: nil,
|
|
Tracer: srv.tracer,
|
|
Log: log.New("ngalert.state.manager"),
|
|
}
|
|
manager := state.NewManager(cfg, state.NewNoopPersister())
|
|
includeFolder := !srv.cfg.ReservedLabels.IsReservedLabelDisabled(models.FolderTitleLabel)
|
|
transitions := manager.ProcessEvalResults(
|
|
c.Req.Context(),
|
|
now,
|
|
rule,
|
|
results,
|
|
state.GetRuleExtraLabels(log.New("testing"), rule, folder.Fullpath, includeFolder),
|
|
nil,
|
|
)
|
|
|
|
alerts := make([]*amv2.PostableAlert, 0, len(transitions))
|
|
for _, alertState := range transitions {
|
|
alerts = append(alerts, state.StateToPostableAlert(alertState, srv.appUrl, srv.featureManager))
|
|
}
|
|
|
|
return response.JSON(http.StatusOK, alerts)
|
|
}
|
|
|
|
func (srv TestingApiSrv) RouteTestRuleConfig(c *contextmodel.ReqContext, body apimodels.TestRulePayload, datasourceUID string) response.Response {
|
|
if body.Type() != apimodels.LoTexRulerBackend {
|
|
return errorToResponse(backendTypeDoesNotMatchPayloadTypeError(apimodels.LoTexRulerBackend, body.Type().String()))
|
|
}
|
|
ds, err := getDatasourceByUID(c, srv.DatasourceCache, apimodels.LoTexRulerBackend)
|
|
if err != nil {
|
|
return errorToResponse(err)
|
|
}
|
|
var path string
|
|
switch ds.Type {
|
|
case "loki":
|
|
path = "loki/api/v1/query"
|
|
case "prometheus":
|
|
path = "api/v1/query"
|
|
default:
|
|
// this should not happen because getDatasourceByUID would not return the data source
|
|
return errorToResponse(unexpectedDatasourceTypeError(ds.Type, "loki, prometheus"))
|
|
}
|
|
|
|
t := timeNow()
|
|
queryURL, err := url.Parse(path)
|
|
if err != nil {
|
|
return ErrResp(http.StatusInternalServerError, err, "failed to parse url")
|
|
}
|
|
params := queryURL.Query()
|
|
params.Set("query", body.Expr)
|
|
params.Set("time", strconv.FormatInt(t.Unix(), 10))
|
|
queryURL.RawQuery = params.Encode()
|
|
return srv.withReq(
|
|
c,
|
|
http.MethodGet,
|
|
queryURL,
|
|
nil,
|
|
instantQueryResultsExtractor,
|
|
nil,
|
|
)
|
|
}
|
|
|
|
func (srv TestingApiSrv) RouteEvalQueries(c *contextmodel.ReqContext, cmd apimodels.EvalQueriesPayload) response.Response {
|
|
queries := AlertQueriesFromApiAlertQueries(cmd.Data)
|
|
if err := srv.authz.AuthorizeDatasourceAccessForRule(c.Req.Context(), c.SignedInUser, &ngmodels.AlertRule{Data: queries}); err != nil {
|
|
return response.ErrOrFallback(http.StatusInternalServerError, "failed to authorize access to data sources", err)
|
|
}
|
|
|
|
cond := ngmodels.Condition{
|
|
Condition: cmd.Condition,
|
|
Data: queries,
|
|
}
|
|
if cond.Condition == "" && len(cond.Data) > 0 {
|
|
cond.Condition = cond.Data[len(cond.Data)-1].RefID
|
|
}
|
|
|
|
var optimizations []store.Optimization
|
|
if srv.featureManager.IsEnabled(c.Req.Context(), featuremgmt.FlagAlertingQueryOptimization) {
|
|
var err error
|
|
optimizations, err = store.OptimizeAlertQueries(cond.Data)
|
|
if err != nil {
|
|
return ErrResp(http.StatusInternalServerError, err, "Failed to optimize query")
|
|
}
|
|
}
|
|
|
|
evaluator, err := srv.evaluator.Create(eval.NewContext(c.Req.Context(), c.SignedInUser), cond)
|
|
|
|
if err != nil {
|
|
return ErrResp(http.StatusBadRequest, err, "Failed to build evaluator for queries and expressions")
|
|
}
|
|
|
|
now := cmd.Now
|
|
if now.IsZero() {
|
|
now = timeNow()
|
|
}
|
|
|
|
evalResults, err := evaluator.EvaluateRaw(c.Req.Context(), now)
|
|
|
|
if err != nil {
|
|
return ErrResp(http.StatusInternalServerError, err, "Failed to evaluate queries and expressions")
|
|
}
|
|
|
|
addOptimizedQueryWarnings(evalResults, optimizations)
|
|
return response.JSONStreaming(http.StatusOK, evalResults)
|
|
}
|
|
|
|
// addOptimizedQueryWarnings adds warnings to the query results for any queries that were optimized.
|
|
func addOptimizedQueryWarnings(evalResults *backend.QueryDataResponse, optimizations []store.Optimization) {
|
|
for _, opt := range optimizations {
|
|
if res, ok := evalResults.Responses[opt.RefID]; ok {
|
|
if len(res.Frames) > 0 {
|
|
res.Frames[0].AppendNotices(data.Notice{
|
|
Severity: data.NoticeSeverityWarning,
|
|
Text: "Query optimized from Range to Instant type; all uses exclusively require the last datapoint. " +
|
|
"Consider modifying your query to Instant type to ensure accuracy.", // Currently this is the only optimization we do.
|
|
})
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func (srv TestingApiSrv) BacktestAlertRule(c *contextmodel.ReqContext, cmd apimodels.BacktestConfig) response.Response {
|
|
if !srv.featureManager.IsEnabled(c.Req.Context(), featuremgmt.FlagAlertingBacktesting) {
|
|
return ErrResp(http.StatusNotFound, nil, "Backgtesting API is not enabled")
|
|
}
|
|
|
|
if cmd.From.After(cmd.To) {
|
|
return ErrResp(400, nil, "From cannot be greater than To")
|
|
}
|
|
|
|
noDataState, err := ngmodels.NoDataStateFromString(string(cmd.NoDataState))
|
|
|
|
if err != nil {
|
|
return ErrResp(400, err, "")
|
|
}
|
|
forInterval := time.Duration(cmd.For)
|
|
if forInterval < 0 {
|
|
return ErrResp(400, nil, "Bad For interval")
|
|
}
|
|
|
|
intervalSeconds, err := apivalidation.ValidateInterval(time.Duration(cmd.Interval), srv.cfg.BaseInterval)
|
|
if err != nil {
|
|
return ErrResp(400, err, "")
|
|
}
|
|
|
|
queries := AlertQueriesFromApiAlertQueries(cmd.Data)
|
|
if err := srv.authz.AuthorizeDatasourceAccessForRule(c.Req.Context(), c.SignedInUser, &ngmodels.AlertRule{Data: queries}); err != nil {
|
|
return errorToResponse(err)
|
|
}
|
|
|
|
rule := &ngmodels.AlertRule{
|
|
// ID: 0,
|
|
// Updated: time.Time{},
|
|
// Version: 0,
|
|
// NamespaceUID: "",
|
|
// DashboardUID: nil,
|
|
// PanelID: nil,
|
|
// RuleGroup: "",
|
|
// RuleGroupIndex: 0,
|
|
// ExecErrState: "",
|
|
Title: cmd.Title,
|
|
// prefix backtesting- is to distinguish between executions of regular rule and backtesting in logs (like expression engine, evaluator, state manager etc)
|
|
UID: "backtesting-" + util.GenerateShortUID(),
|
|
OrgID: c.GetOrgID(),
|
|
Condition: cmd.Condition,
|
|
Data: queries,
|
|
IntervalSeconds: intervalSeconds,
|
|
NoDataState: noDataState,
|
|
For: forInterval,
|
|
Annotations: cmd.Annotations,
|
|
Labels: cmd.Labels,
|
|
}
|
|
|
|
result, err := srv.backtesting.Test(c.Req.Context(), c.SignedInUser, rule, cmd.From, cmd.To)
|
|
if err != nil {
|
|
if errors.Is(err, backtesting.ErrInvalidInputData) {
|
|
return ErrResp(400, err, "Failed to evaluate")
|
|
}
|
|
return ErrResp(500, err, "Failed to evaluate")
|
|
}
|
|
|
|
body, err := data.FrameToJSON(result, data.IncludeAll)
|
|
if err != nil {
|
|
return ErrResp(500, err, "Failed to convert frame to JSON")
|
|
}
|
|
return response.JSON(http.StatusOK, body)
|
|
}
|