Skip to content

Commit

Permalink
Alerting: Improve Prometheus Alert Rule error message (grafana#29390)
Browse files Browse the repository at this point in the history
* provide better ctx for prom err

* rework

* Update pkg/tsdb/prometheus/prometheus.go

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>

* Update pkg/tsdb/prometheus/prometheus.go

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>

* call func

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
  • Loading branch information
wbrowne and aknuds1 authored Nov 26, 2020
1 parent 06e48cb commit d10a8b2
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 6 deletions.
23 changes: 18 additions & 5 deletions pkg/services/alerting/conditions/query.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import (
"strings"
"time"

"github.com/grafana/grafana/pkg/tsdb/prometheus"

gocontext "context"

"github.com/grafana/grafana-plugin-sdk-go/data"
Expand Down Expand Up @@ -159,11 +161,7 @@ func (c *QueryCondition) executeQuery(context *alerting.EvalContext, timeRange *

resp, err := c.HandleRequest(context.Ctx, getDsInfo.Result, req)
if err != nil {
if errors.Is(err, gocontext.DeadlineExceeded) {
return nil, fmt.Errorf("alert execution exceeded the timeout")
}

return nil, fmt.Errorf("tsdb.HandleRequest() error %v", err)
return nil, toCustomError(err)
}

for _, v := range resp.Results {
Expand Down Expand Up @@ -360,3 +358,18 @@ func FrameToSeriesSlice(frame *data.Frame) (tsdb.TimeSeriesSlice, error) {

return seriesSlice, nil
}

func toCustomError(err error) error {
// is context timeout
if errors.Is(err, gocontext.DeadlineExceeded) {
return fmt.Errorf("alert execution exceeded the timeout")
}

// is Prometheus error
if prometheus.IsAPIError(err) {
return prometheus.ConvertAPIError(err)
}

// generic fallback
return fmt.Errorf("tsdb.HandleRequest() error %v", err)
}
18 changes: 17 additions & 1 deletion pkg/tsdb/prometheus/prometheus.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package prometheus

import (
"context"
"errors"
"fmt"
"regexp"
"strings"
Expand All @@ -15,7 +16,7 @@ import (
"github.com/grafana/grafana/pkg/infra/log"
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/tsdb"
api "github.com/prometheus/client_golang/api"
"github.com/prometheus/client_golang/api"
apiv1 "github.com/prometheus/client_golang/api/prometheus/v1"
"github.com/prometheus/common/model"
)
Expand Down Expand Up @@ -216,3 +217,18 @@ func parseResponse(value model.Value, query *PrometheusQuery) (*tsdb.QueryResult

return queryRes, nil
}

func IsAPIError(err error) bool {
// Have to use errors.As to compare Prometheus errors, since errors.Is won't work due to Prometheus
// errors being pointers and errors.Is ends up comparing them by pointer address
var e *apiv1.Error
return errors.As(err, &e)
}

func ConvertAPIError(err error) error {
var e *apiv1.Error
if errors.As(err, &e) {
return fmt.Errorf("%s: %s", e.Msg, e.Detail)
}
return err
}

0 comments on commit d10a8b2

Please sign in to comment.