-
Notifications
You must be signed in to change notification settings - Fork 0
/
compat.go
309 lines (263 loc) · 8 KB
/
compat.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
package manager
import (
"bytes"
"context"
"io/ioutil"
"strings"
"time"
"github.com/cortexproject/cortex/pkg/ruler"
"github.com/go-kit/kit/log"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/common/model"
"github.com/prometheus/prometheus/notifier"
"github.com/prometheus/prometheus/pkg/labels"
"github.com/prometheus/prometheus/pkg/rulefmt"
"github.com/prometheus/prometheus/pkg/timestamp"
"github.com/prometheus/prometheus/promql"
"github.com/prometheus/prometheus/promql/parser"
"github.com/prometheus/prometheus/rules"
"github.com/prometheus/prometheus/template"
"github.com/weaveworks/common/user"
yaml "gopkg.in/yaml.v3"
"github.com/metrico/loki-apache/pkg/logproto"
"github.com/metrico/loki-apache/pkg/logql"
)
// RulesLimits is the one function we need from limits.Overrides, and
// is here to limit coupling.
type RulesLimits interface {
EvaluationDelay(usedID string) time.Duration
}
// engineQueryFunc returns a new query function using the rules.EngineQueryFunc function
// and passing an altered timestamp.
func engineQueryFunc(engine *logql.Engine, overrides RulesLimits, userID string) rules.QueryFunc {
return rules.QueryFunc(func(ctx context.Context, qs string, t time.Time) (promql.Vector, error) {
adjusted := t.Add(-overrides.EvaluationDelay(userID))
params := logql.NewLiteralParams(
qs,
adjusted,
adjusted,
0,
0,
logproto.FORWARD,
0,
nil,
)
q := engine.Query(params)
res, err := q.Exec(ctx)
if err != nil {
return nil, err
}
switch v := res.Data.(type) {
case promql.Vector:
return v, nil
case promql.Scalar:
return promql.Vector{promql.Sample{
Point: promql.Point(v),
Metric: labels.Labels{},
}}, nil
default:
return nil, errors.New("rule result is not a vector or scalar")
}
})
}
// MultiTenantManagerAdapter will wrap a MultiTenantManager which validates loki rules
func MultiTenantManagerAdapter(mgr ruler.MultiTenantManager) ruler.MultiTenantManager {
return &MultiTenantManager{mgr}
}
// MultiTenantManager wraps a cortex MultiTenantManager but validates loki rules
type MultiTenantManager struct {
ruler.MultiTenantManager
}
// ValidateRuleGroup validates a rulegroup
func (m *MultiTenantManager) ValidateRuleGroup(grp rulefmt.RuleGroup) []error {
return ValidateGroups(grp)
}
func MemstoreTenantManager(
cfg ruler.Config,
engine *logql.Engine,
overrides RulesLimits,
) ruler.ManagerFactory {
var metrics *Metrics
return ruler.ManagerFactory(func(
ctx context.Context,
userID string,
notifier *notifier.Manager,
logger log.Logger,
reg prometheus.Registerer,
) ruler.RulesManager {
// We'll ignore the passed registere and use the default registerer to avoid prefix issues and other weirdness.
// This closure prevents re-registering.
if metrics == nil {
metrics = NewMetrics(prometheus.DefaultRegisterer)
}
logger = log.With(logger, "user", userID)
queryFunc := engineQueryFunc(engine, overrides, userID)
memStore := NewMemStore(userID, queryFunc, metrics, 5*time.Minute, log.With(logger, "subcomponent", "MemStore"))
mgr := rules.NewManager(&rules.ManagerOptions{
Appendable: NoopAppender{},
Queryable: memStore,
QueryFunc: queryFunc,
Context: user.InjectOrgID(ctx, userID),
ExternalURL: cfg.ExternalURL.URL,
NotifyFunc: ruler.SendAlerts(notifier, cfg.ExternalURL.URL.String()),
Logger: logger,
Registerer: reg,
OutageTolerance: cfg.OutageTolerance,
ForGracePeriod: cfg.ForGracePeriod,
ResendDelay: cfg.ResendDelay,
GroupLoader: GroupLoader{},
})
// initialize memStore, bound to the manager's alerting rules
memStore.Start(mgr)
return mgr
})
}
type GroupLoader struct{}
func (GroupLoader) Parse(query string) (parser.Expr, error) {
expr, err := logql.ParseExpr(query)
if err != nil {
return nil, err
}
return exprAdapter{expr}, nil
}
func (g GroupLoader) Load(identifier string) (*rulefmt.RuleGroups, []error) {
b, err := ioutil.ReadFile(identifier)
if err != nil {
return nil, []error{errors.Wrap(err, identifier)}
}
rgs, errs := g.parseRules(b)
for i := range errs {
errs[i] = errors.Wrap(errs[i], identifier)
}
return rgs, errs
}
func (GroupLoader) parseRules(content []byte) (*rulefmt.RuleGroups, []error) {
var (
groups rulefmt.RuleGroups
errs []error
)
decoder := yaml.NewDecoder(bytes.NewReader(content))
decoder.KnownFields(true)
if err := decoder.Decode(&groups); err != nil {
errs = append(errs, err)
}
if len(errs) > 0 {
return nil, errs
}
return &groups, ValidateGroups(groups.Groups...)
}
func ValidateGroups(grps ...rulefmt.RuleGroup) (errs []error) {
set := map[string]struct{}{}
for i, g := range grps {
if g.Name == "" {
errs = append(errs, errors.Errorf("group %d: Groupname must not be empty", i))
}
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 _, r := range g.Rules {
if err := validateRuleNode(&r); err != nil {
errs = append(errs, err)
}
}
}
return errs
}
func validateRuleNode(r *rulefmt.RuleNode) error {
if r.Record.Value != "" && r.Alert.Value != "" {
return errors.Errorf("only one of 'record' and 'alert' must be set")
}
if r.Record.Value == "" && r.Alert.Value == "" {
return errors.Errorf("one of 'record' or 'alert' must be set")
}
if r.Record.Value != "" && r.Alert.Value != "" {
return errors.Errorf("only one of 'record' or 'alert' must be set")
}
if r.Expr.Value == "" {
return errors.Errorf("field 'expr' must be set in rule")
} else if _, err := logql.ParseExpr(r.Expr.Value); err != nil {
return errors.Wrapf(err, "could not parse expression")
}
if r.Record.Value != "" {
if len(r.Annotations) > 0 {
return errors.Errorf("invalid field 'annotations' in recording rule")
}
if r.For != 0 {
return errors.Errorf("invalid field 'for' in recording rule")
}
if !model.IsValidMetricName(model.LabelValue(r.Record.Value)) {
return errors.Errorf("invalid recording rule name: %s", r.Record.Value)
}
}
for k, v := range r.Labels {
if !model.LabelName(k).IsValid() || k == model.MetricNameLabel {
return errors.Errorf("invalid label name: %s", k)
}
if !model.LabelValue(v).IsValid() {
return errors.Errorf("invalid label value: %s", v)
}
}
for k := range r.Annotations {
if !model.LabelName(k).IsValid() {
return errors.Errorf("invalid annotation name: %s", k)
}
}
for _, err := range testTemplateParsing(r) {
return err
}
return nil
}
// testTemplateParsing checks if the templates used in labels and annotations
// of the alerting rules are parsed correctly.
func testTemplateParsing(rl *rulefmt.RuleNode) (errs []error) {
if rl.Alert.Value == "" {
// 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.Value,
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
}
// Allows logql expressions to be treated as promql expressions by the prometheus rules pkg.
type exprAdapter struct {
logql.Expr
}
func (exprAdapter) PositionRange() parser.PositionRange { return parser.PositionRange{} }
func (exprAdapter) PromQLExpr() {}
func (exprAdapter) Type() parser.ValueType { return parser.ValueType("unimplemented") }