Provisioning: Improve validation by validating across all dashboard providers (#26742)

* Provisioning: check sanity across all dashboard readers Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com> * Apply suggestions from code review Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> * Refactor of duplicateValidator and fix issues according to commentaries Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com> * Apply suggestions from code review Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> * Remove newDuplicateEntries function Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com> * Change folderUid in logs to folderUID Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com> * Restrict write access for readers, which are provisioning duplicate dashboards Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com> * Fix file reader after rebasing onto master Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com> * Apply suggestions from code review Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> * Format file_reader Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com> * Apply suggestions from code review Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> * Apply suggestions from code review Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> * Fix lint problem Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com> * Apply suggestions from code review Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com> Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com> Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2021-07-21 17:52:41 +02:00
parent 1efa5f51cf
commit ec9a587cbe
8 changed files with 865 additions and 51 deletions
@@ -0,0 +1,145 @@
+package dashboards
+
+import (
+	"context"
+	"time"
+
+	"github.com/grafana/grafana/pkg/infra/log"
+)
+
+type duplicate struct {
+	Sum             uint8
+	InvolvedReaders map[string]struct{}
+}
+
+func newDuplicate() *duplicate {
+	return &duplicate{InvolvedReaders: make(map[string]struct{})}
+}
+
+type duplicateEntries struct {
+	Titles map[dashboardIdentity]*duplicate
+	UIDs   map[string]*duplicate
+}
+
+func (d *duplicateEntries) InvolvedReaders() map[string]struct{} {
+	involvedReaders := make(map[string]struct{})
+
+	for _, duplicate := range d.UIDs {
+		if duplicate.Sum <= 1 {
+			continue
+		}
+
+		for readerName := range duplicate.InvolvedReaders {
+			involvedReaders[readerName] = struct{}{}
+		}
+	}
+
+	for _, duplicate := range d.Titles {
+		if duplicate.Sum <= 1 {
+			continue
+		}
+
+		for readerName := range duplicate.InvolvedReaders {
+			involvedReaders[readerName] = struct{}{}
+		}
+	}
+
+	return involvedReaders
+}
+
+type duplicateValidator struct {
+	logger  log.Logger
+	readers []*FileReader
+}
+
+func newDuplicateValidator(logger log.Logger, readers []*FileReader) duplicateValidator {
+	return duplicateValidator{logger: logger, readers: readers}
+}
+
+func (c *duplicateValidator) getDuplicates() *duplicateEntries {
+	duplicates := duplicateEntries{
+		Titles: make(map[dashboardIdentity]*duplicate),
+		UIDs:   make(map[string]*duplicate),
+	}
+
+	for _, reader := range c.readers {
+		readerName := reader.Cfg.Name
+		tracker := reader.getUsageTracker()
+
+		for uid, times := range tracker.uidUsage {
+			if _, ok := duplicates.UIDs[uid]; !ok {
+				duplicates.UIDs[uid] = newDuplicate()
+			}
+			duplicates.UIDs[uid].Sum += times
+			duplicates.UIDs[uid].InvolvedReaders[readerName] = struct{}{}
+		}
+
+		for id, times := range tracker.titleUsage {
+			if _, ok := duplicates.Titles[id]; !ok {
+				duplicates.Titles[id] = newDuplicate()
+			}
+			duplicates.Titles[id].Sum += times
+			duplicates.Titles[id].InvolvedReaders[readerName] = struct{}{}
+		}
+	}
+
+	return &duplicates
+}
+
+func (c *duplicateValidator) logWarnings(duplicates *duplicateEntries) {
+	for uid, usage := range duplicates.UIDs {
+		if usage.Sum > 1 {
+			c.logger.Warn("the same UID is used more than once", "uid", uid, "times", usage.Sum, "providers",
+				keysToSlice(usage.InvolvedReaders))
+		}
+	}
+
+	for id, usage := range duplicates.Titles {
+		if usage.Sum > 1 {
+			c.logger.Warn("dashboard title is not unique in folder", "title", id.title, "folderID", id.folderID, "times",
+				usage.Sum, "providers", keysToSlice(usage.InvolvedReaders))
+		}
+	}
+}
+
+func (c *duplicateValidator) takeAwayWritePermissions(duplicates *duplicateEntries) {
+	involvedReaders := duplicates.InvolvedReaders()
+	for _, reader := range c.readers {
+		_, isReaderWithDuplicates := involvedReaders[reader.Cfg.Name]
+		// We restrict reader permissions to write to the database here to prevent overloading
+		reader.changeWritePermissions(isReaderWithDuplicates)
+
+		if isReaderWithDuplicates {
+			c.logger.Warn("dashboards provisioning provider has no database write permissions because of duplicates", "provider", reader.Cfg.Name)
+		}
+	}
+}
+
+func (c *duplicateValidator) Run(ctx context.Context) {
+	ticker := time.NewTicker(30 * time.Second)
+	for {
+		select {
+		case <-ticker.C:
+			c.validate()
+		case <-ctx.Done():
+			return
+		}
+	}
+}
+
+func (c *duplicateValidator) validate() {
+	duplicates := c.getDuplicates()
+
+	c.logWarnings(duplicates)
+	c.takeAwayWritePermissions(duplicates)
+}
+
+func keysToSlice(data map[string]struct{}) []string {
+	entries := make([]string, 0, len(data))
+
+	for entry := range data {
+		entries = append(entries, entry)
+	}
+
+	return entries
+}