Update prometheus to v2.16.0 (#2088)

* Updated Prometheus to 22a04239c937be61df95fdb60f0661684693cf3b (v2.16.0-rc.0) Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Added SelectSorted method. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Use activity tracker to limit concurrency. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Added SelectSorted method. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Use ActiveQueryTracker for limiting concurrent queries. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Added legacy_rulefmt from Prometheus, before latest change to yaml.Node. That change is currently incompatible with our serialization code, so until that is fixed, I've copied previous state of rulefmt from Prometheus (github.com/prometheus/prometheus/pkg/rulefmt). It's a small package, and I've included tests as well. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Pass logger to activity tracker. Log directory for debugging. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Renamed legacy_rulefmt package back to rulefmt. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Use legacy_rulefmt import name. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Clean tempdir after test has completed. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Added -querier.active-query-tracker-dir flag Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Added CHANGELOG.md about new querier.active-query-tracker-dir flag Also explains why we use temp dir, if it's not configured. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * make doc Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Updated Prometheus to v2.16.0-rc.1 (56eaaadb54560d124310dcd779b81a4c5fe654cc) Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Updated Prometheus to 2.16.0 (b90be6f32a33c03163d700e1452b54454ddce0ec) Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Active query tracker documentation. Disable AQT if no directory is set. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Updated CHANGELOG.md Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Swap Select and SelectSorted. Since our Select methods already return sorted results, it makes sense to call them SelectSorted, and let Select simply call SelectSorted, rather then the other way around. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Updated docs Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * No need to log directory used by active query tracker anymore. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Ignore active-query-tracker, it is default dir name for Active Query Tracker Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Fixed active_query_tracker_dir yaml field name to match CLI option. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Fake RemoteAddr if it is empty. Prometheus requires non-empty RemoteAddr, but only uses it when Engine actually has QueryLogger set. Which it doesn't, in Cortex. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Add SelectSorted method to blocksQuerier. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Added comment about possible removal in the future. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Fix compilation and test issues after master rebase. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Go mod tidy Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Lint Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com> * Review feedback. Also fixed impls -> implements. Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com>
grafana · Sep 9, 2021 · 2019c9a · 2019c9a
1 parent ec54a56
commit 2019c9a
Show file tree

Hide file tree

Showing 18 changed files with 554 additions and 51 deletions.
diff --git a/pkg/ruler/api_test.go b/pkg/ruler/api_test.go
@@ -15,7 +15,8 @@ func TestRuler_rules(t *testing.T) {
 	cfg, cleanup := defaultRulerConfig(newMockRuleStore(mockRules))
 	defer cleanup()
 
-	r := newTestRuler(t, cfg)
+	r, rcleanup := newTestRuler(t, cfg)
+	defer rcleanup()
 	defer r.Stop()
 
 	req := httptest.NewRequest("GET", "https://localhost:8080/api/prom/api/v1/rules", nil)
@@ -70,7 +71,8 @@ func TestRuler_alerts(t *testing.T) {
 	cfg, cleanup := defaultRulerConfig(newMockRuleStore(mockRules))
 	defer cleanup()
 
-	r := newTestRuler(t, cfg)
+	r, rcleanup := newTestRuler(t, cfg)
+	defer rcleanup()
 	defer r.Stop()
 
 	req := httptest.NewRequest("GET", "https://localhost:8080/api/prom/api/v1/alerts", nil)

diff --git a/pkg/ruler/legacy_rulefmt/rulefmt.go b/pkg/ruler/legacy_rulefmt/rulefmt.go
@@ -0,0 +1,216 @@
+// Copyright 2017 The Prometheus Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package rulefmt
+
+import (
+	"context"
+	"io/ioutil"
+	"strings"
+	"time"
+
+	"github.com/pkg/errors"
+	"github.com/prometheus/common/model"
+	yaml "gopkg.in/yaml.v2"
+
+	"github.com/prometheus/prometheus/pkg/timestamp"
+	"github.com/prometheus/prometheus/promql"
+	"github.com/prometheus/prometheus/template"
+)
+
+// Error represents semantic errors on parsing rule groups.
+type Error struct {
+	Group    string
+	Rule     int
+	RuleName string
+	Err      error
+}
+
+func (err *Error) Error() string {
+	return errors.Wrapf(err.Err, "group %q, rule %d, %q", err.Group, err.Rule, err.RuleName).Error()
+}
+
+// RuleGroups is a set of rule groups that are typically exposed in a file.
+type RuleGroups struct {
+	Groups []RuleGroup `yaml:"groups"`
+}
+
+// Validate validates all rules in the rule groups.
+func (g *RuleGroups) Validate() (errs []error) {
+	set := map[string]struct{}{}
+
+	for _, g := range g.Groups {
+		if g.Name == "" {
+			errs = append(errs, errors.Errorf("Groupname should not be empty"))
+		}
+
+		if _, ok := set[g.Name]; ok {
+			errs = append(
+				errs,
+				errors.Errorf("groupname: \"%s\" is repeated in the same file", g.Name),
+			)
+		}
+
+		set[g.Name] = struct{}{}
+
+		for i, r := range g.Rules {
+			for _, err := range r.Validate() {
+				var ruleName string
+				if r.Alert != "" {
+					ruleName = r.Alert
+				} else {
+					ruleName = r.Record
+				}
+				errs = append(errs, &Error{
+					Group:    g.Name,
+					Rule:     i,
+					RuleName: ruleName,
+					Err:      err,
+				})
+			}
+		}
+	}
+
+	return errs
+}
+
+// RuleGroup is a list of sequentially evaluated recording and alerting rules.
+type RuleGroup struct {
+	Name     string         `yaml:"name"`
+	Interval model.Duration `yaml:"interval,omitempty"`
+	Rules    []Rule         `yaml:"rules"`
+}
+
+// Rule describes an alerting or recording rule.
+type Rule struct {
+	Record      string            `yaml:"record,omitempty"`
+	Alert       string            `yaml:"alert,omitempty"`
+	Expr        string            `yaml:"expr"`
+	For         model.Duration    `yaml:"for,omitempty"`
+	Labels      map[string]string `yaml:"labels,omitempty"`
+	Annotations map[string]string `yaml:"annotations,omitempty"`
+}
+
+// Validate the rule and return a list of encountered errors.
+func (r *Rule) Validate() (errs []error) {
+	if r.Record != "" && r.Alert != "" {
+		errs = append(errs, errors.Errorf("only one of 'record' and 'alert' must be set"))
+	}
+	if r.Record == "" && r.Alert == "" {
+		errs = append(errs, errors.Errorf("one of 'record' or 'alert' must be set"))
+	}
+
+	if r.Expr == "" {
+		errs = append(errs, errors.Errorf("field 'expr' must be set in rule"))
+	} else if _, err := promql.ParseExpr(r.Expr); err != nil {
+		errs = append(errs, errors.Wrap(err, "could not parse expression"))
+	}
+	if r.Record != "" {
+		if len(r.Annotations) > 0 {
+			errs = append(errs, errors.Errorf("invalid field 'annotations' in recording rule"))
+		}
+		if r.For != 0 {
+			errs = append(errs, errors.Errorf("invalid field 'for' in recording rule"))
+		}
+		if !model.IsValidMetricName(model.LabelValue(r.Record)) {
+			errs = append(errs, errors.Errorf("invalid recording rule name: %s", r.Record))
+		}
+	}
+
+	for k, v := range r.Labels {
+		if !model.LabelName(k).IsValid() {
+			errs = append(errs, errors.Errorf("invalid label name: %s", k))
+		}
+
+		if !model.LabelValue(v).IsValid() {
+			errs = append(errs, errors.Errorf("invalid label value: %s", v))
+		}
+	}
+
+	for k := range r.Annotations {
+		if !model.LabelName(k).IsValid() {
+			errs = append(errs, errors.Errorf("invalid annotation name: %s", k))
+		}
+	}
+
+	return append(errs, testTemplateParsing(r)...)
+}
+
+// testTemplateParsing checks if the templates used in labels and annotations
+// of the alerting rules are parsed correctly.
+func testTemplateParsing(rl *Rule) (errs []error) {
+	if rl.Alert == "" {
+		// Not an alerting rule.
+		return errs
+	}
+
+	// Trying to parse templates.
+	tmplData := template.AlertTemplateData(map[string]string{}, map[string]string{}, 0)
+	defs := []string{
+		"{{$labels := .Labels}}",
+		"{{$externalLabels := .ExternalLabels}}",
+		"{{$value := .Value}}",
+	}
+	parseTest := func(text string) error {
+		tmpl := template.NewTemplateExpander(
+			context.TODO(),
+			strings.Join(append(defs, text), ""),
+			"__alert_"+rl.Alert,
+			tmplData,
+			model.Time(timestamp.FromTime(time.Now())),
+			nil,
+			nil,
+		)
+		return tmpl.ParseTest()
+	}
+
+	// Parsing Labels.
+	for k, val := range rl.Labels {
+		err := parseTest(val)
+		if err != nil {
+			errs = append(errs, errors.Wrapf(err, "label %q", k))
+		}
+	}
+
+	// Parsing Annotations.
+	for k, val := range rl.Annotations {
+		err := parseTest(val)
+		if err != nil {
+			errs = append(errs, errors.Wrapf(err, "annotation %q", k))
+		}
+	}
+
+	return errs
+}
+
+// Parse parses and validates a set of rules.
+func Parse(content []byte) (*RuleGroups, []error) {
+	var groups RuleGroups
+	if err := yaml.UnmarshalStrict(content, &groups); err != nil {
+		return nil, []error{err}
+	}
+	return &groups, groups.Validate()
+}
+
+// ParseFile reads and parses rules from a file.
+func ParseFile(file string) (*RuleGroups, []error) {
+	b, err := ioutil.ReadFile(file)
+	if err != nil {
+		return nil, []error{errors.Wrap(err, file)}
+	}
+	rgs, errs := Parse(b)
+	for i := range errs {
+		errs[i] = errors.Wrap(errs[i], file)
+	}
+	return rgs, errs
+}