forked from grafana/grafana
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathalert_rules.go
858 lines (788 loc) · 28.9 KB
/
alert_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
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
package provisioning
import (
"context"
"errors"
"fmt"
"time"
"github.com/grafana/grafana/pkg/apimachinery/identity"
"github.com/grafana/grafana/pkg/infra/log"
"github.com/grafana/grafana/pkg/services/dashboards"
"github.com/grafana/grafana/pkg/services/folder"
"github.com/grafana/grafana/pkg/services/ngalert/accesscontrol"
"github.com/grafana/grafana/pkg/services/ngalert/models"
"github.com/grafana/grafana/pkg/services/ngalert/notifier"
"github.com/grafana/grafana/pkg/services/ngalert/provisioning/validation"
"github.com/grafana/grafana/pkg/services/ngalert/store"
"github.com/grafana/grafana/pkg/services/quota"
"github.com/grafana/grafana/pkg/util"
)
type ruleAccessControlService interface {
AuthorizeRuleGroupRead(ctx context.Context, user identity.Requester, rules models.RulesGroup) error
AuthorizeRuleGroupWrite(ctx context.Context, user identity.Requester, change *store.GroupDelta) error
AuthorizeRuleRead(ctx context.Context, user identity.Requester, rule *models.AlertRule) error
// CanReadAllRules returns true if the user has full access to read rules via provisioning API and bypass regular checks
CanReadAllRules(ctx context.Context, user identity.Requester) (bool, error)
// CanWriteAllRules returns true if the user has full access to write rules via provisioning API and bypass regular checks
CanWriteAllRules(ctx context.Context, user identity.Requester) (bool, error)
}
type NotificationSettingsValidatorProvider interface {
Validator(ctx context.Context, orgID int64) (notifier.NotificationSettingsValidator, error)
}
type AlertRuleService struct {
defaultIntervalSeconds int64
baseIntervalSeconds int64
rulesPerRuleGroupLimit int64
ruleStore RuleStore
provenanceStore ProvisioningStore
folderService folder.Service
quotas QuotaChecker
xact TransactionManager
log log.Logger
nsValidatorProvider NotificationSettingsValidatorProvider
authz ruleAccessControlService
}
func NewAlertRuleService(ruleStore RuleStore,
provenanceStore ProvisioningStore,
folderService folder.Service,
quotas QuotaChecker,
xact TransactionManager,
defaultIntervalSeconds int64,
baseIntervalSeconds int64,
rulesPerRuleGroupLimit int64,
log log.Logger,
ns NotificationSettingsValidatorProvider,
authz RuleAccessControlService,
) *AlertRuleService {
return &AlertRuleService{
defaultIntervalSeconds: defaultIntervalSeconds,
baseIntervalSeconds: baseIntervalSeconds,
rulesPerRuleGroupLimit: rulesPerRuleGroupLimit,
ruleStore: ruleStore,
provenanceStore: provenanceStore,
folderService: folderService,
quotas: quotas,
xact: xact,
log: log,
nsValidatorProvider: ns,
authz: newRuleAccessControlService(authz),
}
}
func (service *AlertRuleService) GetAlertRules(ctx context.Context, user identity.Requester) ([]*models.AlertRule, map[string]models.Provenance, error) {
q := models.ListAlertRulesQuery{
OrgID: user.GetOrgID(),
}
rules, err := service.ruleStore.ListAlertRules(ctx, &q)
if err != nil {
return nil, nil, err
}
provenances := make(map[string]models.Provenance)
if len(rules) > 0 {
resourceType := rules[0].ResourceType()
provenances, err = service.provenanceStore.GetProvenances(ctx, user.GetOrgID(), resourceType)
if err != nil {
return nil, nil, err
}
}
can, err := service.authz.CanReadAllRules(ctx, user)
if err != nil {
return nil, nil, err
}
if can {
return rules, provenances, nil
}
// If user does not have blanket privilege to read rules, remove all rules that are not allowed to the user.
groups := models.GroupByAlertRuleGroupKey(rules)
result := make([]*models.AlertRule, 0, len(rules))
for _, group := range groups {
if err := service.authz.AuthorizeRuleGroupRead(ctx, user, group); err != nil {
if errors.Is(err, accesscontrol.ErrAuthorizationBase) {
// remove provenances for rules that will not be added to the output
for _, rule := range group {
delete(provenances, rule.ResourceID())
}
continue
}
return nil, nil, err
}
result = append(result, group...)
}
return result, provenances, nil
}
func (service *AlertRuleService) getAlertRuleAuthorized(ctx context.Context, user identity.Requester, ruleUID string) (models.AlertRule, error) {
q := models.GetAlertRuleByUIDQuery{
UID: ruleUID,
OrgID: user.GetOrgID(),
}
var err error
rule, err := service.ruleStore.GetAlertRuleByUID(ctx, &q)
if err != nil {
return models.AlertRule{}, err
}
if err := service.authz.AuthorizeRuleRead(ctx, user, rule); err != nil {
return models.AlertRule{}, err
}
return *rule, nil
}
func (service *AlertRuleService) GetAlertRule(ctx context.Context, user identity.Requester, ruleUID string) (models.AlertRule, models.Provenance, error) {
rule, err := service.getAlertRuleAuthorized(ctx, user, ruleUID)
if err != nil {
return models.AlertRule{}, models.ProvenanceNone, err
}
provenance, err := service.provenanceStore.GetProvenance(ctx, &rule, user.GetOrgID())
if err != nil {
return models.AlertRule{}, models.ProvenanceNone, err
}
return rule, provenance, nil
}
type AlertRuleWithFolderFullpath struct {
AlertRule models.AlertRule
FolderFullpath string
}
// GetAlertRuleWithFolderFullpath returns a single alert rule with its folder title.
func (service *AlertRuleService) GetAlertRuleWithFolderFullpath(ctx context.Context, user identity.Requester, ruleUID string) (AlertRuleWithFolderFullpath, error) {
rule, err := service.getAlertRuleAuthorized(ctx, user, ruleUID)
if err != nil {
return AlertRuleWithFolderFullpath{}, err
}
fq := folder.GetFolderQuery{
OrgID: user.GetOrgID(),
UID: &rule.NamespaceUID,
WithFullpath: true,
SignedInUser: user,
}
f, err := service.folderService.Get(ctx, &fq)
if err != nil {
return AlertRuleWithFolderFullpath{}, err
}
return AlertRuleWithFolderFullpath{
AlertRule: rule,
FolderFullpath: f.Fullpath,
}, nil
}
// CreateAlertRule creates a new alert rule. This function will ignore any
// interval that is set in the rule struct and use the already existing group
// interval or the default one.
func (service *AlertRuleService) CreateAlertRule(ctx context.Context, user identity.Requester, rule models.AlertRule, provenance models.Provenance) (models.AlertRule, error) {
if rule.UID == "" {
rule.UID = util.GenerateShortUID()
} else if err := util.ValidateUID(rule.UID); err != nil {
return models.AlertRule{}, errors.Join(models.ErrAlertRuleFailedValidation, fmt.Errorf("cannot create rule with UID '%s': %w", rule.UID, err))
}
var interval = service.defaultIntervalSeconds
// check if user can bypass fine-grained rule authorization checks. If it cannot, verfiy that the user can add rules to the group
canWriteAllRules, err := service.authz.CanWriteAllRules(ctx, user)
if err != nil {
return models.AlertRule{}, err
}
if canWriteAllRules {
groupInterval, err := service.ruleStore.GetRuleGroupInterval(ctx, rule.OrgID, rule.NamespaceUID, rule.RuleGroup)
// if the alert group does not exist we just use the default interval
if err == nil {
interval = groupInterval
} else if !errors.Is(err, models.ErrAlertRuleGroupNotFound) {
return models.AlertRule{}, err
}
} else {
delta, err := store.CalculateRuleCreate(ctx, service.ruleStore, &rule)
if err != nil {
return models.AlertRule{}, fmt.Errorf("failed to calculate delta: %w", err)
}
if err := service.authz.AuthorizeRuleGroupWrite(ctx, user, delta); err != nil {
return models.AlertRule{}, err
}
existingGroup := delta.AffectedGroups[rule.GetGroupKey()]
if len(existingGroup) > 0 {
interval = existingGroup[0].IntervalSeconds
}
}
rule.IntervalSeconds = interval
err = rule.SetDashboardAndPanelFromAnnotations()
if err != nil {
return models.AlertRule{}, err
}
if err = service.ensureRuleNamespace(ctx, user, rule); err != nil {
return models.AlertRule{}, err
}
rule.Updated = time.Now()
if len(rule.NotificationSettings) > 0 {
validator, err := service.nsValidatorProvider.Validator(ctx, rule.OrgID)
if err != nil {
return models.AlertRule{}, err
}
for _, setting := range rule.NotificationSettings {
if err := validator.Validate(setting); err != nil {
return models.AlertRule{}, err
}
}
}
err = service.xact.InTransaction(ctx, func(ctx context.Context) error {
ids, err := service.ruleStore.InsertAlertRules(ctx, []models.AlertRule{
rule,
})
if err != nil {
return err
}
var fixed bool
for _, key := range ids {
if key.UID == rule.UID {
rule.ID = key.ID
fixed = true
break
}
}
if !fixed {
return errors.New("couldn't find newly created id")
}
if err = service.checkLimitsTransactionCtx(ctx, user); err != nil {
return err
}
return service.provenanceStore.SetProvenance(ctx, &rule, rule.OrgID, provenance)
})
if err != nil {
return models.AlertRule{}, err
}
return rule, nil
}
func (service *AlertRuleService) GetRuleGroup(ctx context.Context, user identity.Requester, namespaceUID, group string) (models.AlertRuleGroup, error) {
q := models.ListAlertRulesQuery{
OrgID: user.GetOrgID(),
NamespaceUIDs: []string{namespaceUID},
RuleGroups: []string{group},
}
ruleList, err := service.ruleStore.ListAlertRules(ctx, &q)
if err != nil {
return models.AlertRuleGroup{}, err
}
if len(ruleList) == 0 {
return models.AlertRuleGroup{}, models.ErrAlertRuleGroupNotFound.Errorf("")
}
can, err := service.authz.CanReadAllRules(ctx, user)
if err != nil {
return models.AlertRuleGroup{}, err
}
if !can {
if err := service.authz.AuthorizeRuleGroupRead(ctx, user, ruleList); err != nil {
return models.AlertRuleGroup{}, err
}
}
res := models.AlertRuleGroup{
Title: ruleList[0].RuleGroup,
FolderUID: ruleList[0].NamespaceUID,
Interval: ruleList[0].IntervalSeconds,
Rules: make([]models.AlertRule, 0, len(ruleList)),
}
for _, r := range ruleList {
if r != nil {
res.Rules = append(res.Rules, *r)
}
}
return res, nil
}
// UpdateRuleGroup will update the interval for all rules in the group.
func (service *AlertRuleService) UpdateRuleGroup(ctx context.Context, user identity.Requester, namespaceUID string, ruleGroup string, intervalSeconds int64) error {
if err := models.ValidateRuleGroupInterval(intervalSeconds, service.baseIntervalSeconds); err != nil {
return err
}
return service.xact.InTransaction(ctx, func(ctx context.Context) error {
query := &models.ListAlertRulesQuery{
OrgID: user.GetOrgID(),
NamespaceUIDs: []string{namespaceUID},
RuleGroups: []string{ruleGroup},
}
ruleList, err := service.ruleStore.ListAlertRules(ctx, query)
if err != nil {
return fmt.Errorf("failed to list alert rules: %w", err)
}
updateRules := make([]models.UpdateRule, 0, len(ruleList))
for _, rule := range ruleList {
if rule.IntervalSeconds == intervalSeconds {
continue
}
newRule := *rule
newRule.IntervalSeconds = intervalSeconds
updateRules = append(updateRules, models.UpdateRule{
Existing: rule,
New: newRule,
})
}
// check if user has write access to all rules and can bypass the regular checks.
can, err := service.authz.CanWriteAllRules(ctx, user)
if err != nil {
return err
}
// If it cannot, check that the user is authorized to perform all the changes caused by this request
if !can {
groupKey := models.AlertRuleGroupKey{
OrgID: user.GetOrgID(),
NamespaceUID: namespaceUID,
RuleGroup: ruleGroup,
}
ruleDeltas := make([]store.RuleDelta, 0, len(ruleList))
for _, upd := range updateRules {
updNew := upd.New
ruleDeltas = append(ruleDeltas, store.RuleDelta{
Existing: upd.Existing,
New: &updNew,
})
}
delta := &store.GroupDelta{
GroupKey: groupKey,
AffectedGroups: map[models.AlertRuleGroupKey]models.RulesGroup{
groupKey: ruleList,
},
Update: ruleDeltas,
}
if err := service.authz.AuthorizeRuleGroupWrite(ctx, user, delta); err != nil {
return err
}
}
return service.ruleStore.UpdateAlertRules(ctx, updateRules)
})
}
func (service *AlertRuleService) ReplaceRuleGroup(ctx context.Context, user identity.Requester, group models.AlertRuleGroup, provenance models.Provenance) error {
if err := models.ValidateRuleGroupInterval(group.Interval, service.baseIntervalSeconds); err != nil {
return err
}
delta, err := service.calcDelta(ctx, user, group)
if err != nil {
return err
}
if delta.IsEmpty() {
return nil
}
// check if the current user has permissions to all rules and can bypass the regular authorization validation.
can, err := service.authz.CanWriteAllRules(ctx, user)
if err != nil {
return err
}
if !can {
if err := service.authz.AuthorizeRuleGroupWrite(ctx, user, delta); err != nil {
return err
}
}
newOrUpdatedNotificationSettings := delta.NewOrUpdatedNotificationSettings()
if len(newOrUpdatedNotificationSettings) > 0 {
validator, err := service.nsValidatorProvider.Validator(ctx, delta.GroupKey.OrgID)
if err != nil {
return err
}
for _, s := range newOrUpdatedNotificationSettings {
if err := validator.Validate(s); err != nil {
return errors.Join(models.ErrAlertRuleFailedValidation, err)
}
}
}
return service.persistDelta(ctx, user, delta, provenance)
}
func (service *AlertRuleService) DeleteRuleGroup(ctx context.Context, user identity.Requester, namespaceUID, group string, provenance models.Provenance) error {
delta, err := store.CalculateRuleGroupDelete(ctx, service.ruleStore, models.AlertRuleGroupKey{
OrgID: user.GetOrgID(),
NamespaceUID: namespaceUID,
RuleGroup: group,
})
if err != nil {
return err
}
// check if the current user has permissions to all rules and can bypass the regular authorization validation.
can, err := service.authz.CanWriteAllRules(ctx, user)
if err != nil {
return err
}
if !can {
if err := service.authz.AuthorizeRuleGroupWrite(ctx, user, delta); err != nil {
return err
}
}
return service.persistDelta(ctx, user, delta, provenance)
}
func (service *AlertRuleService) calcDelta(ctx context.Context, user identity.Requester, group models.AlertRuleGroup) (*store.GroupDelta, error) {
// If the provided request did not provide the rules list at all, treat it as though it does not wish to change rules.
// This is done for backwards compatibility. Requests which specify only the interval must update only the interval.
if group.Rules == nil {
listRulesQuery := models.ListAlertRulesQuery{
OrgID: user.GetOrgID(),
NamespaceUIDs: []string{group.FolderUID},
RuleGroups: []string{group.Title},
}
ruleList, err := service.ruleStore.ListAlertRules(ctx, &listRulesQuery)
if err != nil {
return nil, fmt.Errorf("failed to list alert rules: %w", err)
}
group.Rules = make([]models.AlertRule, 0, len(ruleList))
for _, r := range ruleList {
if r != nil {
group.Rules = append(group.Rules, *r)
}
}
}
if err := service.checkGroupLimits(group); err != nil {
return nil, fmt.Errorf("write rejected due to exceeded limits: %w", err)
}
key := models.AlertRuleGroupKey{
OrgID: user.GetOrgID(),
NamespaceUID: group.FolderUID,
RuleGroup: group.Title,
}
rules := make([]*models.AlertRuleWithOptionals, 0, len(group.Rules))
group = *syncGroupRuleFields(&group, user.GetOrgID())
for i := range group.Rules {
if err := group.Rules[i].SetDashboardAndPanelFromAnnotations(); err != nil {
return nil, err
}
rules = append(rules, &models.AlertRuleWithOptionals{AlertRule: group.Rules[i], HasPause: true})
}
delta, err := store.CalculateChanges(ctx, service.ruleStore, key, rules)
if err != nil {
return nil, fmt.Errorf("failed to calculate diff for alert rules: %w", err)
}
// Refresh all calculated fields across all rules.
return store.UpdateCalculatedRuleFields(delta), nil
}
func (service *AlertRuleService) persistDelta(ctx context.Context, user identity.Requester, delta *store.GroupDelta, provenance models.Provenance) error {
return service.xact.InTransaction(ctx, func(ctx context.Context) error {
// Delete first as this could prevent future unique constraint violations.
if len(delta.Delete) > 0 {
for _, del := range delta.Delete {
// check that provenance is not changed in an invalid way
storedProvenance, err := service.provenanceStore.GetProvenance(ctx, del, user.GetOrgID())
if err != nil {
return err
}
if canUpdate := validation.CanUpdateProvenanceInRuleGroup(storedProvenance, provenance); !canUpdate {
return fmt.Errorf("cannot delete with provided provenance '%s', needs '%s'", provenance, storedProvenance)
}
}
if err := service.deleteRules(ctx, user.GetOrgID(), delta.Delete...); err != nil {
return err
}
}
if len(delta.Update) > 0 {
updates := make([]models.UpdateRule, 0, len(delta.Update))
for _, update := range delta.Update {
// check that provenance is not changed in an invalid way
storedProvenance, err := service.provenanceStore.GetProvenance(ctx, update.New, user.GetOrgID())
if err != nil {
return err
}
if canUpdate := validation.CanUpdateProvenanceInRuleGroup(storedProvenance, provenance); !canUpdate {
return fmt.Errorf("cannot update with provided provenance '%s', needs '%s'", provenance, storedProvenance)
}
updates = append(updates, models.UpdateRule{
Existing: update.Existing,
New: *update.New,
})
}
if err := service.ruleStore.UpdateAlertRules(ctx, updates); err != nil {
return fmt.Errorf("failed to update alert rules: %w", err)
}
for _, update := range delta.Update {
if err := service.provenanceStore.SetProvenance(ctx, update.New, user.GetOrgID(), provenance); err != nil {
return err
}
}
}
if len(delta.New) > 0 {
uids, err := service.ruleStore.InsertAlertRules(ctx, withoutNilAlertRules(delta.New))
if err != nil {
return fmt.Errorf("failed to insert alert rules: %w", err)
}
for _, key := range uids {
if err := service.provenanceStore.SetProvenance(ctx, &models.AlertRule{UID: key.UID}, user.GetOrgID(), provenance); err != nil {
return err
}
}
}
if err := service.checkLimitsTransactionCtx(ctx, user); err != nil {
return err
}
return nil
})
}
// UpdateAlertRule updates an alert rule.
func (service *AlertRuleService) UpdateAlertRule(ctx context.Context, user identity.Requester, rule models.AlertRule, provenance models.Provenance) (models.AlertRule, error) {
var storedRule *models.AlertRule
// check if the user has full access to all rules and can bypass the regular authorization validations.
// If it cannot, calculate the changes to the group caused by this update and authorize them.
canWriteAllRules, err := service.authz.CanWriteAllRules(ctx, user)
if err != nil {
return models.AlertRule{}, err
}
if canWriteAllRules {
query := &models.GetAlertRuleByUIDQuery{
OrgID: rule.OrgID,
UID: rule.UID,
}
existing, err := service.ruleStore.GetAlertRuleByUID(ctx, query)
if err != nil {
return models.AlertRule{}, err
}
storedRule = existing
} else {
delta, err := store.CalculateRuleUpdate(ctx, service.ruleStore, &models.AlertRuleWithOptionals{AlertRule: rule})
if err != nil {
return models.AlertRule{}, err
}
if err = service.authz.AuthorizeRuleGroupWrite(ctx, user, delta); err != nil {
return models.AlertRule{}, err
}
for _, d := range delta.Update {
if d.Existing.GetKey() == rule.GetKey() {
storedRule = d.Existing
}
}
if storedRule == nil { // this should not happen but we better catch it to avoid panic
return models.AlertRule{}, fmt.Errorf("cannot find rule in the delta")
}
}
storedProvenance, err := service.provenanceStore.GetProvenance(ctx, storedRule, storedRule.OrgID)
if err != nil {
return models.AlertRule{}, err
}
if storedProvenance != provenance && storedProvenance != models.ProvenanceNone {
return models.AlertRule{}, fmt.Errorf("cannot change provenance from '%s' to '%s'", storedProvenance, provenance)
}
if len(rule.NotificationSettings) > 0 {
validator, err := service.nsValidatorProvider.Validator(ctx, rule.OrgID)
if err != nil {
return models.AlertRule{}, err
}
for _, setting := range rule.NotificationSettings {
if err := validator.Validate(setting); err != nil {
return models.AlertRule{}, err
}
}
}
rule.Updated = time.Now()
rule.ID = storedRule.ID
rule.IntervalSeconds = storedRule.IntervalSeconds
err = rule.SetDashboardAndPanelFromAnnotations()
if err != nil {
return models.AlertRule{}, err
}
err = service.xact.InTransaction(ctx, func(ctx context.Context) error {
err := service.ruleStore.UpdateAlertRules(ctx, []models.UpdateRule{
{
Existing: storedRule,
New: rule,
},
})
if err != nil {
return err
}
return service.provenanceStore.SetProvenance(ctx, &rule, rule.OrgID, provenance)
})
if err != nil {
return models.AlertRule{}, err
}
return rule, err
}
func (service *AlertRuleService) DeleteAlertRule(ctx context.Context, user identity.Requester, ruleUID string, provenance models.Provenance) error {
rule := &models.AlertRule{
OrgID: user.GetOrgID(),
UID: ruleUID,
}
// check that provenance is not changed in an invalid way
storedProvenance, err := service.provenanceStore.GetProvenance(ctx, rule, rule.OrgID)
if err != nil {
return err
}
if storedProvenance != provenance && storedProvenance != models.ProvenanceNone {
return fmt.Errorf("cannot delete with provided provenance '%s', needs '%s'", provenance, storedProvenance)
}
can, err := service.authz.CanWriteAllRules(ctx, user)
if err != nil {
return err
}
if !can {
delta, err := store.CalculateRuleDelete(ctx, service.ruleStore, rule.GetKey())
if err != nil {
return err
}
if err = service.authz.AuthorizeRuleGroupWrite(ctx, user, delta); err != nil {
return err
}
}
// The single delete is idempotent, and doesn't error when deleting a group that already doesn't exist.
// This is different from deleting groups. We delete the rules directly rather than persisting a delta here to keep the semantics the same.
// TODO: Either persist a delta here as a breaking change, or deprecate this endpoint in favor of the group endpoint.
return service.xact.InTransaction(ctx, func(ctx context.Context) error {
return service.deleteRules(ctx, user.GetOrgID(), rule)
})
}
// checkLimitsTransactionCtx checks whether the current transaction (as identified by the ctx) breaches configured alert rule limits.
func (service *AlertRuleService) checkLimitsTransactionCtx(ctx context.Context, user identity.Requester) error {
// default to 0 if there is no user
var userID int64
if id, err := identity.UserIdentifier(user.GetID()); err == nil {
userID = id
}
limitReached, err := service.quotas.CheckQuotaReached(ctx, models.QuotaTargetSrv, "a.ScopeParameters{
OrgID: user.GetOrgID(),
UserID: userID,
})
if err != nil {
return fmt.Errorf("failed to check alert rule quota: %w", err)
}
if limitReached {
return models.ErrQuotaReached
}
return nil
}
// deleteRules deletes a set of target rules and associated data, while checking for database consistency.
func (service *AlertRuleService) deleteRules(ctx context.Context, orgID int64, targets ...*models.AlertRule) error {
uids := make([]string, 0, len(targets))
for _, tgt := range targets {
if tgt != nil {
uids = append(uids, tgt.UID)
}
}
if err := service.ruleStore.DeleteAlertRulesByUID(ctx, orgID, uids...); err != nil {
return err
}
for _, uid := range uids {
if err := service.provenanceStore.DeleteProvenance(ctx, &models.AlertRule{UID: uid}, orgID); err != nil {
// We failed to clean up the record, but this doesn't break things. Log it and move on.
service.log.Warn("Failed to delete provenance record for rule: %w", err)
}
}
return nil
}
// GetAlertRuleGroupWithFolderFullpath returns the alert rule group with folder title.
func (service *AlertRuleService) GetAlertRuleGroupWithFolderFullpath(ctx context.Context, user identity.Requester, namespaceUID, group string) (models.AlertRuleGroupWithFolderFullpath, error) {
ruleList, err := service.GetRuleGroup(ctx, user, namespaceUID, group)
if err != nil {
return models.AlertRuleGroupWithFolderFullpath{}, err
}
fq := folder.GetFolderQuery{
OrgID: user.GetOrgID(),
UID: &namespaceUID,
WithFullpath: true,
SignedInUser: user,
}
f, err := service.folderService.Get(ctx, &fq)
if err != nil {
return models.AlertRuleGroupWithFolderFullpath{}, err
}
res := models.NewAlertRuleGroupWithFolderFullpath(ruleList.Rules[0].GetGroupKey(), ruleList.Rules, f.Fullpath)
return res, nil
}
// GetAlertGroupsWithFolderFullpath returns all groups with folder's full path in the folders identified by folderUID that have at least one alert. If argument folderUIDs is nil or empty - returns groups in all folders.
func (service *AlertRuleService) GetAlertGroupsWithFolderFullpath(ctx context.Context, user identity.Requester, folderUIDs []string) ([]models.AlertRuleGroupWithFolderFullpath, error) {
q := models.ListAlertRulesQuery{
OrgID: user.GetOrgID(),
}
if len(folderUIDs) > 0 {
q.NamespaceUIDs = folderUIDs
}
ruleList, err := service.ruleStore.ListAlertRules(ctx, &q)
if err != nil {
return nil, err
}
groups := models.GroupByAlertRuleGroupKey(ruleList)
can, err := service.authz.CanReadAllRules(ctx, user)
if err != nil {
return nil, err
}
if !can {
// if user cannot read all rules, check read access to each group and remove groups that the user does not have access to
for key, group := range groups {
if err := service.authz.AuthorizeRuleGroupRead(ctx, user, group); err != nil {
if errors.Is(err, accesscontrol.ErrAuthorizationBase) {
delete(groups, key)
continue
}
return nil, err
}
}
}
namespaces := make(map[string][]*models.AlertRuleGroupKey)
for groupKey := range groups {
namespaces[groupKey.NamespaceUID] = append(namespaces[groupKey.NamespaceUID], util.Pointer(groupKey))
}
if len(namespaces) == 0 {
return []models.AlertRuleGroupWithFolderFullpath{}, nil
}
fq := folder.GetFoldersQuery{
OrgID: user.GetOrgID(),
UIDs: nil,
WithFullpath: true,
SignedInUser: user,
}
for uid := range namespaces {
fq.UIDs = append(fq.UIDs, uid)
}
// We need folder titles for the provisioning file format. We do it this way instead of using GetUserVisibleNamespaces to avoid folder:read permissions that should not apply to those with alert.provisioning:read.
folders, err := service.folderService.GetFolders(ctx, fq)
if err != nil {
return nil, err
}
folderUidToFullpath := make(map[string]string)
for _, folder := range folders {
folderUidToFullpath[folder.UID] = folder.Fullpath
}
result := make([]models.AlertRuleGroupWithFolderFullpath, 0)
for groupKey, rules := range groups {
fullpath, ok := folderUidToFullpath[groupKey.NamespaceUID]
if !ok {
return nil, fmt.Errorf("cannot find full path for folder with uid '%s'", groupKey.NamespaceUID)
}
result = append(result, models.NewAlertRuleGroupWithFolderFullpathFromRulesGroup(groupKey, rules, fullpath))
}
// Return results in a stable manner.
models.SortAlertRuleGroupWithFolderTitle(result)
return result, nil
}
// syncRuleGroupFields synchronizes calculated fields across multiple rules in a group.
func syncGroupRuleFields(group *models.AlertRuleGroup, orgID int64) *models.AlertRuleGroup {
for i := range group.Rules {
group.Rules[i].IntervalSeconds = group.Interval
group.Rules[i].RuleGroup = group.Title
group.Rules[i].NamespaceUID = group.FolderUID
group.Rules[i].OrgID = orgID
}
return group
}
func withoutNilAlertRules(ptrs []*models.AlertRule) []models.AlertRule {
result := make([]models.AlertRule, 0, len(ptrs))
for _, ptr := range ptrs {
if ptr != nil {
result = append(result, *ptr)
}
}
return result
}
func (service *AlertRuleService) checkGroupLimits(group models.AlertRuleGroup) error {
if service.rulesPerRuleGroupLimit > 0 && int64(len(group.Rules)) > service.rulesPerRuleGroupLimit {
service.log.Warn("Large rule group was edited. Large groups are discouraged and may be rejected in the future.",
"limit", service.rulesPerRuleGroupLimit,
"actual", len(group.Rules),
"group", group.Title,
)
}
return nil
}
// ensureRuleNamespace ensures that the rule has a valid namespace UID.
// If the rule does not have a namespace UID or the namespace (folder) does not exist it will return an error.
func (service *AlertRuleService) ensureRuleNamespace(ctx context.Context, user identity.Requester, rule models.AlertRule) error {
if rule.NamespaceUID == "" {
return fmt.Errorf("%w: folderUID must be set", models.ErrAlertRuleFailedValidation)
}
if service.folderService == nil {
// folder service is nil when this is called during file provisioning,
// which already creates the folder if it does not exist
return nil
}
// ensure the namespace exists
_, err := service.folderService.Get(ctx, &folder.GetFolderQuery{
OrgID: rule.OrgID,
UID: &rule.NamespaceUID,
SignedInUser: user,
})
if err != nil {
if errors.Is(err, dashboards.ErrFolderNotFound) {
return fmt.Errorf("%w: folder does not exist", models.ErrAlertRuleFailedValidation)
}
return err
}
return nil
}