-
Notifications
You must be signed in to change notification settings - Fork 455
/
ruler.go
1336 lines (1117 loc) · 50.3 KB
/
ruler.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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// SPDX-License-Identifier: AGPL-3.0-only
// Provenance-includes-location: https://github.com/cortexproject/cortex/blob/master/pkg/ruler/ruler.go
// Provenance-includes-license: Apache-2.0
// Provenance-includes-copyright: The Cortex Authors.
package ruler
import (
"context"
"flag"
"fmt"
"hash/fnv"
"net/http"
"net/url"
"path/filepath"
"strings"
"sync"
"time"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/grafana/dskit/concurrency"
"github.com/grafana/dskit/flagext"
"github.com/grafana/dskit/grpcclient"
"github.com/grafana/dskit/kv"
"github.com/grafana/dskit/multierror"
"github.com/grafana/dskit/ring"
"github.com/grafana/dskit/services"
"github.com/grafana/dskit/tenant"
"github.com/grafana/dskit/user"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/prometheus/prometheus/model/rulefmt"
promRules "github.com/prometheus/prometheus/rules"
"golang.org/x/sync/errgroup"
"github.com/grafana/mimir/pkg/mimirpb"
"github.com/grafana/mimir/pkg/ruler/rulespb"
"github.com/grafana/mimir/pkg/ruler/rulestore"
"github.com/grafana/mimir/pkg/storage/tsdb/bucketcache"
"github.com/grafana/mimir/pkg/util"
util_log "github.com/grafana/mimir/pkg/util/log"
"github.com/grafana/mimir/pkg/util/spanlogger"
"github.com/grafana/mimir/pkg/util/validation"
)
var (
errInvalidTenantShardSize = errors.New("invalid tenant shard size, the value must be greater or equal to 0")
)
const (
// RulerRingKey is the key under which we store the rulers ring in the KVStore.
RulerRingKey = "ring"
)
type rulesSyncReason string
const (
// Number of concurrent group list and group loads operations.
loadRulesConcurrency = 10
fetchRulesConcurrency = 16
rulerSyncReasonInitial rulesSyncReason = "initial"
rulerSyncReasonPeriodic rulesSyncReason = "periodic"
rulerSyncReasonRingChange rulesSyncReason = "ring-change"
rulerSyncReasonAPIChange rulesSyncReason = "api-change"
// rulerPeriodicSyncJitter is the jitter applied to the interval used by the periodic sync.
rulerPeriodicSyncJitter = 0.1
// Limit errors
errMaxRuleGroupsPerUserLimitExceeded = "per-user rule groups limit (limit: %d actual: %d) exceeded"
errMaxRulesPerRuleGroupPerUserLimitExceeded = "per-user rules per rule group limit (limit: %d actual: %d) exceeded"
// errors
errListAllUser = "unable to list the ruler users"
)
var (
rulerSyncReasons = []rulesSyncReason{
rulerSyncReasonInitial,
rulerSyncReasonPeriodic,
rulerSyncReasonRingChange,
rulerSyncReasonAPIChange,
}
)
// Config is the configuration for the recording rules server.
type Config struct {
// This is used for template expansion in alerts; must be a valid URL.
ExternalURL flagext.URLValue `yaml:"external_url"`
// GRPC Client configuration.
ClientTLSConfig grpcclient.Config `yaml:"ruler_client" doc:"description=Configures the gRPC client used to communicate between ruler instances."`
// How frequently to evaluate rules by default.
EvaluationInterval time.Duration `yaml:"evaluation_interval" category:"advanced"`
// How frequently to poll for updated rules.
PollInterval time.Duration `yaml:"poll_interval" category:"advanced"`
// Path to store rule files for prom manager.
RulePath string `yaml:"rule_path"`
// URL of the Alertmanager to send notifications to.
AlertmanagerURL string `yaml:"alertmanager_url"`
// How long to wait between refreshing the list of Alertmanager based on DNS service discovery.
AlertmanagerRefreshInterval time.Duration `yaml:"alertmanager_refresh_interval" category:"advanced"`
// Capacity of the queue for notifications to be sent to the Alertmanager.
NotificationQueueCapacity int `yaml:"notification_queue_capacity" category:"advanced"`
// HTTP timeout duration when sending notifications to the Alertmanager.
NotificationTimeout time.Duration `yaml:"notification_timeout" category:"advanced"`
// Client configs for interacting with the Alertmanager
Notifier NotifierConfig `yaml:"alertmanager_client"`
// Max time to tolerate outage for restoring "for" state of alert.
OutageTolerance time.Duration `yaml:"for_outage_tolerance" category:"advanced"`
// Minimum duration between alert and restored "for" state. This is maintained only for alerts with configured "for" time greater than grace period.
ForGracePeriod time.Duration `yaml:"for_grace_period" category:"advanced"`
// Minimum amount of time to wait before resending an alert to Alertmanager.
ResendDelay time.Duration `yaml:"resend_delay" category:"advanced"`
// Enable sharding rule groups.
Ring RingConfig `yaml:"ring"`
EnableAPI bool `yaml:"enable_api"`
EnabledTenants flagext.StringSliceCSV `yaml:"enabled_tenants" category:"advanced"`
DisabledTenants flagext.StringSliceCSV `yaml:"disabled_tenants" category:"advanced"`
EnableQueryStats bool `yaml:"query_stats_enabled" category:"advanced"`
QueryFrontend QueryFrontendConfig `yaml:"query_frontend"`
TenantFederation TenantFederationConfig `yaml:"tenant_federation"`
// Allow to override timers for testing purposes.
RingCheckPeriod time.Duration `yaml:"-"`
rulerSyncQueuePollFrequency time.Duration `yaml:"-"`
}
// Validate config and returns error on failure
func (cfg *Config) Validate(limits validation.Limits) error {
if limits.RulerTenantShardSize < 0 {
return errInvalidTenantShardSize
}
if err := cfg.ClientTLSConfig.Validate(); err != nil {
return errors.Wrap(err, "invalid ruler gRPC client config")
}
if err := cfg.QueryFrontend.Validate(); err != nil {
return errors.Wrap(err, "invalid ruler query-frontend config")
}
return nil
}
// RegisterFlags adds the flags required to config this to the given FlagSet
func (cfg *Config) RegisterFlags(f *flag.FlagSet, logger log.Logger) {
cfg.ClientTLSConfig.RegisterFlagsWithPrefix("ruler.client", f)
cfg.Ring.RegisterFlags(f, logger)
cfg.Notifier.RegisterFlags(f)
cfg.TenantFederation.RegisterFlags(f)
cfg.QueryFrontend.RegisterFlags(f)
cfg.ExternalURL.URL, _ = url.Parse("") // Must be non-nil
f.Var(&cfg.ExternalURL, "ruler.external.url", "URL of alerts return path.")
f.DurationVar(&cfg.EvaluationInterval, "ruler.evaluation-interval", 1*time.Minute, "How frequently to evaluate rules")
f.DurationVar(&cfg.PollInterval, "ruler.poll-interval", 10*time.Minute, "How frequently the configured rule groups are re-synced from the object storage.")
f.StringVar(&cfg.AlertmanagerURL, "ruler.alertmanager-url", "", "Comma-separated list of URL(s) of the Alertmanager(s) to send notifications to. Each URL is treated as a separate group. Multiple Alertmanagers in HA per group can be supported by using DNS service discovery format, comprehensive of the scheme. Basic auth is supported as part of the URL.")
f.DurationVar(&cfg.AlertmanagerRefreshInterval, "ruler.alertmanager-refresh-interval", 1*time.Minute, "How long to wait between refreshing DNS resolutions of Alertmanager hosts.")
f.IntVar(&cfg.NotificationQueueCapacity, "ruler.notification-queue-capacity", 10000, "Capacity of the queue for notifications to be sent to the Alertmanager.")
f.DurationVar(&cfg.NotificationTimeout, "ruler.notification-timeout", 10*time.Second, "HTTP timeout duration when sending notifications to the Alertmanager.")
f.StringVar(&cfg.RulePath, "ruler.rule-path", "./data-ruler/", "Directory to store temporary rule files loaded by the Prometheus rule managers. This directory is not required to be persisted between restarts.")
f.BoolVar(&cfg.EnableAPI, "ruler.enable-api", true, "Enable the ruler config API.")
f.DurationVar(&cfg.OutageTolerance, "ruler.for-outage-tolerance", time.Hour, `Max time to tolerate outage for restoring "for" state of alert.`)
f.DurationVar(&cfg.ForGracePeriod, "ruler.for-grace-period", 2*time.Minute, `This grace period controls which alerts the ruler restores after a restart. `+
`Alerts with "for" duration lower than this grace period are not restored after a ruler restart. `+
`This means that if the alerts have been firing before the ruler restarted, they will now go to pending state and then to firing again after their "for" duration expires. `+
`Alerts with "for" duration greater than or equal to this grace period that have been pending before the ruler restart will remain in pending state for at least this grace period. `+
`Alerts with "for" duration greater than or equal to this grace period that have been firing before the ruler restart will continue to be firing after the restart.`)
f.DurationVar(&cfg.ResendDelay, "ruler.resend-delay", time.Minute, `Minimum amount of time to wait before resending an alert to Alertmanager.`)
f.Var(&cfg.EnabledTenants, "ruler.enabled-tenants", "Comma separated list of tenants whose rules this ruler can evaluate. If specified, only these tenants will be handled by ruler, otherwise this ruler can process rules from all tenants. Subject to sharding.")
f.Var(&cfg.DisabledTenants, "ruler.disabled-tenants", "Comma separated list of tenants whose rules this ruler cannot evaluate. If specified, a ruler that would normally pick the specified tenant(s) for processing will ignore them instead. Subject to sharding.")
f.BoolVar(&cfg.EnableQueryStats, "ruler.query-stats-enabled", false, "Report the wall time for ruler queries to complete as a per-tenant metric and as an info level log message.")
cfg.RingCheckPeriod = 5 * time.Second
}
func (cfg *Config) syncQueuePollFrequency() time.Duration {
if cfg.rulerSyncQueuePollFrequency > 0 {
return cfg.rulerSyncQueuePollFrequency
}
return defaultRulerSyncPollFrequency
}
type rulerMetrics struct {
listRules prometheus.Histogram
loadRuleGroups prometheus.Histogram
ringCheckErrors prometheus.Counter
rulerSync *prometheus.CounterVec
rulerSyncDuration prometheus.Histogram
}
func newRulerMetrics(reg prometheus.Registerer) *rulerMetrics {
m := &rulerMetrics{
listRules: promauto.With(reg).NewHistogram(prometheus.HistogramOpts{
Name: "cortex_ruler_list_rules_seconds",
Help: "Time spent listing rules.",
Buckets: []float64{0.1, 0.5, 1, 2, 5, 10, 15, 30},
}),
loadRuleGroups: promauto.With(reg).NewHistogram(prometheus.HistogramOpts{
Name: "cortex_ruler_load_rule_groups_seconds",
Help: "Time spent loading the rule groups owned by this ruler from the object storage. This metric tracks the timing of both full and partial sync.",
Buckets: []float64{0.1, 0.5, 1, 2, 5, 10, 15, 30},
}),
ringCheckErrors: promauto.With(reg).NewCounter(prometheus.CounterOpts{
Name: "cortex_ruler_ring_check_errors_total",
Help: "Number of errors that have occurred when checking the ring for ownership",
}),
rulerSync: promauto.With(reg).NewCounterVec(prometheus.CounterOpts{
Name: "cortex_ruler_sync_rules_total",
Help: "Total number of times the ruler sync operation triggered.",
}, []string{"reason"}),
rulerSyncDuration: promauto.With(reg).NewHistogram(prometheus.HistogramOpts{
Name: "cortex_ruler_sync_rules_duration_seconds",
Help: "Time spent syncing all rule groups owned by this ruler instance. This metric tracks the timing of both full and partial sync, and includes the time spent loading rule groups from the storage.",
Buckets: []float64{1, 5, 10, 30, 60, 300, 600, 1800, 3600},
}),
}
// Init metrics.
for _, reason := range rulerSyncReasons {
m.rulerSync.WithLabelValues(string(reason))
}
return m
}
// MultiTenantManager is the interface of interaction with a Manager that is tenant aware.
type MultiTenantManager interface {
// SyncFullRuleGroups is used to sync the Manager with rules from the RuleStore.
// If existing user is missing in the ruleGroupsByUser map, its ruler manager will be stopped.
SyncFullRuleGroups(ctx context.Context, ruleGroupsByUser map[string]rulespb.RuleGroupList)
// SyncPartialRuleGroups syncs the rule groups for the input tenants.
//
// If a tenant is completely missing from the input ruleGroupsByUser map it doesn't mean their
// rule groups config don't exist anymore, so they shouldn't be removed from the ruler.
//
// If a tenant exists in the map then the list of rule groups must be all the rule groups owned
// by this tenant manager (not a partial view). If a tenant exists in the map but its list of rule
// groups is empty, then it means there are no rule groups owned by this ruler and it's safe to stop
// the tenant's ruler manager.
SyncPartialRuleGroups(ctx context.Context, ruleGroupsByUser map[string]rulespb.RuleGroupList)
// GetRules fetches rules for a particular tenant (userID).
GetRules(userID string) []*promRules.Group
// Stop stops all Manager components.
Stop()
// ValidateRuleGroup validates a rulegroup
ValidateRuleGroup(rulefmt.RuleGroup) []error
// Start evaluating rules.
Start()
}
// Ruler evaluates rules.
//
// +---------------------------------------------------------------+
// | |
// | Query +-------------+ |
// | +------------------> | |
// | | | Store | |
// | | +----------------+ | |
// | | | Rules +-------------+ |
// | | | |
// | | | |
// | | | |
// | +----+-v----+ Filter +------------+ |
// | | +-----------> | |
// | | Ruler | | Ring | |
// | | <-----------+ | |
// | +-------+---+ Rules +------------+ |
// | | |
// | | |
// | | |
// | | Load +-----------------+ |
// | +--------------> | |
// | | Manager | |
// | | | |
// | +-----------------+ |
// | |
// +---------------------------------------------------------------+
type Ruler struct {
services.Service
cfg Config
lifecycler *ring.BasicLifecycler
ring *ring.Ring
directStore rulestore.RuleStore
cachedStore rulestore.RuleStore
manager MultiTenantManager
limits RulesLimits
metrics *rulerMetrics
subservices *services.Manager
subservicesWatcher *services.FailureWatcher
// Pool of clients used to connect to other ruler replicas.
clientsPool ClientsPool
// Queue where we push rules syncing notifications to send to other ruler instances.
// This queue is also used to de-amplify the outbound notifications.
outboundSyncQueue *rulerSyncQueue
outboundSyncQueueProcessor *rulerSyncQueueProcessor
// Queue where we pull rules syncing notifications received from other ruler instances.
// This queue is also used to de-amplify the inbound notifications.
inboundSyncQueue *rulerSyncQueue
allowedTenants *util.AllowedTenants
registry prometheus.Registerer
logger log.Logger
}
// NewRuler creates a new ruler from a distributor and chunk store.
func NewRuler(cfg Config, manager MultiTenantManager, reg prometheus.Registerer, logger log.Logger, directStore, cachedStore rulestore.RuleStore, limits RulesLimits) (*Ruler, error) {
// If the cached store is not configured, just fallback to the direct one.
if cachedStore == nil {
cachedStore = directStore
}
return newRuler(cfg, manager, reg, logger, directStore, cachedStore, limits, newRulerClientPool(cfg.ClientTLSConfig, logger, reg))
}
func newRuler(cfg Config, manager MultiTenantManager, reg prometheus.Registerer, logger log.Logger, directStore, cachedStore rulestore.RuleStore, limits RulesLimits, clientPool ClientsPool) (*Ruler, error) {
ruler := &Ruler{
cfg: cfg,
directStore: directStore,
cachedStore: cachedStore,
manager: manager,
registry: reg,
logger: logger,
limits: limits,
clientsPool: clientPool,
outboundSyncQueue: newRulerSyncQueue(cfg.syncQueuePollFrequency()),
inboundSyncQueue: newRulerSyncQueue(cfg.syncQueuePollFrequency()),
allowedTenants: util.NewAllowedTenants(cfg.EnabledTenants, cfg.DisabledTenants),
metrics: newRulerMetrics(reg),
}
ruler.outboundSyncQueueProcessor = newRulerSyncQueueProcessor(ruler.outboundSyncQueue, ruler.notifySyncRules)
if len(cfg.EnabledTenants) > 0 {
level.Info(ruler.logger).Log("msg", "ruler using enabled users", "enabled", strings.Join(cfg.EnabledTenants, ", "))
}
if len(cfg.DisabledTenants) > 0 {
level.Info(ruler.logger).Log("msg", "ruler using disabled users", "disabled", strings.Join(cfg.DisabledTenants, ", "))
}
ringStore, err := kv.NewClient(
cfg.Ring.Common.KVStore,
ring.GetCodec(),
kv.RegistererWithKVName(prometheus.WrapRegistererWithPrefix("cortex_", reg), "ruler"),
logger,
)
if err != nil {
return nil, errors.Wrap(err, "create KV store client")
}
if err := enableSharding(ruler, ringStore); err != nil {
return nil, errors.Wrap(err, "setup ruler sharding ring")
}
ruler.Service = services.NewBasicService(ruler.starting, ruler.run, ruler.stopping)
return ruler, nil
}
func enableSharding(r *Ruler, ringStore kv.Client) error {
lifecyclerCfg, err := r.cfg.Ring.ToLifecyclerConfig(r.logger)
if err != nil {
return errors.Wrap(err, "failed to initialize ruler's lifecycler config")
}
// Define lifecycler delegates in reverse order (last to be called defined first because they're
// chained via "next delegate").
delegate := ring.BasicLifecyclerDelegate(ring.NewInstanceRegisterDelegate(ring.JOINING, r.cfg.Ring.NumTokens))
delegate = ring.NewLeaveOnStoppingDelegate(delegate, r.logger)
delegate = ring.NewAutoForgetDelegate(r.cfg.Ring.Common.HeartbeatTimeout*ringAutoForgetUnhealthyPeriods, delegate, r.logger)
rulerRingName := "ruler"
r.lifecycler, err = ring.NewBasicLifecycler(lifecyclerCfg, rulerRingName, RulerRingKey, ringStore, delegate, r.logger, prometheus.WrapRegistererWithPrefix("cortex_", r.registry))
if err != nil {
return errors.Wrap(err, "failed to initialize ruler's lifecycler")
}
r.ring, err = ring.NewWithStoreClientAndStrategy(r.cfg.Ring.toRingConfig(), rulerRingName, RulerRingKey, ringStore, ring.NewIgnoreUnhealthyInstancesReplicationStrategy(), prometheus.WrapRegistererWithPrefix("cortex_", r.registry), r.logger)
if err != nil {
return errors.Wrap(err, "failed to initialize ruler's ring")
}
return nil
}
func (r *Ruler) starting(ctx context.Context) (err error) {
if r.subservices, err = services.NewManager(r.lifecycler, r.ring, r.clientsPool, r.outboundSyncQueue, r.outboundSyncQueueProcessor, r.inboundSyncQueue); err != nil {
return errors.Wrap(err, "unable to start ruler subservices")
}
r.subservicesWatcher = services.NewFailureWatcher()
r.subservicesWatcher.WatchManager(r.subservices)
defer func() {
if err != nil {
// The startup can fail when waiting for some subservices to complete starting.
// If this happens or the startup fails for any other reason after all subservices are healthy,
// then we need to stop the subservices. For example, the lifecycler needs to deregister the
// instance from the ring instead of leaving it there to be autoforgotten.
//
// We use a context.Background() because ctx may already be cancelled,
// and we want to make sure the subservices have the chance of a graceful stop.
_ = services.StopManagerAndAwaitStopped(context.Background(), r.subservices)
}
}()
if err = services.StartManagerAndAwaitHealthy(ctx, r.subservices); err != nil {
return errors.Wrap(err, "unable to start ruler subservices")
}
// Sync the rule when the ruler is JOINING the ring.
// Activate the rule evaluation after the ruler is ACTIVE in the ring.
// This is to make sure that the ruler is ready to evaluate rules immediately after it is ACTIVE in the ring.
level.Info(r.logger).Log("msg", "waiting until ruler is JOINING in the ring")
if err := ring.WaitInstanceState(ctx, r.ring, r.lifecycler.GetInstanceID(), ring.JOINING); err != nil {
return err
}
level.Info(r.logger).Log("msg", "ruler is JOINING in the ring")
// Here during joining, we can download rules from object storage and sync them to the local rule manager
r.syncRules(ctx, nil, rulerSyncReasonInitial, true)
if err = r.lifecycler.ChangeState(ctx, ring.ACTIVE); err != nil {
return errors.Wrapf(err, "switch instance to %s in the ring", ring.ACTIVE)
}
level.Info(r.logger).Log("msg", "waiting until ruler is ACTIVE in the ring")
if err := ring.WaitInstanceState(ctx, r.ring, r.lifecycler.GetInstanceID(), ring.ACTIVE); err != nil {
return err
}
level.Info(r.logger).Log("msg", "ruler is ACTIVE in the ring")
// TODO: ideally, ruler would wait until its queryable is finished starting.
r.manager.Start()
level.Info(r.logger).Log("msg", "ruler is only now starting to evaluate rules")
// After the manager has been started we should return a nil error. This ensures that the stopping function is called
// and the manager is gracefully stopped when the process need to shut down.
return nil
}
// Stop stops the Ruler.
// Each function of the ruler is terminated before leaving the ring
func (r *Ruler) stopping(_ error) error {
r.manager.Stop()
if r.subservices != nil {
_ = services.StopManagerAndAwaitStopped(context.Background(), r.subservices)
}
return nil
}
var sep = []byte("/")
func tokenForGroup(g *rulespb.RuleGroupDesc) uint32 {
ringHasher := fnv.New32a()
// Hasher never returns err.
_, _ = ringHasher.Write([]byte(g.User))
_, _ = ringHasher.Write(sep)
_, _ = ringHasher.Write([]byte(g.Namespace))
_, _ = ringHasher.Write(sep)
_, _ = ringHasher.Write([]byte(g.Name))
return ringHasher.Sum32()
}
func instanceOwnsRuleGroup(r ring.ReadRing, g *rulespb.RuleGroupDesc, instanceAddr string, reason rulesSyncReason) (bool, error) {
hash := tokenForGroup(g)
var rlrs ring.ReplicationSet
var err error
if reason == rulerSyncReasonInitial {
rlrs, err = r.Get(hash, RuleSyncRingOp, nil, nil, nil)
} else {
rlrs, err = r.Get(hash, RuleEvalRingOp, nil, nil, nil)
}
if err != nil {
return false, errors.Wrap(err, "error reading ring to verify rule group ownership")
}
return rlrs.Instances[0].Addr == instanceAddr, nil
}
func (r *Ruler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
r.ring.ServeHTTP(w, req)
}
func (r *Ruler) run(ctx context.Context) error {
level.Info(r.logger).Log("msg", "ruler up and running")
// Apply a jitter to increase the likelihood the ruler storage cache effectiveness (optional).
periodicTicker := time.NewTicker(util.DurationWithJitter(r.cfg.PollInterval, rulerPeriodicSyncJitter))
defer periodicTicker.Stop()
ringLastState, _ := r.ring.GetAllHealthy(RuleEvalRingOp)
ringTicker := time.NewTicker(util.DurationWithJitter(r.cfg.RingCheckPeriod, 0.2))
defer ringTicker.Stop()
for {
select {
case <-ctx.Done():
return nil
case <-periodicTicker.C:
// Sync rules for all users.
r.syncRules(ctx, nil, rulerSyncReasonPeriodic, true)
case <-ringTicker.C:
// We ignore the error because in case of error it will return an empty
// replication set which we use to compare with the previous state.
currRingState, _ := r.ring.GetAllHealthy(RuleEvalRingOp)
if ring.HasReplicationSetChanged(ringLastState, currRingState) {
ringLastState = currRingState
r.syncRules(ctx, nil, rulerSyncReasonRingChange, true)
}
case userIDs := <-r.inboundSyncQueue.poll():
// Sync rules for users who changed their configs.
r.syncRules(ctx, userIDs, rulerSyncReasonAPIChange, false)
case err := <-r.subservicesWatcher.Chan():
return errors.Wrap(err, "ruler subservice failed")
}
}
}
// syncRules synchronises the rules managed by this ruler instance.
// If the input userIDs list is not empty, then this function will only
// synchronise the rules for the input users.
//
// It's not safe to call this function concurrently.
// We expect this function is only called from Ruler.run().
func (r *Ruler) syncRules(ctx context.Context, userIDs []string, reason rulesSyncReason, cacheLookupEnabled bool) {
var (
configs map[string]rulespb.RuleGroupList
err error
startTime = time.Now()
)
level.Info(r.logger).Log("msg", "syncing rules", "reason", reason)
r.metrics.rulerSync.WithLabelValues(string(reason)).Inc()
defer func() {
r.metrics.rulerSyncDuration.Observe(time.Since(startTime).Seconds())
}()
// List rule groups to sync.
if len(userIDs) > 0 {
configs, err = r.listRuleGroupsToSyncForUsers(ctx, userIDs, reason, cacheLookupEnabled)
} else {
configs, err = r.listRuleGroupsToSyncForAllUsers(ctx, reason, cacheLookupEnabled)
}
if err != nil {
level.Error(r.logger).Log("msg", "unable to list rules to sync", "err", err)
return
}
// Load rule groups to sync.
configs, err = r.loadRuleGroupsToSync(ctx, configs)
if err != nil {
level.Error(r.logger).Log("msg", "unable to load rules to sync", "err", err)
return
}
// Filter out all rules for which their evaluation has been disabled for the given tenant.
configs = filterRuleGroupsByEnabled(configs, r.limits, r.logger)
// Sync the rule groups.
if len(userIDs) > 0 {
// Ensure the configs map is not nil.
if configs == nil {
configs = make(map[string]rulespb.RuleGroupList, len(userIDs))
}
// The filtering done above (e.g. due to sharding, disabled tenants, ...) may have
// removed some tenants from the configs map. We want to add back all input tenants
// to the map but with an empty list of rule groups, so that these tenants will be
// removed from the ruler manager.
for _, userID := range userIDs {
if _, exists := configs[userID]; !exists {
configs[userID] = nil
}
}
r.manager.SyncPartialRuleGroups(ctx, configs)
} else {
// This will also delete local group files for users that are no longer in 'configs' map.
r.manager.SyncFullRuleGroups(ctx, configs)
}
}
// loadRuleGroupsToSync loads the input rule group configs. This function should be used only when
// syncing the rule groups, because it expects the storage view to be eventually consistent (due to
// optional caching).
func (r *Ruler) loadRuleGroupsToSync(ctx context.Context, configs map[string]rulespb.RuleGroupList) (map[string]rulespb.RuleGroupList, error) {
// Load rule groups.
start := time.Now()
missing, err := r.directStore.LoadRuleGroups(ctx, configs)
r.metrics.loadRuleGroups.Observe(time.Since(start).Seconds())
if err != nil {
return configs, err
}
// The rules syncing is eventually consistent, because the object storage operations may be
// cached for a short period of time. This means that some rule groups discovered by listing
// the bucket (cached) may no longer exist because deleted in the meanwhile. For this reason,
// we filter out any missing rule group, not considering it as an hard error.
configs = filterRuleGroupsByNotMissing(configs, missing, r.logger)
return configs, nil
}
// listRuleGroupsToSyncForAllUsers lists all the rule groups that should be synched by this ruler instance.
// This function should be used only when syncing the rule groups, because it expects the
// storage view to be eventually consistent (due to optional caching).
func (r *Ruler) listRuleGroupsToSyncForAllUsers(ctx context.Context, reason rulesSyncReason, cacheLookupEnabled bool) (result map[string]rulespb.RuleGroupList, err error) {
start := time.Now()
defer func() {
r.metrics.listRules.Observe(time.Since(start).Seconds())
}()
// In order to reduce API calls to the object storage among all ruler replicas,
// we support lookup of stale data for a short period.
users, err := r.cachedStore.ListAllUsers(bucketcache.WithCacheLookupEnabled(ctx, cacheLookupEnabled))
if err != nil {
return nil, errors.Wrap(err, "unable to list users of ruler")
}
result, err = r.listRuleGroupsToSyncForUsers(ctx, users, reason, cacheLookupEnabled)
return
}
func (r *Ruler) listRuleGroupsToSyncForUsers(ctx context.Context, userIDs []string, reason rulesSyncReason, cacheLookupEnabled bool) (map[string]rulespb.RuleGroupList, error) {
// Only users in userRings will be used to load the rules.
userRings := map[string]ring.ReadRing{}
for _, userID := range userIDs {
// Filter out users which have been explicitly disabled.
if !r.allowedTenants.IsAllowed(userID) {
level.Debug(r.logger).Log("msg", "ignoring rule groups for user, not allowed", "user", userID)
continue
}
if shardSize := r.limits.RulerTenantShardSize(userID); shardSize > 0 {
subRing := r.ring.ShuffleShard(userID, shardSize)
// Include the user only if it belongs to this ruler shard.
if subRing.HasInstance(r.lifecycler.GetInstanceID()) {
userRings[userID] = subRing
}
} else {
// A shard size of 0 means shuffle sharding is disabled for this specific user.
// In that case we use the full ring so that rule groups will be sharded across all rulers.
userRings[userID] = r.ring
}
}
if len(userRings) == 0 {
return map[string]rulespb.RuleGroupList{}, nil
}
userCh := make(chan string, len(userRings))
for u := range userRings {
userCh <- u
}
close(userCh)
mu := sync.Mutex{}
result := map[string]rulespb.RuleGroupList{}
concurrency := loadRulesConcurrency
if len(userRings) < concurrency {
concurrency = len(userRings)
}
g, gctx := errgroup.WithContext(ctx)
for i := 0; i < concurrency; i++ {
g.Go(func() error {
for userID := range userCh {
groups, err := r.cachedStore.ListRuleGroupsForUserAndNamespace(bucketcache.WithCacheLookupEnabled(gctx, cacheLookupEnabled), userID, "")
if err != nil {
return errors.Wrapf(err, "failed to fetch rule groups for user %s", userID)
}
filtered := filterRuleGroupsByOwnership(userID, groups, userRings[userID], r.lifecycler.GetInstanceAddr(), r.logger, r.metrics.ringCheckErrors, reason)
if len(filtered) == 0 {
continue
}
mu.Lock()
result[userID] = filtered
mu.Unlock()
}
return nil
})
}
// Wait until all the rule groups have been loaded.
err := g.Wait()
return result, err
}
// filterRuleGroupsByOwnership returns map of rule groups that given instance "owns" based on supplied ring.
// This function only uses User, Namespace, and Name fields of individual RuleGroups.
//
// Reason why this function is not a method on Ruler is to make sure we don't accidentally use r.ring,
// but only ring passed as parameter.
func filterRuleGroupsByOwnership(userID string, ruleGroups []*rulespb.RuleGroupDesc, ring ring.ReadRing, instanceAddr string, log log.Logger, ringCheckErrors prometheus.Counter, reason rulesSyncReason) []*rulespb.RuleGroupDesc {
// Prune the rule group to only contain rules that this ruler is responsible for, based on ring.
var result []*rulespb.RuleGroupDesc
for _, g := range ruleGroups {
owned, err := instanceOwnsRuleGroup(ring, g, instanceAddr, reason)
if err != nil {
ringCheckErrors.Inc()
level.Error(log).Log("msg", "failed to check if the ruler replica owns the rule group", "user", userID, "namespace", g.Namespace, "group", g.Name, "err", err)
continue
}
if owned {
level.Debug(log).Log("msg", "rule group owned", "user", g.User, "namespace", g.Namespace, "name", g.Name)
result = append(result, g)
} else {
level.Debug(log).Log("msg", "rule group not owned, ignoring", "user", g.User, "namespace", g.Namespace, "name", g.Name)
}
}
return result
}
// filterRuleGroupsByEnabled filters out from the input configs all the recording and/or alerting rules whose evaluation
// has been disabled for the given tenant.
//
// This function doesn't modify the input configs in place (even if it could) in order to reduce the likelihood of introducing
// future bugs, in case the rule groups will be cached in memory.
func filterRuleGroupsByEnabled(configs map[string]rulespb.RuleGroupList, limits RulesLimits, logger log.Logger) (filtered map[string]rulespb.RuleGroupList) {
// Quick case: nothing if do if no user has rules disabled.
shouldFilter := false
for userID := range configs {
recordingEnabled := limits.RulerRecordingRulesEvaluationEnabled(userID)
alertingEnabled := limits.RulerAlertingRulesEvaluationEnabled(userID)
if !recordingEnabled || !alertingEnabled {
shouldFilter = true
break
}
}
if !shouldFilter {
return configs
}
// Filter out disabled rules.
filtered = make(map[string]rulespb.RuleGroupList, len(configs))
for userID, groups := range configs {
recordingEnabled := limits.RulerRecordingRulesEvaluationEnabled(userID)
alertingEnabled := limits.RulerAlertingRulesEvaluationEnabled(userID)
// Quick case: nothing to do if all rules are enabled.
if recordingEnabled && alertingEnabled {
filtered[userID] = groups
continue
}
// Quick case: remove the user at all if all rules are disabled.
if !recordingEnabled && !alertingEnabled {
// We don't expect rules evaluation to be disabled for the normal use case. For this reason,
// when it's disabled we prefer to log it with "info" instead of "debug" to make it more visible.
level.Info(logger).Log(
"msg", "filtered out all rules because evaluation is disabled for the tenant",
"user", userID,
"recording_rules_enabled", recordingEnabled,
"alerting_rules_enabled", alertingEnabled)
continue
}
filtered[userID] = make(rulespb.RuleGroupList, 0, len(groups))
removedRulesTotal := 0
for _, group := range groups {
filteredGroup, removedRules := filterRuleGroupByEnabled(group, recordingEnabled, alertingEnabled)
if filteredGroup != nil {
filtered[userID] = append(filtered[userID], filteredGroup)
}
removedRulesTotal += removedRules
}
if removedRulesTotal > 0 {
// We don't expect rules evaluation to be disabled for the normal use case. For this reason,
// when it's disabled we prefer to log it with "info" instead of "debug" to make it more visible.
level.Info(logger).Log(
"msg", "filtered out rules because evaluation is disabled for the tenant",
"user", userID,
"removed_rules", removedRulesTotal,
"recording_rules_enabled", recordingEnabled,
"alerting_rules_enabled", alertingEnabled)
}
}
return filtered
}
func filterRuleGroupByEnabled(group *rulespb.RuleGroupDesc, recordingEnabled, alertingEnabled bool) (filtered *rulespb.RuleGroupDesc, removedRules int) {
// Check if there are actually rules to be removed.
for _, rule := range group.Rules {
if rule.Record != "" && !recordingEnabled {
removedRules++
} else if rule.Alert != "" && !alertingEnabled {
removedRules++
}
}
// Quick case: no rules to remove.
if removedRules == 0 {
return group, 0
}
// Quick case: all rules to remove.
if removedRules == len(group.Rules) {
return nil, removedRules
}
// Create a copy of the group and remove some rules.
filtered = &rulespb.RuleGroupDesc{
Name: group.Name,
Namespace: group.Namespace,
Interval: group.Interval,
Rules: make([]*rulespb.RuleDesc, 0, len(group.Rules)-removedRules),
User: group.User,
Options: group.Options,
SourceTenants: group.SourceTenants,
}
for _, rule := range group.Rules {
if rule.Record != "" && !recordingEnabled {
continue
}
if rule.Alert != "" && !alertingEnabled {
continue
}
filtered.Rules = append(filtered.Rules, rule)
}
return filtered, removedRules
}
// filterRuleGroupsByNotMissing filters out from the input configs all the rules groups which are in the missing list.
//
// This function doesn't modify the input configs in place (even if it could) in order to reduce the likelihood of introducing
// future bugs, in case the rule groups will be cached in memory.
func filterRuleGroupsByNotMissing(configs map[string]rulespb.RuleGroupList, missing rulespb.RuleGroupList, logger log.Logger) (filtered map[string]rulespb.RuleGroupList) {
// Nothing to do if there are no missing rule groups.
if len(missing) == 0 {
return configs
}
// Build a map to easily lookup missing rule groups.
getRuleGroupLookupKey := func(group *rulespb.RuleGroupDesc) string {
var sep = string([]byte{0})
return group.GetUser() + sep + group.GetNamespace() + sep + group.GetName()
}
missingLookup := make(map[string]*rulespb.RuleGroupDesc, len(missing))
for _, group := range missing {
missingLookup[getRuleGroupLookupKey(group)] = group
}
// Filter out missing rules.
filtered = make(map[string]rulespb.RuleGroupList, len(configs))
for userID, groups := range configs {
filteredGroups := make(rulespb.RuleGroupList, 0, len(groups))
for _, group := range groups {
lookupKey := getRuleGroupLookupKey(group)
if _, isMissing := missingLookup[lookupKey]; isMissing {
level.Info(logger).Log(
"msg", "filtered out rule group because not found in the object storage (may be temporarily caused by ruler storage caching)",
"user", group.GetUser(),
"namespace", group.GetNamespace(),
"group", group.GetName())
// Remove from the lookup map, so that at the end we can check if any
// missing rule group has not been found when iterating configs.
delete(missingLookup, lookupKey)
continue
}
filteredGroups = append(filteredGroups, group)
}
if len(filteredGroups) > 0 {
filtered[userID] = filteredGroups
}
}
// This should never happen. If it happens, then we have a bug.
for _, missingGroup := range missingLookup {
level.Error(logger).Log(
"msg", "unable to filter out rule group not found in the object storage because the missing rule group has not been found among the loaded ones",
"user", missingGroup.GetUser(),
"namespace", missingGroup.GetNamespace(),
"group", missingGroup.GetName())
}
return filtered
}
// GetRules retrieves the running rules from this ruler and all running rulers in the ring.
func (r *Ruler) GetRules(ctx context.Context, req RulesRequest) ([]*GroupStateDesc, error) {
userID, err := tenant.TenantID(ctx)
if err != nil {
return nil, fmt.Errorf("no user id found in context")
}
rr := ring.ReadRing(r.ring)
if shardSize := r.limits.RulerTenantShardSize(userID); shardSize > 0 {
rr = r.ring.ShuffleShard(userID, shardSize)
}
ctx, err = user.InjectIntoGRPCRequest(ctx)
if err != nil {
return nil, fmt.Errorf("unable to inject user ID into grpc request, %v", err)
}
var (
mergedMx sync.Mutex
merged []*GroupStateDesc
)
// Concurrently fetch rules from all rulers. Since rules are not replicated,
// we need all requests to succeed.
err = r.forEachRulerInTheRing(ctx, rr, RuleEvalRingOp, func(ctx context.Context, rulerInst *ring.InstanceDesc, rulerClient RulerClient, rulerClientErr error) error {
// Fail if we have not been able to get the client for a ruler.
if rulerClientErr != nil {
return err
}
newGrps, err := rulerClient.Rules(ctx, &req)
if err != nil {
return errors.Wrapf(err, "unable to retrieve rules from ruler %s %s", rulerInst.Id, rulerInst.Addr)
}
mergedMx.Lock()
merged = append(merged, newGrps.Groups...)
mergedMx.Unlock()
return nil
})
return merged, err
}
// SyncRules implements the gRPC Ruler service.
func (r *Ruler) SyncRules(_ context.Context, req *SyncRulesRequest) (*SyncRulesResponse, error) {
r.inboundSyncQueue.enqueue(req.GetUserIds()...)
return &SyncRulesResponse{}, nil
}
// Rules implements the gRPC Ruler service.
func (r *Ruler) Rules(ctx context.Context, in *RulesRequest) (*RulesResponse, error) {
userID, err := tenant.TenantID(ctx)
if err != nil {
return nil, fmt.Errorf("no user id found in context")
}
groupDescs, err := r.getLocalRules(ctx, userID, *in)
if err != nil {
return nil, err
}
return &RulesResponse{Groups: groupDescs}, nil