/
rules.go
222 lines (185 loc) · 7.41 KB
/
rules.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
// Copyright 2022 The prometheus-operator 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 operator
import (
"errors"
"fmt"
"strings"
"github.com/blang/semver/v4"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/prometheus/prometheus/model/rulefmt"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/client-go/tools/record"
"sigs.k8s.io/yaml"
monitoringv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
"github.com/prometheus-operator/prometheus-operator/pkg/informers"
"github.com/prometheus-operator/prometheus-operator/pkg/k8sutil"
namespacelabeler "github.com/prometheus-operator/prometheus-operator/pkg/namespacelabeler"
)
type RuleConfigurationFormat int
const (
PrometheusFormat RuleConfigurationFormat = iota
ThanosFormat
)
type PrometheusRuleSelector struct {
ruleFormat RuleConfigurationFormat
version semver.Version
ruleSelector labels.Selector
nsLabeler *namespacelabeler.Labeler
ruleInformer *informers.ForResource
eventRecorder record.EventRecorder
logger log.Logger
}
func NewPrometheusRuleSelector(ruleFormat RuleConfigurationFormat, version string, labelSelector *metav1.LabelSelector, nsLabeler *namespacelabeler.Labeler, ruleInformer *informers.ForResource, eventRecorder record.EventRecorder, logger log.Logger) (*PrometheusRuleSelector, error) {
componentVersion, err := semver.ParseTolerant(version)
if err != nil {
return nil, fmt.Errorf("failed to parse version: %w", err)
}
ruleSelector, err := metav1.LabelSelectorAsSelector(labelSelector)
if err != nil {
return nil, fmt.Errorf("convert rule label selector to selector: %w", err)
}
return &PrometheusRuleSelector{
ruleFormat: ruleFormat,
version: componentVersion,
ruleSelector: ruleSelector,
nsLabeler: nsLabeler,
ruleInformer: ruleInformer,
eventRecorder: eventRecorder,
logger: logger,
}, nil
}
func (prs *PrometheusRuleSelector) generateRulesConfiguration(promRule *monitoringv1.PrometheusRule) (string, error) {
logger := log.With(prs.logger, "prometheusrule", promRule.Name, "prometheusrule-namespace", promRule.Namespace)
promRuleSpec := promRule.Spec
promRuleSpec = prs.sanitizePrometheusRulesSpec(promRuleSpec, logger)
content, err := yaml.Marshal(promRuleSpec)
if err != nil {
return "", fmt.Errorf("failed to marshal content: %w", err)
}
errs := ValidateRule(promRuleSpec)
if len(errs) != 0 {
const m = "Invalid rule"
level.Debug(logger).Log("msg", m, "content", content)
for _, err := range errs {
level.Info(logger).Log("msg", m, "err", err)
}
return "", errors.New(m)
}
return string(content), nil
}
// sanitizePrometheusRulesSpec sanitizes the PrometheusRules spec depending on the Prometheus/Thanos version.
func (prs *PrometheusRuleSelector) sanitizePrometheusRulesSpec(promRuleSpec monitoringv1.PrometheusRuleSpec, logger log.Logger) monitoringv1.PrometheusRuleSpec {
minVersionKeepFiringFor := semver.MustParse("2.42.0")
minVersionLimits := semver.MustParse("2.31.0")
component := "Prometheus"
if prs.ruleFormat == ThanosFormat {
minVersionKeepFiringFor = semver.MustParse("0.34.0")
minVersionLimits = semver.MustParse("0.24.0")
component = "Thanos"
}
for i := range promRuleSpec.Groups {
if promRuleSpec.Groups[i].Limit != nil && prs.version.LT(minVersionLimits) {
promRuleSpec.Groups[i].Limit = nil
level.Warn(logger).Log("msg", fmt.Sprintf("ignoring `limit` not supported by %s", component), "minimum_version", minVersionLimits)
}
if prs.ruleFormat == PrometheusFormat {
// Unset partialResponseStrategy field.
promRuleSpec.Groups[i].PartialResponseStrategy = ""
}
for j := range promRuleSpec.Groups[i].Rules {
if promRuleSpec.Groups[i].Rules[j].KeepFiringFor != nil && prs.version.LT(minVersionKeepFiringFor) {
promRuleSpec.Groups[i].Rules[j].KeepFiringFor = nil
level.Warn(logger).Log("msg", fmt.Sprintf("ignoring 'keep_firing_for' not supported by %s", component), "minimum_version", minVersionKeepFiringFor)
}
}
}
return promRuleSpec
}
// ValidateRule takes PrometheusRuleSpec and validates it using the upstream prometheus rule validator.
func ValidateRule(promRuleSpec monitoringv1.PrometheusRuleSpec) []error {
for i := range promRuleSpec.Groups {
// The upstream Prometheus rule validator doesn't support the
// partial_response_strategy field.
promRuleSpec.Groups[i].PartialResponseStrategy = ""
// Empty durations need to be translated to nil to be omitted from the
// YAML ouptut otherwise the generated configuration will not be valid.
if promRuleSpec.Groups[i].Interval != nil && *promRuleSpec.Groups[i].Interval == "" {
promRuleSpec.Groups[i].Interval = nil
}
for j := range promRuleSpec.Groups[i].Rules {
if promRuleSpec.Groups[i].Rules[j].For != nil && *promRuleSpec.Groups[i].Rules[j].For == "" {
promRuleSpec.Groups[i].Rules[j].For = nil
}
}
}
content, err := yaml.Marshal(promRuleSpec)
if err != nil {
return []error{fmt.Errorf("failed to marshal content: %w", err)}
}
_, errs := rulefmt.Parse(content)
return errs
}
// Select selects PrometheusRules and translates them into native Prometheus/Thanos configurations.
// The second returned value is the number of rejected PrometheusRule objects.
func (prs *PrometheusRuleSelector) Select(namespaces []string) (map[string]string, int, error) {
promRules := map[string]*monitoringv1.PrometheusRule{}
for _, ns := range namespaces {
err := prs.ruleInformer.ListAllByNamespace(ns, prs.ruleSelector, func(obj interface{}) {
promRule := obj.(*monitoringv1.PrometheusRule).DeepCopy()
if err := k8sutil.AddTypeInformationToObject(promRule); err != nil {
level.Error(prs.logger).Log("msg", "failed to set rule type information", "namespace", ns, "err", err)
return
}
promRules[fmt.Sprintf("%v-%v-%v.yaml", promRule.Namespace, promRule.Name, promRule.UID)] = promRule
})
if err != nil {
return nil, 0, fmt.Errorf("failed to list prometheus rules in namespace %s: %w", ns, err)
}
}
var rejected int
rules := make(map[string]string, len(promRules))
for ruleName, promRule := range promRules {
var err error
var content string
if err := prs.nsLabeler.EnforceNamespaceLabel(promRule); err != nil {
continue
}
content, err = prs.generateRulesConfiguration(promRule)
if err != nil {
rejected++
level.Warn(prs.logger).Log(
"msg", "skipping prometheusrule",
"error", err.Error(),
"prometheusrule", promRule.Name,
"namespace", promRule.Namespace,
)
prs.eventRecorder.Eventf(promRule, v1.EventTypeWarning, "InvalidConfiguration", "PrometheusRule %s was rejected due to invalid configuration: %v", promRule.Name, err)
continue
}
rules[ruleName] = content
}
ruleNames := []string{}
for name := range rules {
ruleNames = append(ruleNames, name)
}
level.Debug(prs.logger).Log(
"msg", "selected Rules",
"rules", strings.Join(ruleNames, ","),
)
return rules, rejected, nil
}