-
Notifications
You must be signed in to change notification settings - Fork 781
/
validate.go
254 lines (219 loc) · 9.08 KB
/
validate.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
package validation
import (
"fmt"
"net/http"
"strings"
"time"
"github.com/go-kit/kit/log"
"github.com/go-kit/kit/log/level"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/common/model"
"github.com/weaveworks/common/httpgrpc"
"github.com/cortexproject/cortex/pkg/ingester/client"
"github.com/cortexproject/cortex/pkg/util"
"github.com/cortexproject/cortex/pkg/util/extract"
)
const (
discardReasonLabel = "reason"
errMetadataMissingMetricName = "metadata missing metric name"
errMetadataTooLong = "metadata '%s' value too long: %.200q metric %.200q"
typeMetricName = "METRIC_NAME"
typeHelp = "HELP"
typeUnit = "UNIT"
metricNameTooLong = "metric_name_too_long"
helpTooLong = "help_too_long"
unitTooLong = "unit_too_long"
errMissingMetricName = "sample missing metric name"
errInvalidMetricName = "sample invalid metric name: %.200q"
errInvalidLabel = "sample invalid label: %.200q metric %.200q"
errLabelNameTooLong = "label name too long: %.200q metric %.200q"
errLabelValueTooLong = "label value too long: %.200q metric %.200q"
errTooManyLabels = "series has too many labels (actual: %d, limit: %d) series: '%s'"
errTooOld = "sample for '%s' has timestamp too old: %d"
errTooNew = "sample for '%s' has timestamp too new: %d"
errDuplicateLabelName = "duplicate label name: %.200q metric %.200q"
errLabelsNotSorted = "labels not sorted: %.200q metric %.200q"
// ErrQueryTooLong is used in chunk store, querier and query frontend.
ErrQueryTooLong = "the query time range exceeds the limit (query length: %s, limit: %s)"
missingMetricName = "missing_metric_name"
invalidMetricName = "metric_name_invalid"
greaterThanMaxSampleAge = "greater_than_max_sample_age"
maxLabelNamesPerSeries = "max_label_names_per_series"
tooFarInFuture = "too_far_in_future"
invalidLabel = "label_invalid"
labelNameTooLong = "label_name_too_long"
duplicateLabelNames = "duplicate_label_names"
labelsNotSorted = "labels_not_sorted"
labelValueTooLong = "label_value_too_long"
// RateLimited is one of the values for the reason to discard samples.
// Declared here to avoid duplication in ingester and distributor.
RateLimited = "rate_limited"
// Too many HA clusters is one of the reasons for discarding samples.
TooManyHAClusters = "too_many_ha_clusters"
)
// DiscardedSamples is a metric of the number of discarded samples, by reason.
var DiscardedSamples = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "cortex_discarded_samples_total",
Help: "The total number of samples that were discarded.",
},
[]string{discardReasonLabel, "user"},
)
// DiscardedMetadata is a metric of the number of discarded metadata, by reason.
var DiscardedMetadata = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "cortex_discarded_metadata_total",
Help: "The total number of metadata that were discarded.",
},
[]string{discardReasonLabel, "user"},
)
func init() {
prometheus.MustRegister(DiscardedSamples)
prometheus.MustRegister(DiscardedMetadata)
}
// SampleValidationConfig helps with getting required config to validate sample.
type SampleValidationConfig interface {
RejectOldSamples(userID string) bool
RejectOldSamplesMaxAge(userID string) time.Duration
CreationGracePeriod(userID string) time.Duration
}
// ValidateSample returns an err if the sample is invalid.
func ValidateSample(cfg SampleValidationConfig, userID string, metricName string, s client.Sample) error {
if cfg.RejectOldSamples(userID) && model.Time(s.TimestampMs) < model.Now().Add(-cfg.RejectOldSamplesMaxAge(userID)) {
DiscardedSamples.WithLabelValues(greaterThanMaxSampleAge, userID).Inc()
return httpgrpc.Errorf(http.StatusBadRequest, errTooOld, metricName, model.Time(s.TimestampMs))
}
if model.Time(s.TimestampMs) > model.Now().Add(cfg.CreationGracePeriod(userID)) {
DiscardedSamples.WithLabelValues(tooFarInFuture, userID).Inc()
return httpgrpc.Errorf(http.StatusBadRequest, errTooNew, metricName, model.Time(s.TimestampMs))
}
return nil
}
// LabelValidationConfig helps with getting required config to validate labels.
type LabelValidationConfig interface {
EnforceMetricName(userID string) bool
MaxLabelNamesPerSeries(userID string) int
MaxLabelNameLength(userID string) int
MaxLabelValueLength(userID string) int
}
// ValidateLabels returns an err if the labels are invalid.
func ValidateLabels(cfg LabelValidationConfig, userID string, ls []client.LabelAdapter, skipLabelNameValidation bool) error {
if cfg.EnforceMetricName(userID) {
metricName, err := extract.MetricNameFromLabelAdapters(ls)
if err != nil {
DiscardedSamples.WithLabelValues(missingMetricName, userID).Inc()
return httpgrpc.Errorf(http.StatusBadRequest, errMissingMetricName)
}
if !model.IsValidMetricName(model.LabelValue(metricName)) {
DiscardedSamples.WithLabelValues(invalidMetricName, userID).Inc()
return httpgrpc.Errorf(http.StatusBadRequest, errInvalidMetricName, metricName)
}
}
numLabelNames := len(ls)
if numLabelNames > cfg.MaxLabelNamesPerSeries(userID) {
DiscardedSamples.WithLabelValues(maxLabelNamesPerSeries, userID).Inc()
return httpgrpc.Errorf(http.StatusBadRequest, errTooManyLabels, numLabelNames, cfg.MaxLabelNamesPerSeries(userID), client.FromLabelAdaptersToMetric(ls).String())
}
maxLabelNameLength := cfg.MaxLabelNameLength(userID)
maxLabelValueLength := cfg.MaxLabelValueLength(userID)
lastLabelName := ""
for _, l := range ls {
var errTemplate string
var reason string
var cause interface{}
if !skipLabelNameValidation && !model.LabelName(l.Name).IsValid() {
reason = invalidLabel
errTemplate = errInvalidLabel
cause = l.Name
} else if len(l.Name) > maxLabelNameLength {
reason = labelNameTooLong
errTemplate = errLabelNameTooLong
cause = l.Name
} else if len(l.Value) > maxLabelValueLength {
reason = labelValueTooLong
errTemplate = errLabelValueTooLong
cause = l.Value
} else if cmp := strings.Compare(lastLabelName, l.Name); cmp >= 0 {
if cmp == 0 {
reason = duplicateLabelNames
errTemplate = errDuplicateLabelName
cause = l.Name
} else {
reason = labelsNotSorted
errTemplate = errLabelsNotSorted
cause = l.Name
}
}
if errTemplate != "" {
DiscardedSamples.WithLabelValues(reason, userID).Inc()
return httpgrpc.Errorf(http.StatusBadRequest, errTemplate, cause, formatLabelSet(ls))
}
lastLabelName = l.Name
}
return nil
}
// MetadataValidationConfig helps with getting required config to validate metadata.
type MetadataValidationConfig interface {
EnforceMetadataMetricName(userID string) bool
MaxMetadataLength(userID string) int
}
// ValidateMetadata returns an err if a metric metadata is invalid.
func ValidateMetadata(cfg MetadataValidationConfig, userID string, metadata *client.MetricMetadata) error {
if cfg.EnforceMetadataMetricName(userID) && metadata.GetMetricFamilyName() == "" {
DiscardedMetadata.WithLabelValues(missingMetricName, userID).Inc()
return httpgrpc.Errorf(http.StatusBadRequest, errMetadataMissingMetricName)
}
maxMetadataValueLength := cfg.MaxMetadataLength(userID)
var reason string
var cause string
var metadataType string
if len(metadata.GetMetricFamilyName()) > maxMetadataValueLength {
metadataType = typeMetricName
reason = metricNameTooLong
cause = metadata.GetMetricFamilyName()
} else if len(metadata.Help) > maxMetadataValueLength {
metadataType = typeHelp
reason = helpTooLong
cause = metadata.Help
} else if len(metadata.Unit) > maxMetadataValueLength {
metadataType = typeUnit
reason = unitTooLong
cause = metadata.Unit
}
if reason != "" {
DiscardedMetadata.WithLabelValues(reason, userID).Inc()
return httpgrpc.Errorf(http.StatusBadRequest, errMetadataTooLong, metadataType, cause, metadata.GetMetricFamilyName())
}
return nil
}
// this function formats label adapters as a metric name with labels, while preserving
// label order, and keeping duplicates. If there are multiple "__name__" labels, only
// first one is used as metric name, other ones will be included as regular labels.
func formatLabelSet(ls []client.LabelAdapter) string {
metricName, hasMetricName := "", false
labelStrings := make([]string, 0, len(ls))
for _, l := range ls {
if l.Name == model.MetricNameLabel && !hasMetricName && l.Value != "" {
metricName = l.Value
hasMetricName = true
} else {
labelStrings = append(labelStrings, fmt.Sprintf("%s=%q", l.Name, l.Value))
}
}
if len(labelStrings) == 0 {
if hasMetricName {
return metricName
}
return "{}"
}
return fmt.Sprintf("%s{%s}", metricName, strings.Join(labelStrings, ", "))
}
func DeletePerUserValidationMetrics(userID string, log log.Logger) {
filter := map[string]string{"user": userID}
if err := util.DeleteMatchingLabels(DiscardedSamples, filter); err != nil {
level.Warn(log).Log("msg", "failed to remove cortex_discarded_samples_total metric for user", "user", userID, "err", err)
}
if err := util.DeleteMatchingLabels(DiscardedMetadata, filter); err != nil {
level.Warn(log).Log("msg", "failed to remove cortex_discarded_metadata_total metric for user", "user", userID, "err", err)
}
}