Add ignored prefix to the configurable keys and filter by dashboard name instead of slug

config.example.yaml

@@ -5,6 +5,10 @@ grafana:
     # Grafana API key. This is generated by Grafana, as explained at
     # http://docs.grafana.org/http_api/auth/#create-api-token
     api_key: apiauthkey
+    # If set, all dashboards with a name starting with this prefix will be
+    # ignored by both the puller and the pusher. This setting is
+    # case-insensitive and optional.
+    ignore_prefix: test
 
 # Settings to interact with the Git repository. Currently only SSH repos are
 # supported.

src/config/config.go

@@ -2,6 +2,7 @@ package config
 
 import (
 	"io/ioutil"
+	"strings"
 
 	"gopkg.in/yaml.v2"
 )
@@ -16,8 +17,9 @@ type Config struct {
 
 // GrafanaSettings contains the data required to talk to the Grafana HTTP API.
 type GrafanaSettings struct {
-	BaseURL string `yaml:"base_url"`
-	APIKey  string `yaml:"api_key"`
+	BaseURL      string `yaml:"base_url"`
+	APIKey       string `yaml:"api_key"`
+	IgnorePrefix string `yaml:"ignore_prefix,omitempty"`
 }
 
 // GitSettings contains the data required to interact with the Git repository.
@@ -57,5 +59,6 @@ func Load(filename string) (cfg *Config, err error) {
 
 	cfg = new(Config)
 	err = yaml.Unmarshal(rawCfg, cfg)
+	cfg.Grafana.IgnorePrefix = strings.ToLower(cfg.Grafana.IgnorePrefix)
 	return
 }

src/grafana/dashboards.go

@@ -37,6 +37,7 @@ type dbCreateOrUpdateResponse struct {
 // current version.
 type Dashboard struct {
 	RawJSON []byte
+	Name    string
 	Slug    string
 	Version int
 }
@@ -63,6 +64,24 @@ func (d *Dashboard) UnmarshalJSON(b []byte) (err error) {
 	d.Version = body.Meta.Version
 	d.RawJSON = body.Dashboard
 
+	// Define the dashboard's name from the previously extracted JSON description
+	err = d.setDashboardNameFromRawJSON()
+	return
+}
+
+// setDashboardNameFromJSON finds a dashboard's name from the content of its
+// RawJSON field
+func (d *Dashboard) setDashboardNameFromRawJSON() (err error) {
+	// Define the necessary structure to catch the dashboard's name
+	var dashboard struct {
+		Name string `json:"title"`
+	}
+
+	// Unmarshal the JSON content into the structure and set the dashboard's
+	// name
+	err = json.Unmarshal(d.RawJSON, &dashboard)
+	d.Name = dashboard.Name
+
 	return
 }
 

src/puller/puller.go

@@ -21,9 +21,9 @@ type diffVersion struct {
 }
 
 // PullGrafanaAndCommit pulls all the dashboards from Grafana except the ones
-// which name/slug starts with "test", then commits each of them to Git except
-// for those that have a newer or equal version number already versionned in
-// the repo.
+// which name starts with "test", then commits each of them to Git except for
+// those that have a newer or equal version number already versionned in the
+// repo.
 func PullGrafanaAndCommit(client *grafana.Client, cfg *config.Config) error {
 	// Clone or pull the repo
 	repo, err := git.Sync(cfg.Git)
@@ -52,17 +52,19 @@ func PullGrafanaAndCommit(client *grafana.Client, cfg *config.Config) error {
 
 	// Iterate over the dashboards URIs
 	for _, uri := range uris {
-		// Don't process any dashboard which name/slug starts with "test"
-		if strings.HasPrefix(uri, "db/test") {
-			continue
-		}
-
 		// Retrieve the dashboard JSON
 		dashboard, err := client.GetDashboard(uri)
 		if err != nil {
 			return err
 		}
 
+		if len(cfg.Grafana.IgnorePrefix) > 0 {
+			lowerCasedName := strings.ToLower(dashboard.Name)
+			if strings.HasPrefix(lowerCasedName, cfg.Grafana.IgnorePrefix) {
+				continue
+			}
+		}
+
 		// Check if there's a version for this dashboard in the data loaded from
 		// the "versions.json" file. If there's a version and it's older (lower
 		// version number) than the version we just retrieved from the Grafana

src/pusher/webhook.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"encoding/json"
 	"io/ioutil"
 	"strings"
 
@@ -58,16 +59,28 @@ func HandlePush(payload interface{}, header webhooks.Header) {
 			continue
 		}
 
-		// Push all added files, except the ones which name starts with "test"
+		// Push all added files, except the ones describing a dashboard which
+		// name starts with a the prefix specified in the configuration file.
 		for _, addedFile := range commit.Added {
-			if !strings.HasPrefix(addedFile, "test") {
+			ignored, err := isIgnored(addedFile)
+			if err != nil {
+				panic(err)
+			}
+
+			if !ignored {
 				filesToPush[addedFile] = true
 			}
 		}
 
-		// Push all modified files, except the ones which name starts with "test"
+		// Push all modified files, except the ones describing a dashboard which
+		// name starts with a the prefix specified in the configuration file.
 		for _, modifiedFile := range commit.Modified {
-			if !strings.HasPrefix(addedFile, "test") {
+			ignored, err := isIgnored(modifiedFile)
+			if err != nil {
+				panic(err)
+			}
+
+			if !ignored {
 				filesToPush[modifiedFile] = true
 			}
 		}
@@ -106,3 +119,39 @@ func pushFile(filename string) error {
 
 	return grafanaClient.CreateOrUpdateDashboard(slug, fileContent)
 }
+
+// isIgnored checks whether the file must be ignored, by checking if there's an
+// prefix for ignored files set in the configuration file, and if the dashboard
+// described in the file has a name that starts with this prefix. Returns an
+// error if there was an issue reading or decoding the file.
+// TODO: Optimise this part of the workflow, as all files get open twice (here
+// and in pushFile)
+func isIgnored(filename string) (bool, error) {
+	// If there's no prefix set, no file is ignored
+	if len(cfg.Grafana.IgnorePrefix) == 0 {
+		return false, nil
+	}
+
+	// Read the file's content
+	fileContent, err := ioutil.ReadFile(filename)
+	if err != nil {
+		return false, err
+	}
+
+	// Parse the file's content to find the dashboard's name
+	var dashboardName struct {
+		Name string `json:"title"`
+	}
+	if err = json.Unmarshal(fileContent, &dashboardName); err != nil {
+		return false, err
+	}
+
+	// Compare the lower case dashboar name to the prefix (which has already
+	// been lower cased when loading the configuration file)
+	lowerCaseName := strings.ToLower(dashboardName.Name)
+	if strings.HasPrefix(lowerCaseName, cfg.Grafana.IgnorePrefix) {
+		return true, nil
+	}
+
+	return false, nil
+}