From d69b63cbc0cf6f76f065280b6ed682209b7599de Mon Sep 17 00:00:00 2001 From: bergquist Date: Thu, 23 Nov 2017 11:29:06 +0100 Subject: [PATCH 01/18] dashboards as cfg: read first cfg version --- conf/dashboards/dashboards.yaml | 6 + conf/defaults.ini | 3 + conf/sample.ini | 3 + pkg/cmd/grafana-server/server.go | 2 +- pkg/models/dashboards.go | 13 +- .../provisioning/dashboard/config_reader.go | 49 ++++ .../provisioning/dashboard/dashboard.go | 51 +++++ .../provisioning/dashboard/dashboard_test.go | 47 ++++ .../provisioning/dashboard/file_reader.go | 212 ++++++++++++++++++ .../dashboard/file_reader_test.go | 88 ++++++++ .../dashboards-from-disk/dev-dashboards.yaml | 11 + .../broken-dashboards/empty-json.json | 0 .../broken-dashboards/invalid.json | 174 ++++++++++++++ .../folder-one/dashboard1.json | 173 ++++++++++++++ .../folder-one/dashboard2.json | 173 ++++++++++++++ pkg/services/provisioning/dashboard/types.go | 34 +++ pkg/services/provisioning/provisioning.go | 37 ++- pkg/services/sqlstore/dashboard.go | 5 + pkg/setting/setting.go | 2 + 19 files changed, 1075 insertions(+), 8 deletions(-) create mode 100644 conf/dashboards/dashboards.yaml create mode 100644 pkg/services/provisioning/dashboard/config_reader.go create mode 100644 pkg/services/provisioning/dashboard/dashboard.go create mode 100644 pkg/services/provisioning/dashboard/dashboard_test.go create mode 100644 pkg/services/provisioning/dashboard/file_reader.go create mode 100644 pkg/services/provisioning/dashboard/file_reader_test.go create mode 100644 pkg/services/provisioning/dashboard/test-configs/dashboards-from-disk/dev-dashboards.yaml create mode 100644 pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/empty-json.json create mode 100644 pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/invalid.json create mode 100644 pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard1.json create mode 100644 pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard2.json create mode 100644 pkg/services/provisioning/dashboard/types.go diff --git a/conf/dashboards/dashboards.yaml b/conf/dashboards/dashboards.yaml new file mode 100644 index 00000000000..909a621ca18 --- /dev/null +++ b/conf/dashboards/dashboards.yaml @@ -0,0 +1,6 @@ +- name: 'default' + org_id: 1 + folder: '' + type: file + options: + folder: /var/lib/grafana/dashboards \ No newline at end of file diff --git a/conf/defaults.ini b/conf/defaults.ini index a145d57482b..9dd1857f270 100644 --- a/conf/defaults.ini +++ b/conf/defaults.ini @@ -23,6 +23,9 @@ plugins = data/plugins # Config files containing datasources that will be configured at startup datasources = conf/datasources +# Config files containing folders to read dashboards from and insert into the database. +dashboards = conf/dashboards + #################################### Server ############################## [server] # Protocol (http, https, socket) diff --git a/conf/sample.ini b/conf/sample.ini index 233a97deef8..44e6f0d4ca3 100644 --- a/conf/sample.ini +++ b/conf/sample.ini @@ -23,6 +23,9 @@ # Config files containing datasources that will be configured at startup ;datasources = conf/datasources +# Config files containing folders to read dashboards from and insert into the database. +;dashboards = conf/dashboards + #################################### Server #################################### [server] # Protocol (http, https, socket) diff --git a/pkg/cmd/grafana-server/server.go b/pkg/cmd/grafana-server/server.go index f5c6b0d1cee..820295a9b88 100644 --- a/pkg/cmd/grafana-server/server.go +++ b/pkg/cmd/grafana-server/server.go @@ -68,7 +68,7 @@ func (g *GrafanaServerImpl) Start() { social.NewOAuthService() plugins.Init() - if err := provisioning.StartUp(setting.DatasourcesPath); err != nil { + if err := provisioning.Init(g.context, setting.HomePath, setting.Cfg); err != nil { logger.Error("Failed to provision Grafana from config", "error", err) g.Shutdown(1, "Startup failed") return diff --git a/pkg/models/dashboards.go b/pkg/models/dashboards.go index 0463e9c209b..4d1d1f1f3d5 100644 --- a/pkg/models/dashboards.go +++ b/pkg/models/dashboards.go @@ -11,11 +11,12 @@ import ( // Typed errors var ( - ErrDashboardNotFound = errors.New("Dashboard not found") - ErrDashboardSnapshotNotFound = errors.New("Dashboard snapshot not found") - ErrDashboardWithSameNameExists = errors.New("A dashboard with the same name already exists") - ErrDashboardVersionMismatch = errors.New("The dashboard has been changed by someone else") - ErrDashboardTitleEmpty = errors.New("Dashboard title cannot be empty") + ErrDashboardNotFound = errors.New("Dashboard not found") + ErrDashboardSnapshotNotFound = errors.New("Dashboard snapshot not found") + ErrDashboardWithSameNameExists = errors.New("A dashboard with the same name already exists") + ErrDashboardVersionMismatch = errors.New("The dashboard has been changed by someone else") + ErrDashboardTitleEmpty = errors.New("Dashboard title cannot be empty") + ErrDashboardContainsInvalidAlertData = errors.New("Invalid alert data. Cannot save dashboard") ) type UpdatePluginDashboardError struct { @@ -139,6 +140,8 @@ type SaveDashboardCommand struct { RestoredFrom int `json:"-"` PluginId string `json:"-"` + UpdatedAt time.Time + Result *Dashboard } diff --git a/pkg/services/provisioning/dashboard/config_reader.go b/pkg/services/provisioning/dashboard/config_reader.go new file mode 100644 index 00000000000..d7ee92a592c --- /dev/null +++ b/pkg/services/provisioning/dashboard/config_reader.go @@ -0,0 +1,49 @@ +package dashboard + +import ( + "io/ioutil" + "path/filepath" + "strings" + + yaml "gopkg.in/yaml.v2" +) + +type configReader struct { + path string +} + +func (cr *configReader) readConfig() ([]*DashboardsAsConfig, error) { + files, err := ioutil.ReadDir(cr.path) + if err != nil { + return nil, err + } + + var dashboards []*DashboardsAsConfig + for _, file := range files { + if !strings.HasSuffix(file.Name(), ".yaml") && !strings.HasSuffix(file.Name(), ".yml") { + continue + } + + filename, _ := filepath.Abs(filepath.Join(cr.path, file.Name())) + yamlFile, err := ioutil.ReadFile(filename) + if err != nil { + return nil, err + } + + var datasource []*DashboardsAsConfig + err = yaml.Unmarshal(yamlFile, &datasource) + if err != nil { + return nil, err + } + + dashboards = append(dashboards, datasource...) + } + + for i := range dashboards { + if dashboards[i].OrgId == 0 { + dashboards[i].OrgId = 1 + } + } + + return dashboards, nil +} diff --git a/pkg/services/provisioning/dashboard/dashboard.go b/pkg/services/provisioning/dashboard/dashboard.go new file mode 100644 index 00000000000..22ed5add831 --- /dev/null +++ b/pkg/services/provisioning/dashboard/dashboard.go @@ -0,0 +1,51 @@ +package dashboard + +import ( + "context" + "fmt" + + "github.com/grafana/grafana/pkg/log" +) + +type DashboardProvisioner struct { + cfgReader *configReader + log log.Logger + ctx context.Context +} + +func Provision(ctx context.Context, configDirectory string) (*DashboardProvisioner, error) { + d := &DashboardProvisioner{ + cfgReader: &configReader{path: configDirectory}, + log: log.New("provisioning.dashboard"), + ctx: ctx, + } + + return d, d.Init(ctx) +} + +func (provider *DashboardProvisioner) Init(ctx context.Context) error { + cfgs, err := provider.cfgReader.readConfig() + if err != nil { + return err + } + + for _, cfg := range cfgs { + if cfg.Type == "file" { + fileReader, err := NewDashboardFilereader(cfg, provider.log.New("type", cfg.Type, "name", cfg.Name)) + if err != nil { + return err + } + + // err = fileReader.Init() + // if err != nil { + // provider.log.Error("Failed to load dashboards", "error", err) + // } + + go fileReader.Listen(ctx) + } else { + return fmt.Errorf("type %s is not supported", cfg.Type) + } + } + + return nil +} diff --git a/pkg/services/provisioning/dashboard/dashboard_test.go b/pkg/services/provisioning/dashboard/dashboard_test.go new file mode 100644 index 00000000000..6b1bf3fc6d3 --- /dev/null +++ b/pkg/services/provisioning/dashboard/dashboard_test.go @@ -0,0 +1,47 @@ +package dashboard + +import ( + "testing" + + . "github.com/smartystreets/goconvey/convey" +) + +var ( + simpleDashboardConfig string = "./test-configs/dashboards-from-disk" +) + +func TestDashboardsAsConfig(t *testing.T) { + Convey("Dashboards as configuration", t, func() { + + Convey("Can read config file", func() { + + cfgProvifer := configReader{path: simpleDashboardConfig} + cfg, err := cfgProvifer.readConfig() + if err != nil { + t.Fatalf("readConfig return an error %v", err) + } + + So(len(cfg), ShouldEqual, 2) + + ds := cfg[0] + + So(ds.Name, ShouldEqual, "general dashboards") + So(ds.Type, ShouldEqual, "file") + So(ds.OrgId, ShouldEqual, 2) + So(ds.Folder, ShouldEqual, "developers") + + So(len(ds.Options), ShouldEqual, 1) + So(ds.Options["folder"], ShouldEqual, "/var/lib/grafana/dashboards") + + ds2 := cfg[1] + + So(ds2.Name, ShouldEqual, "default") + So(ds2.Type, ShouldEqual, "file") + So(ds2.OrgId, ShouldEqual, 1) + So(ds2.Folder, ShouldEqual, "") + + So(len(ds2.Options), ShouldEqual, 1) + So(ds2.Options["folder"], ShouldEqual, "/var/lib/grafana/dashboards") + }) + }) +} diff --git a/pkg/services/provisioning/dashboard/file_reader.go b/pkg/services/provisioning/dashboard/file_reader.go new file mode 100644 index 00000000000..c9eacb04aeb --- /dev/null +++ b/pkg/services/provisioning/dashboard/file_reader.go @@ -0,0 +1,212 @@ +package dashboard + +import ( + "context" + "fmt" + "github.com/grafana/grafana/pkg/services/alerting" + "os" + "path/filepath" + "strings" + "sync" + "time" + + "github.com/grafana/grafana/pkg/bus" + + "github.com/grafana/grafana/pkg/components/simplejson" + "github.com/grafana/grafana/pkg/log" + "github.com/grafana/grafana/pkg/models" +) + +type fileReader struct { + Cfg *DashboardsAsConfig + Path string + log log.Logger + dashboardCache *dashboardCache +} + +type dashboardCache struct { + mutex *sync.Mutex + dashboards map[string]*DashboardJson +} + +func newDashboardCache() *dashboardCache { + return &dashboardCache{ + dashboards: map[string]*DashboardJson{}, + mutex: &sync.Mutex{}, + } +} + +func (dc *dashboardCache) addCache(json *DashboardJson) { + dc.mutex.Lock() + defer dc.mutex.Unlock() + dc.dashboards[json.Path] = json +} + +func (dc *dashboardCache) getCache(path string) (*DashboardJson, bool) { + dc.mutex.Lock() + defer dc.mutex.Unlock() + v, exist := dc.dashboards[path] + return v, exist +} + +func NewDashboardFilereader(cfg *DashboardsAsConfig, log log.Logger) (*fileReader, error) { + path, ok := cfg.Options["folder"].(string) + if !ok { + return nil, fmt.Errorf("Failed to load dashboards. folder param is not a string") + } + + if _, err := os.Stat(path); os.IsNotExist(err) { + log.Error("Cannot read directory", "error", err) + } + + return &fileReader{ + Cfg: cfg, + Path: path, + log: log, + dashboardCache: newDashboardCache(), + }, nil +} + +func (fr *fileReader) Listen(ctx context.Context) error { + ticker := time.NewTicker(time.Second * 1) + + if err := fr.walkFolder(); err != nil { + fr.log.Error("failed to search for dashboards", "error", err) + } + + for { + select { + case <-ticker.C: + fr.walkFolder() + case <-ctx.Done(): + return nil + } + } +} + +func (fr *fileReader) walkFolder() error { + if _, err := os.Stat(fr.Path); err != nil { + if os.IsNotExist(err) { + return err + } + } + + return filepath.Walk(fr.Path, func(path string, f os.FileInfo, err error) error { + if err != nil { + return err + } + if f.IsDir() { + if strings.HasPrefix(f.Name(), ".") { + return filepath.SkipDir + } + return nil + } + + if !strings.HasSuffix(f.Name(), ".json") { + return nil + } + + cachedDashboard, exist := fr.dashboardCache.getCache(path) + if exist && cachedDashboard.ModTime == f.ModTime() { + return nil + } + + dash, err := fr.readDashboardFromFile(path) + if err != nil { + fr.log.Error("failed to load dashboard from ", "file", path, "error", err) + return nil + } + + cmd := &models.GetDashboardQuery{Slug: dash.Dashboard.Slug} + err = bus.Dispatch(cmd) + + if err == models.ErrDashboardNotFound { + fr.log.Debug("saving new dashboard", "file", path) + return fr.saveDashboard(dash) + } + + if err != nil { + fr.log.Error("failed to query for dashboard", "slug", dash.Dashboard.Slug, "error", err) + return nil + } + + if cmd.Result.Updated.Unix() >= f.ModTime().Unix() { + fr.log.Debug("already using latest version", "dashboard", dash.Dashboard.Slug) + return nil + } + + fr.log.Debug("no dashboard in cache. Loading dashboard from disk into database.", "file", path) + return fr.saveDashboard(dash) + }) +} + +func (fr *fileReader) readDashboardFromFile(path string) (*DashboardJson, error) { + reader, err := os.Open(path) + if err != nil { + return nil, err + } + defer reader.Close() + + data, err := simplejson.NewFromReader(reader) + if err != nil { + return nil, err + } + + stat, _ := os.Stat(path) + dash := &DashboardJson{} + dash.Dashboard = models.NewDashboardFromJson(data) + dash.TitleLower = strings.ToLower(dash.Dashboard.Title) + dash.Path = path + dash.ModTime = stat.ModTime() + dash.OrgId = fr.Cfg.OrgId + dash.Folder = fr.Cfg.Folder + + if dash.Dashboard.Title == "" { + return nil, models.ErrDashboardTitleEmpty + } + + fr.dashboardCache.addCache(dash) + + return dash, nil +} + +func (fr *fileReader) saveDashboard(dashboardJson *DashboardJson) error { + dash := dashboardJson.Dashboard + + if dash.Title == "" { + return models.ErrDashboardTitleEmpty + } + + validateAlertsCmd := alerting.ValidateDashboardAlertsCommand{ + OrgId: dashboardJson.OrgId, + Dashboard: dash, + } + + if err := bus.Dispatch(&validateAlertsCmd); err != nil { + return models.ErrDashboardContainsInvalidAlertData + } + + cmd := models.SaveDashboardCommand{ + Dashboard: dash.Data, + Message: "Dashboard created from file.", + OrgId: dashboardJson.OrgId, + Overwrite: true, + UpdatedAt: dashboardJson.ModTime, + } + + err := bus.Dispatch(&cmd) + if err != nil { + return err + } + + alertCmd := alerting.UpdateDashboardAlertsCommand{ + OrgId: dashboardJson.OrgId, + Dashboard: cmd.Result, + } + + if err := bus.Dispatch(&alertCmd); err != nil { + return err + } + + return nil +} diff --git a/pkg/services/provisioning/dashboard/file_reader_test.go b/pkg/services/provisioning/dashboard/file_reader_test.go new file mode 100644 index 00000000000..095d0feeb3f --- /dev/null +++ b/pkg/services/provisioning/dashboard/file_reader_test.go @@ -0,0 +1,88 @@ +package dashboard + +import ( + "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/models" + "github.com/grafana/grafana/pkg/services/alerting" + "testing" + + "github.com/grafana/grafana/pkg/log" + . "github.com/smartystreets/goconvey/convey" +) + +var ( + defaultDashboards string = "./test-dashboards/folder-one" + brokenDashboards string = "./test-dashboards/broken-dashboards" +) + +func TestDashboardFileReader(t *testing.T) { + Convey("Reading dashboards from disk", t, func() { + bus.ClearBusHandlers() + + bus.AddHandler("test", mockGetDashboardQuery) + bus.AddHandler("test", mockValidateDashboardAlertsCommand) + bus.AddHandler("test", mockSaveDashboardCommand) + bus.AddHandler("test", mockUpdateDashboardAlertsCommand) + logger := log.New("test.logger") + + Convey("Can read default dashboard", func() { + cfg := &DashboardsAsConfig{ + Name: "Default", + Type: "file", + OrgId: 1, + Folder: "", + Options: map[string]interface{}{ + "folder": defaultDashboards, + }, + } + reader, err := NewDashboardFilereader(cfg, logger) + So(err, ShouldBeNil) + + err = reader.walkFolder() + So(err, ShouldBeNil) + }) + + Convey("Invalid configuration should return error", func() { + cfg := &DashboardsAsConfig{ + Name: "Default", + Type: "file", + OrgId: 1, + Folder: "", + } + + _, err := NewDashboardFilereader(cfg, logger) + So(err, ShouldNotBeNil) + }) + + Convey("Broken dashboards should not cause error", func() { + cfg := &DashboardsAsConfig{ + Name: "Default", + Type: "file", + OrgId: 1, + Folder: "", + Options: map[string]interface{}{ + "folder": brokenDashboards, + }, + } + + _, err := NewDashboardFilereader(cfg, logger) + So(err, ShouldBeNil) + }) + }) +} + +func mockGetDashboardQuery(cmd *models.GetDashboardQuery) error { + return models.ErrDashboardNotFound +} + +func mockValidateDashboardAlertsCommand(cmd *alerting.ValidateDashboardAlertsCommand) error { + return nil +} + +func mockSaveDashboardCommand(cmd *models.SaveDashboardCommand) error { + return nil +} + +func mockUpdateDashboardAlertsCommand(cmd *alerting.UpdateDashboardAlertsCommand) error { + return nil +} diff --git a/pkg/services/provisioning/dashboard/test-configs/dashboards-from-disk/dev-dashboards.yaml b/pkg/services/provisioning/dashboard/test-configs/dashboards-from-disk/dev-dashboards.yaml new file mode 100644 index 00000000000..67cb383e813 --- /dev/null +++ b/pkg/services/provisioning/dashboard/test-configs/dashboards-from-disk/dev-dashboards.yaml @@ -0,0 +1,11 @@ +- name: 'general dashboards' + org_id: 2 + folder: 'developers' + type: file + options: + folder: /var/lib/grafana/dashboards + +- name: 'default' + type: file + options: + folder: /var/lib/grafana/dashboards diff --git a/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/empty-json.json b/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/empty-json.json new file mode 100644 index 00000000000..e69de29bb2d diff --git a/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/invalid.json b/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/invalid.json new file mode 100644 index 00000000000..1aa388a6e78 --- /dev/null +++ b/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/invalid.json @@ -0,0 +1,174 @@ +[] +{ + "title": "Grafana", + "tags": [], + "style": "dark", + "timezone": "browser", + "editable": true, + "rows": [ + { + "title": "New row", + "height": "150px", + "collapse": false, + "editable": true, + "panels": [ + { + "id": 1, + "span": 12, + "editable": true, + "type": "text", + "mode": "html", + "content": "
\n \n
", + "style": {}, + "title": "Welcome to" + } + ] + }, + { + "title": "Welcome to Grafana", + "height": "210px", + "collapse": false, + "editable": true, + "panels": [ + { + "id": 2, + "span": 6, + "type": "text", + "mode": "html", + "content": "
\n\n
\n
\n \n
\n
\n \n
\n
", + "style": {}, + "title": "Documentation Links" + }, + { + "id": 3, + "span": 6, + "type": "text", + "mode": "html", + "content": "
\n\n
\n
\n
    \n
  • Ctrl+S saves the current dashboard
    • \n
  • Ctrl+F Opens the dashboard finder
    • \n
  • Ctrl+H Hide/show row controls
    • \n
  • Click and drag graph title to move panel
    • \n
  • Hit Escape to exit graph when in fullscreen or edit mode
    • \n
  • Click the colored icon in the legend to change series color
    • \n
  • Ctrl or Shift + Click legend name to hide other series
    • \n
\n
\n
\n", + "style": {}, + "title": "Tips & Shortcuts" + } + ] + }, + { + "title": "test", + "height": "250px", + "editable": true, + "collapse": false, + "panels": [ + { + "id": 4, + "span": 12, + "type": "graph", + "x-axis": true, + "y-axis": true, + "scale": 1, + "y_formats": [ + "short", + "short" + ], + "grid": { + "max": null, + "min": null, + "leftMax": null, + "rightMax": null, + "leftMin": null, + "rightMin": null, + "threshold1": null, + "threshold2": null, + "threshold1Color": "rgba(216, 200, 27, 0.27)", + "threshold2Color": "rgba(234, 112, 112, 0.22)" + }, + "resolution": 100, + "lines": true, + "fill": 1, + "linewidth": 2, + "dashes": false, + "dashLength": 10, + "spaceLength": 10, + "points": false, + "pointradius": 5, + "bars": false, + "stack": true, + "spyable": true, + "options": false, + "legend": { + "show": true, + "values": false, + "min": false, + "max": false, + "current": false, + "total": false, + "avg": false + }, + "interactive": true, + "legend_counts": true, + "timezone": "browser", + "percentage": false, + "nullPointMode": "connected", + "steppedLine": false, + "tooltip": { + "value_type": "cumulative", + "query_as_alias": true + }, + "targets": [ + { + "target": "randomWalk('random walk')", + "function": "mean", + "column": "value" + } + ], + "aliasColors": {}, + "aliasYAxis": {}, + "title": "First Graph (click title to edit)", + "datasource": "graphite", + "renderer": "flot", + "annotate": { + "enable": false + } + } + ] + } + ], + "nav": [ + { + "type": "timepicker", + "collapse": false, + "enable": true, + "status": "Stable", + "time_options": [ + "5m", + "15m", + "1h", + "6h", + "12h", + "24h", + "2d", + "7d", + "30d" + ], + "refresh_intervals": [ + "5s", + "10s", + "30s", + "1m", + "5m", + "15m", + "30m", + "1h", + "2h", + "1d" + ], + "now": true + } + ], + "time": { + "from": "now-6h", + "to": "now" + }, + "templating": { + "list": [] + }, + "version": 5 + } + \ No newline at end of file diff --git a/pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard1.json b/pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard1.json new file mode 100644 index 00000000000..5b6765a4ed6 --- /dev/null +++ b/pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard1.json @@ -0,0 +1,173 @@ +{ + "title": "Grafana", + "tags": [], + "style": "dark", + "timezone": "browser", + "editable": true, + "rows": [ + { + "title": "New row", + "height": "150px", + "collapse": false, + "editable": true, + "panels": [ + { + "id": 1, + "span": 12, + "editable": true, + "type": "text", + "mode": "html", + "content": "
\n \n
", + "style": {}, + "title": "Welcome to" + } + ] + }, + { + "title": "Welcome to Grafana", + "height": "210px", + "collapse": false, + "editable": true, + "panels": [ + { + "id": 2, + "span": 6, + "type": "text", + "mode": "html", + "content": "
\n\n
\n
\n \n
\n
\n \n
\n
", + "style": {}, + "title": "Documentation Links" + }, + { + "id": 3, + "span": 6, + "type": "text", + "mode": "html", + "content": "
\n\n
\n
\n
    \n
  • Ctrl+S saves the current dashboard
    • \n
  • Ctrl+F Opens the dashboard finder
    • \n
  • Ctrl+H Hide/show row controls
    • \n
  • Click and drag graph title to move panel
    • \n
  • Hit Escape to exit graph when in fullscreen or edit mode
    • \n
  • Click the colored icon in the legend to change series color
    • \n
  • Ctrl or Shift + Click legend name to hide other series
    • \n
\n
\n
\n", + "style": {}, + "title": "Tips & Shortcuts" + } + ] + }, + { + "title": "test", + "height": "250px", + "editable": true, + "collapse": false, + "panels": [ + { + "id": 4, + "span": 12, + "type": "graph", + "x-axis": true, + "y-axis": true, + "scale": 1, + "y_formats": [ + "short", + "short" + ], + "grid": { + "max": null, + "min": null, + "leftMax": null, + "rightMax": null, + "leftMin": null, + "rightMin": null, + "threshold1": null, + "threshold2": null, + "threshold1Color": "rgba(216, 200, 27, 0.27)", + "threshold2Color": "rgba(234, 112, 112, 0.22)" + }, + "resolution": 100, + "lines": true, + "fill": 1, + "linewidth": 2, + "dashes": false, + "dashLength": 10, + "spaceLength": 10, + "points": false, + "pointradius": 5, + "bars": false, + "stack": true, + "spyable": true, + "options": false, + "legend": { + "show": true, + "values": false, + "min": false, + "max": false, + "current": false, + "total": false, + "avg": false + }, + "interactive": true, + "legend_counts": true, + "timezone": "browser", + "percentage": false, + "nullPointMode": "connected", + "steppedLine": false, + "tooltip": { + "value_type": "cumulative", + "query_as_alias": true + }, + "targets": [ + { + "target": "randomWalk('random walk')", + "function": "mean", + "column": "value" + } + ], + "aliasColors": {}, + "aliasYAxis": {}, + "title": "First Graph (click title to edit)", + "datasource": "graphite", + "renderer": "flot", + "annotate": { + "enable": false + } + } + ] + } + ], + "nav": [ + { + "type": "timepicker", + "collapse": false, + "enable": true, + "status": "Stable", + "time_options": [ + "5m", + "15m", + "1h", + "6h", + "12h", + "24h", + "2d", + "7d", + "30d" + ], + "refresh_intervals": [ + "5s", + "10s", + "30s", + "1m", + "5m", + "15m", + "30m", + "1h", + "2h", + "1d" + ], + "now": true + } + ], + "time": { + "from": "now-6h", + "to": "now" + }, + "templating": { + "list": [] + }, + "version": 5 + } + \ No newline at end of file diff --git a/pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard2.json b/pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard2.json new file mode 100644 index 00000000000..5b6765a4ed6 --- /dev/null +++ b/pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard2.json @@ -0,0 +1,173 @@ +{ + "title": "Grafana", + "tags": [], + "style": "dark", + "timezone": "browser", + "editable": true, + "rows": [ + { + "title": "New row", + "height": "150px", + "collapse": false, + "editable": true, + "panels": [ + { + "id": 1, + "span": 12, + "editable": true, + "type": "text", + "mode": "html", + "content": "
\n \n
", + "style": {}, + "title": "Welcome to" + } + ] + }, + { + "title": "Welcome to Grafana", + "height": "210px", + "collapse": false, + "editable": true, + "panels": [ + { + "id": 2, + "span": 6, + "type": "text", + "mode": "html", + "content": "
\n\n
\n
\n \n
\n
\n \n
\n
", + "style": {}, + "title": "Documentation Links" + }, + { + "id": 3, + "span": 6, + "type": "text", + "mode": "html", + "content": "
\n\n
\n
\n
    \n
  • Ctrl+S saves the current dashboard
    • \n
  • Ctrl+F Opens the dashboard finder
    • \n
  • Ctrl+H Hide/show row controls
    • \n
  • Click and drag graph title to move panel
    • \n
  • Hit Escape to exit graph when in fullscreen or edit mode
    • \n
  • Click the colored icon in the legend to change series color
    • \n
  • Ctrl or Shift + Click legend name to hide other series
    • \n
\n
\n
\n", + "style": {}, + "title": "Tips & Shortcuts" + } + ] + }, + { + "title": "test", + "height": "250px", + "editable": true, + "collapse": false, + "panels": [ + { + "id": 4, + "span": 12, + "type": "graph", + "x-axis": true, + "y-axis": true, + "scale": 1, + "y_formats": [ + "short", + "short" + ], + "grid": { + "max": null, + "min": null, + "leftMax": null, + "rightMax": null, + "leftMin": null, + "rightMin": null, + "threshold1": null, + "threshold2": null, + "threshold1Color": "rgba(216, 200, 27, 0.27)", + "threshold2Color": "rgba(234, 112, 112, 0.22)" + }, + "resolution": 100, + "lines": true, + "fill": 1, + "linewidth": 2, + "dashes": false, + "dashLength": 10, + "spaceLength": 10, + "points": false, + "pointradius": 5, + "bars": false, + "stack": true, + "spyable": true, + "options": false, + "legend": { + "show": true, + "values": false, + "min": false, + "max": false, + "current": false, + "total": false, + "avg": false + }, + "interactive": true, + "legend_counts": true, + "timezone": "browser", + "percentage": false, + "nullPointMode": "connected", + "steppedLine": false, + "tooltip": { + "value_type": "cumulative", + "query_as_alias": true + }, + "targets": [ + { + "target": "randomWalk('random walk')", + "function": "mean", + "column": "value" + } + ], + "aliasColors": {}, + "aliasYAxis": {}, + "title": "First Graph (click title to edit)", + "datasource": "graphite", + "renderer": "flot", + "annotate": { + "enable": false + } + } + ] + } + ], + "nav": [ + { + "type": "timepicker", + "collapse": false, + "enable": true, + "status": "Stable", + "time_options": [ + "5m", + "15m", + "1h", + "6h", + "12h", + "24h", + "2d", + "7d", + "30d" + ], + "refresh_intervals": [ + "5s", + "10s", + "30s", + "1m", + "5m", + "15m", + "30m", + "1h", + "2h", + "1d" + ], + "now": true + } + ], + "time": { + "from": "now-6h", + "to": "now" + }, + "templating": { + "list": [] + }, + "version": 5 + } + \ No newline at end of file diff --git a/pkg/services/provisioning/dashboard/types.go b/pkg/services/provisioning/dashboard/types.go new file mode 100644 index 00000000000..cef6b217fee --- /dev/null +++ b/pkg/services/provisioning/dashboard/types.go @@ -0,0 +1,34 @@ +package dashboard + +import ( + "sync" + "time" + + "github.com/grafana/grafana/pkg/models" +) + +type DashboardsAsConfig struct { + Name string `json:"name" yaml:"name"` + Type string `json:"type" yaml:"type"` + OrgId int64 `json:"org_id" yaml:"org_id"` + Folder string `json:"folder" yaml:"folder"` + Options map[string]interface{} `json:"options" yaml:"options"` +} + +type DashboardJson struct { + TitleLower string + Path string + OrgId int64 + Folder string + ModTime time.Time + Dashboard *models.Dashboard +} + +type DashboardIndex struct { + mutex *sync.Mutex + + PathToDashboard map[string]*DashboardJson +} + +type InsertDashboard func(cmd *models.Dashboard) error +type UpdateDashboard func(cmd *models.SaveDashboardCommand) error diff --git a/pkg/services/provisioning/provisioning.go b/pkg/services/provisioning/provisioning.go index 1bea60f03e4..51f406dc9d5 100644 --- a/pkg/services/provisioning/provisioning.go +++ b/pkg/services/provisioning/provisioning.go @@ -1,14 +1,47 @@ package provisioning import ( + "context" + "path/filepath" + "github.com/grafana/grafana/pkg/log" + "github.com/grafana/grafana/pkg/services/provisioning/dashboard" "github.com/grafana/grafana/pkg/services/provisioning/datasources" + ini "gopkg.in/ini.v1" ) var ( logger log.Logger = log.New("services.provisioning") ) -func StartUp(datasourcePath string) error { - return datasources.Provision(datasourcePath) +type Provisioner struct { + datasourcePath string + dashboardPath string + bgContext context.Context +} + +func Init(backgroundContext context.Context, homePath string, cfg *ini.File) error { + datasourcePath := makeAbsolute(cfg.Section("paths").Key("datasources").String(), homePath) + if err := datasources.Provision(datasourcePath); err != nil { + return err + } + + dashboardPath := makeAbsolute(cfg.Section("paths").Key("dashboards").String(), homePath) + _, err := dashboard.Provision(backgroundContext, dashboardPath) + if err != nil { + return err + } + + return nil +} + +func (p *Provisioner) Listen() error { + return nil +} + +func makeAbsolute(path string, root string) string { + if filepath.IsAbs(path) { + return path + } + return filepath.Join(root, path) } diff --git a/pkg/services/sqlstore/dashboard.go b/pkg/services/sqlstore/dashboard.go index d91b4a08aa6..cdf9d4eb3c7 100644 --- a/pkg/services/sqlstore/dashboard.go +++ b/pkg/services/sqlstore/dashboard.go @@ -81,6 +81,11 @@ func SaveDashboard(cmd *m.SaveDashboardCommand) error { } else { dash.Version += 1 dash.Data.Set("version", dash.Version) + + if !cmd.UpdatedAt.IsZero() { + dash.Updated = cmd.UpdatedAt + } + affectedRows, err = sess.Id(dash.Id).Update(dash) } diff --git a/pkg/setting/setting.go b/pkg/setting/setting.go index 2caf7366727..f604cdd680b 100644 --- a/pkg/setting/setting.go +++ b/pkg/setting/setting.go @@ -55,6 +55,7 @@ var ( DataPath string PluginsPath string DatasourcesPath string + DashboardsPath string CustomInitPath = "conf/custom.ini" // Log settings. @@ -475,6 +476,7 @@ func NewConfigContext(args *CommandLineArgs) error { InstanceName = Cfg.Section("").Key("instance_name").MustString("unknown_instance_name") PluginsPath = makeAbsolute(Cfg.Section("paths").Key("plugins").String(), HomePath) DatasourcesPath = makeAbsolute(Cfg.Section("paths").Key("datasources").String(), HomePath) + DashboardsPath = makeAbsolute(Cfg.Section("paths").Key("dashboards").String(), HomePath) server := Cfg.Section("server") AppUrl, AppSubUrl = parseAppUrlAndSubUrl(server) From dc0fb8be06d17707b212c9f79df9221f9f5ad751 Mon Sep 17 00:00:00 2001 From: bergquist Date: Tue, 28 Nov 2017 14:01:10 +0100 Subject: [PATCH 02/18] dashboards as cfg: code cleanup --- .../provisioning/dashboard/dashboard.go | 12 ++++------ .../provisioning/dashboard/file_reader.go | 4 ++-- .../datasources.go | 2 +- .../datasources_test.go | 2 +- .../all-properties/all-properties.yaml | 0 .../test-configs/all-properties/not.yaml.txt | 0 .../test-configs/all-properties/second.yaml | 0 .../test-configs/broken-yaml/broken.yaml | 0 .../double-default/default-1.yaml | 0 .../double-default/default-2.yaml | 0 .../one-datasources.yaml | 0 .../insert-two-delete-two/two-datasources.yml | 0 .../two-datasources/two-datasources.yaml | 0 .../zero-datasources/placeholder-for-git | 0 .../{datasources => datasource}/types.go | 2 +- pkg/services/provisioning/provisioning.go | 23 ++++--------------- 16 files changed, 13 insertions(+), 32 deletions(-) rename pkg/services/provisioning/{datasources => datasource}/datasources.go (99%) rename pkg/services/provisioning/{datasources => datasource}/datasources_test.go (99%) rename pkg/services/provisioning/{datasources => datasource}/test-configs/all-properties/all-properties.yaml (100%) rename pkg/services/provisioning/{datasources => datasource}/test-configs/all-properties/not.yaml.txt (100%) rename pkg/services/provisioning/{datasources => datasource}/test-configs/all-properties/second.yaml (100%) rename pkg/services/provisioning/{datasources => datasource}/test-configs/broken-yaml/broken.yaml (100%) rename pkg/services/provisioning/{datasources => datasource}/test-configs/double-default/default-1.yaml (100%) rename pkg/services/provisioning/{datasources => datasource}/test-configs/double-default/default-2.yaml (100%) rename pkg/services/provisioning/{datasources => datasource}/test-configs/insert-two-delete-two/one-datasources.yaml (100%) rename pkg/services/provisioning/{datasources => datasource}/test-configs/insert-two-delete-two/two-datasources.yml (100%) rename pkg/services/provisioning/{datasources => datasource}/test-configs/two-datasources/two-datasources.yaml (100%) rename pkg/services/provisioning/{datasources => datasource}/test-configs/zero-datasources/placeholder-for-git (100%) rename pkg/services/provisioning/{datasources => datasource}/types.go (99%) diff --git a/pkg/services/provisioning/dashboard/dashboard.go b/pkg/services/provisioning/dashboard/dashboard.go index 22ed5add831..c67c645f242 100644 --- a/pkg/services/provisioning/dashboard/dashboard.go +++ b/pkg/services/provisioning/dashboard/dashboard.go @@ -30,19 +30,15 @@ func (provider *DashboardProvisioner) Init(ctx context.Context) error { } for _, cfg := range cfgs { - if cfg.Type == "file" { + switch cfg.Type { + case "file": fileReader, err := NewDashboardFilereader(cfg, provider.log.New("type", cfg.Type, "name", cfg.Name)) if err != nil { return err } - // err = fileReader.Init() - // if err != nil { - // provider.log.Error("Failed to load dashboards", "error", err) - // } - - go fileReader.Listen(ctx) - } else { + go fileReader.ReadAndListen(ctx) + default: return fmt.Errorf("type %s is not supported", cfg.Type) } } diff --git a/pkg/services/provisioning/dashboard/file_reader.go b/pkg/services/provisioning/dashboard/file_reader.go index c9eacb04aeb..b3fa3e5cfd8 100644 --- a/pkg/services/provisioning/dashboard/file_reader.go +++ b/pkg/services/provisioning/dashboard/file_reader.go @@ -67,8 +67,8 @@ func NewDashboardFilereader(cfg *DashboardsAsConfig, log log.Logger) (*fileReade }, nil } -func (fr *fileReader) Listen(ctx context.Context) error { - ticker := time.NewTicker(time.Second * 1) +func (fr *fileReader) ReadAndListen(ctx context.Context) error { + ticker := time.NewTicker(time.Second * 10) if err := fr.walkFolder(); err != nil { fr.log.Error("failed to search for dashboards", "error", err) diff --git a/pkg/services/provisioning/datasources/datasources.go b/pkg/services/provisioning/datasource/datasources.go similarity index 99% rename from pkg/services/provisioning/datasources/datasources.go rename to pkg/services/provisioning/datasource/datasources.go index 325dbbbd757..be854bfe2bc 100644 --- a/pkg/services/provisioning/datasources/datasources.go +++ b/pkg/services/provisioning/datasource/datasources.go @@ -1,4 +1,4 @@ -package datasources +package datasource import ( "errors" diff --git a/pkg/services/provisioning/datasources/datasources_test.go b/pkg/services/provisioning/datasource/datasources_test.go similarity index 99% rename from pkg/services/provisioning/datasources/datasources_test.go rename to pkg/services/provisioning/datasource/datasources_test.go index f3252c28d9d..d746e794d92 100644 --- a/pkg/services/provisioning/datasources/datasources_test.go +++ b/pkg/services/provisioning/datasource/datasources_test.go @@ -1,4 +1,4 @@ -package datasources +package datasource import ( "testing" diff --git a/pkg/services/provisioning/datasources/test-configs/all-properties/all-properties.yaml b/pkg/services/provisioning/datasource/test-configs/all-properties/all-properties.yaml similarity index 100% rename from pkg/services/provisioning/datasources/test-configs/all-properties/all-properties.yaml rename to pkg/services/provisioning/datasource/test-configs/all-properties/all-properties.yaml diff --git a/pkg/services/provisioning/datasources/test-configs/all-properties/not.yaml.txt b/pkg/services/provisioning/datasource/test-configs/all-properties/not.yaml.txt similarity index 100% rename from pkg/services/provisioning/datasources/test-configs/all-properties/not.yaml.txt rename to pkg/services/provisioning/datasource/test-configs/all-properties/not.yaml.txt diff --git a/pkg/services/provisioning/datasources/test-configs/all-properties/second.yaml b/pkg/services/provisioning/datasource/test-configs/all-properties/second.yaml similarity index 100% rename from pkg/services/provisioning/datasources/test-configs/all-properties/second.yaml rename to pkg/services/provisioning/datasource/test-configs/all-properties/second.yaml diff --git a/pkg/services/provisioning/datasources/test-configs/broken-yaml/broken.yaml b/pkg/services/provisioning/datasource/test-configs/broken-yaml/broken.yaml similarity index 100% rename from pkg/services/provisioning/datasources/test-configs/broken-yaml/broken.yaml rename to pkg/services/provisioning/datasource/test-configs/broken-yaml/broken.yaml diff --git a/pkg/services/provisioning/datasources/test-configs/double-default/default-1.yaml b/pkg/services/provisioning/datasource/test-configs/double-default/default-1.yaml similarity index 100% rename from pkg/services/provisioning/datasources/test-configs/double-default/default-1.yaml rename to pkg/services/provisioning/datasource/test-configs/double-default/default-1.yaml diff --git a/pkg/services/provisioning/datasources/test-configs/double-default/default-2.yaml b/pkg/services/provisioning/datasource/test-configs/double-default/default-2.yaml similarity index 100% rename from pkg/services/provisioning/datasources/test-configs/double-default/default-2.yaml rename to pkg/services/provisioning/datasource/test-configs/double-default/default-2.yaml diff --git a/pkg/services/provisioning/datasources/test-configs/insert-two-delete-two/one-datasources.yaml b/pkg/services/provisioning/datasource/test-configs/insert-two-delete-two/one-datasources.yaml similarity index 100% rename from pkg/services/provisioning/datasources/test-configs/insert-two-delete-two/one-datasources.yaml rename to pkg/services/provisioning/datasource/test-configs/insert-two-delete-two/one-datasources.yaml diff --git a/pkg/services/provisioning/datasources/test-configs/insert-two-delete-two/two-datasources.yml b/pkg/services/provisioning/datasource/test-configs/insert-two-delete-two/two-datasources.yml similarity index 100% rename from pkg/services/provisioning/datasources/test-configs/insert-two-delete-two/two-datasources.yml rename to pkg/services/provisioning/datasource/test-configs/insert-two-delete-two/two-datasources.yml diff --git a/pkg/services/provisioning/datasources/test-configs/two-datasources/two-datasources.yaml b/pkg/services/provisioning/datasource/test-configs/two-datasources/two-datasources.yaml similarity index 100% rename from pkg/services/provisioning/datasources/test-configs/two-datasources/two-datasources.yaml rename to pkg/services/provisioning/datasource/test-configs/two-datasources/two-datasources.yaml diff --git a/pkg/services/provisioning/datasources/test-configs/zero-datasources/placeholder-for-git b/pkg/services/provisioning/datasource/test-configs/zero-datasources/placeholder-for-git similarity index 100% rename from pkg/services/provisioning/datasources/test-configs/zero-datasources/placeholder-for-git rename to pkg/services/provisioning/datasource/test-configs/zero-datasources/placeholder-for-git diff --git a/pkg/services/provisioning/datasources/types.go b/pkg/services/provisioning/datasource/types.go similarity index 99% rename from pkg/services/provisioning/datasources/types.go rename to pkg/services/provisioning/datasource/types.go index ee2175d6a90..6434074d5d4 100644 --- a/pkg/services/provisioning/datasources/types.go +++ b/pkg/services/provisioning/datasource/types.go @@ -1,4 +1,4 @@ -package datasources +package datasource import "github.com/grafana/grafana/pkg/models" import "github.com/grafana/grafana/pkg/components/simplejson" diff --git a/pkg/services/provisioning/provisioning.go b/pkg/services/provisioning/provisioning.go index 51f406dc9d5..c72ba6dc4f5 100644 --- a/pkg/services/provisioning/provisioning.go +++ b/pkg/services/provisioning/provisioning.go @@ -4,30 +4,19 @@ import ( "context" "path/filepath" - "github.com/grafana/grafana/pkg/log" "github.com/grafana/grafana/pkg/services/provisioning/dashboard" - "github.com/grafana/grafana/pkg/services/provisioning/datasources" + "github.com/grafana/grafana/pkg/services/provisioning/datasource" ini "gopkg.in/ini.v1" ) -var ( - logger log.Logger = log.New("services.provisioning") -) - -type Provisioner struct { - datasourcePath string - dashboardPath string - bgContext context.Context -} - -func Init(backgroundContext context.Context, homePath string, cfg *ini.File) error { +func Init(ctx context.Context, homePath string, cfg *ini.File) error { datasourcePath := makeAbsolute(cfg.Section("paths").Key("datasources").String(), homePath) - if err := datasources.Provision(datasourcePath); err != nil { + if err := datasource.Provision(datasourcePath); err != nil { return err } dashboardPath := makeAbsolute(cfg.Section("paths").Key("dashboards").String(), homePath) - _, err := dashboard.Provision(backgroundContext, dashboardPath) + _, err := dashboard.Provision(ctx, dashboardPath) if err != nil { return err } @@ -35,10 +24,6 @@ func Init(backgroundContext context.Context, homePath string, cfg *ini.File) err return nil } -func (p *Provisioner) Listen() error { - return nil -} - func makeAbsolute(path string, root string) string { if filepath.IsAbs(path) { return path From 7f3a7ea1281bde95ed7f8d7cc38ac512b680b40d Mon Sep 17 00:00:00 2001 From: bergquist Date: Tue, 28 Nov 2017 14:20:56 +0100 Subject: [PATCH 03/18] dashboards as cfg: more tests --- .../dashboard/file_reader_test.go | 76 +++++++- .../one-dashboard/dashboard1.json | 173 ++++++++++++++++++ 2 files changed, 240 insertions(+), 9 deletions(-) create mode 100644 pkg/services/provisioning/dashboard/test-dashboards/one-dashboard/dashboard1.json diff --git a/pkg/services/provisioning/dashboard/file_reader_test.go b/pkg/services/provisioning/dashboard/file_reader_test.go index 095d0feeb3f..e335ee08aa2 100644 --- a/pkg/services/provisioning/dashboard/file_reader_test.go +++ b/pkg/services/provisioning/dashboard/file_reader_test.go @@ -4,7 +4,9 @@ import ( "github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/services/alerting" + "os" "testing" + "time" "github.com/grafana/grafana/pkg/log" . "github.com/smartystreets/goconvey/convey" @@ -13,11 +15,15 @@ import ( var ( defaultDashboards string = "./test-dashboards/folder-one" brokenDashboards string = "./test-dashboards/broken-dashboards" + oneDashboard string = "./test-dashboards/one-dashboard" + + fakeRepo *fakeDashboardRepo ) func TestDashboardFileReader(t *testing.T) { Convey("Reading dashboards from disk", t, func() { bus.ClearBusHandlers() + fakeRepo = &fakeDashboardRepo{} bus.AddHandler("test", mockGetDashboardQuery) bus.AddHandler("test", mockValidateDashboardAlertsCommand) @@ -25,21 +31,60 @@ func TestDashboardFileReader(t *testing.T) { bus.AddHandler("test", mockUpdateDashboardAlertsCommand) logger := log.New("test.logger") + cfg := &DashboardsAsConfig{ + Name: "Default", + Type: "file", + OrgId: 1, + Folder: "", + Options: map[string]interface{}{}, + } + Convey("Can read default dashboard", func() { - cfg := &DashboardsAsConfig{ - Name: "Default", - Type: "file", - OrgId: 1, - Folder: "", - Options: map[string]interface{}{ - "folder": defaultDashboards, - }, - } + cfg.Options["folder"] = defaultDashboards + reader, err := NewDashboardFilereader(cfg, logger) So(err, ShouldBeNil) err = reader.walkFolder() So(err, ShouldBeNil) + + So(len(fakeRepo.inserted), ShouldEqual, 2) + }) + + Convey("Should not update dashboards when db is newer", func() { + cfg.Options["folder"] = oneDashboard + + fakeRepo.getDashboard = append(fakeRepo.getDashboard, &models.Dashboard{ + Updated: time.Now().Add(time.Hour), + Slug: "grafana", + }) + + reader, err := NewDashboardFilereader(cfg, logger) + So(err, ShouldBeNil) + + err = reader.walkFolder() + So(err, ShouldBeNil) + + So(len(fakeRepo.inserted), ShouldEqual, 0) + }) + + Convey("Can read default dashboard and replace old version in database", func() { + cfg.Options["folder"] = oneDashboard + + stat, _ := os.Stat(oneDashboard + "/dashboard1.json") + + fakeRepo.getDashboard = append(fakeRepo.getDashboard, &models.Dashboard{ + Updated: stat.ModTime().AddDate(0, 0, -1), + Slug: "grafana", + }) + + reader, err := NewDashboardFilereader(cfg, logger) + So(err, ShouldBeNil) + + err = reader.walkFolder() + So(err, ShouldBeNil) + + So(len(fakeRepo.inserted), ShouldEqual, 1) }) Convey("Invalid configuration should return error", func() { @@ -71,7 +116,19 @@ func TestDashboardFileReader(t *testing.T) { }) } +type fakeDashboardRepo struct { + inserted []*models.SaveDashboardCommand + getDashboard []*models.Dashboard +} + func mockGetDashboardQuery(cmd *models.GetDashboardQuery) error { + for _, d := range fakeRepo.getDashboard { + if d.Slug == cmd.Slug { + cmd.Result = d + return nil + } + } + return models.ErrDashboardNotFound } @@ -80,6 +137,7 @@ func mockValidateDashboardAlertsCommand(cmd *alerting.ValidateDashboardAlertsCom } func mockSaveDashboardCommand(cmd *models.SaveDashboardCommand) error { + fakeRepo.inserted = append(fakeRepo.inserted, cmd) return nil } diff --git a/pkg/services/provisioning/dashboard/test-dashboards/one-dashboard/dashboard1.json b/pkg/services/provisioning/dashboard/test-dashboards/one-dashboard/dashboard1.json new file mode 100644 index 00000000000..5b6765a4ed6 --- /dev/null +++ b/pkg/services/provisioning/dashboard/test-dashboards/one-dashboard/dashboard1.json @@ -0,0 +1,173 @@ +{ + "title": "Grafana", + "tags": [], + "style": "dark", + "timezone": "browser", + "editable": true, + "rows": [ + { + "title": "New row", + "height": "150px", + "collapse": false, + "editable": true, + "panels": [ + { + "id": 1, + "span": 12, + "editable": true, + "type": "text", + "mode": "html", + "content": "
\n \n
", + "style": {}, + "title": "Welcome to" + } + ] + }, + { + "title": "Welcome to Grafana", + "height": "210px", + "collapse": false, + "editable": true, + "panels": [ + { + "id": 2, + "span": 6, + "type": "text", + "mode": "html", + "content": "
\n\n
\n
\n \n
\n
\n \n
\n
", + "style": {}, + "title": "Documentation Links" + }, + { + "id": 3, + "span": 6, + "type": "text", + "mode": "html", + "content": "
\n\n
\n
\n
    \n
  • Ctrl+S saves the current dashboard
    • \n
  • Ctrl+F Opens the dashboard finder
    • \n
  • Ctrl+H Hide/show row controls
    • \n
  • Click and drag graph title to move panel
    • \n
  • Hit Escape to exit graph when in fullscreen or edit mode
    • \n
  • Click the colored icon in the legend to change series color
    • \n
  • Ctrl or Shift + Click legend name to hide other series
    • \n
\n
\n
\n", + "style": {}, + "title": "Tips & Shortcuts" + } + ] + }, + { + "title": "test", + "height": "250px", + "editable": true, + "collapse": false, + "panels": [ + { + "id": 4, + "span": 12, + "type": "graph", + "x-axis": true, + "y-axis": true, + "scale": 1, + "y_formats": [ + "short", + "short" + ], + "grid": { + "max": null, + "min": null, + "leftMax": null, + "rightMax": null, + "leftMin": null, + "rightMin": null, + "threshold1": null, + "threshold2": null, + "threshold1Color": "rgba(216, 200, 27, 0.27)", + "threshold2Color": "rgba(234, 112, 112, 0.22)" + }, + "resolution": 100, + "lines": true, + "fill": 1, + "linewidth": 2, + "dashes": false, + "dashLength": 10, + "spaceLength": 10, + "points": false, + "pointradius": 5, + "bars": false, + "stack": true, + "spyable": true, + "options": false, + "legend": { + "show": true, + "values": false, + "min": false, + "max": false, + "current": false, + "total": false, + "avg": false + }, + "interactive": true, + "legend_counts": true, + "timezone": "browser", + "percentage": false, + "nullPointMode": "connected", + "steppedLine": false, + "tooltip": { + "value_type": "cumulative", + "query_as_alias": true + }, + "targets": [ + { + "target": "randomWalk('random walk')", + "function": "mean", + "column": "value" + } + ], + "aliasColors": {}, + "aliasYAxis": {}, + "title": "First Graph (click title to edit)", + "datasource": "graphite", + "renderer": "flot", + "annotate": { + "enable": false + } + } + ] + } + ], + "nav": [ + { + "type": "timepicker", + "collapse": false, + "enable": true, + "status": "Stable", + "time_options": [ + "5m", + "15m", + "1h", + "6h", + "12h", + "24h", + "2d", + "7d", + "30d" + ], + "refresh_intervals": [ + "5s", + "10s", + "30s", + "1m", + "5m", + "15m", + "30m", + "1h", + "2h", + "1d" + ], + "now": true + } + ], + "time": { + "from": "now-6h", + "to": "now" + }, + "templating": { + "list": [] + }, + "version": 5 + } + \ No newline at end of file From 93e1d8a19c8c5573a89cee17b3ef5f743ebc02dd Mon Sep 17 00:00:00 2001 From: bergquist Date: Tue, 28 Nov 2017 16:57:14 +0100 Subject: [PATCH 04/18] dashboards as cfg: make dashboard none editable by default --- .../provisioning/dashboard/dashboard_test.go | 2 + .../provisioning/dashboard/file_reader.go | 47 +++------------ .../dashboards-from-disk/dev-dashboards.yaml | 1 + pkg/services/provisioning/dashboard/types.go | 59 +++++++++++++++---- 4 files changed, 59 insertions(+), 50 deletions(-) diff --git a/pkg/services/provisioning/dashboard/dashboard_test.go b/pkg/services/provisioning/dashboard/dashboard_test.go index 6b1bf3fc6d3..450d0e62ff5 100644 --- a/pkg/services/provisioning/dashboard/dashboard_test.go +++ b/pkg/services/provisioning/dashboard/dashboard_test.go @@ -29,6 +29,7 @@ func TestDashboardsAsConfig(t *testing.T) { So(ds.Type, ShouldEqual, "file") So(ds.OrgId, ShouldEqual, 2) So(ds.Folder, ShouldEqual, "developers") + So(ds.Editable, ShouldBeTrue) So(len(ds.Options), ShouldEqual, 1) So(ds.Options["folder"], ShouldEqual, "/var/lib/grafana/dashboards") @@ -39,6 +40,7 @@ func TestDashboardsAsConfig(t *testing.T) { So(ds2.Type, ShouldEqual, "file") So(ds2.OrgId, ShouldEqual, 1) So(ds2.Folder, ShouldEqual, "") + So(ds2.Editable, ShouldBeFalse) So(len(ds2.Options), ShouldEqual, 1) So(ds2.Options["folder"], ShouldEqual, "/var/lib/grafana/dashboards") diff --git a/pkg/services/provisioning/dashboard/file_reader.go b/pkg/services/provisioning/dashboard/file_reader.go index b3fa3e5cfd8..d27575523ee 100644 --- a/pkg/services/provisioning/dashboard/file_reader.go +++ b/pkg/services/provisioning/dashboard/file_reader.go @@ -7,7 +7,6 @@ import ( "os" "path/filepath" "strings" - "sync" "time" "github.com/grafana/grafana/pkg/bus" @@ -24,31 +23,6 @@ type fileReader struct { dashboardCache *dashboardCache } -type dashboardCache struct { - mutex *sync.Mutex - dashboards map[string]*DashboardJson -} - -func newDashboardCache() *dashboardCache { - return &dashboardCache{ - dashboards: map[string]*DashboardJson{}, - mutex: &sync.Mutex{}, - } -} - -func (dc *dashboardCache) addCache(json *DashboardJson) { - dc.mutex.Lock() - defer dc.mutex.Unlock() - dc.dashboards[json.Path] = json -} - -func (dc *dashboardCache) getCache(path string) (*DashboardJson, bool) { - dc.mutex.Lock() - defer dc.mutex.Unlock() - v, exist := dc.dashboards[path] - return v, exist -} - func NewDashboardFilereader(cfg *DashboardsAsConfig, log log.Logger) (*fileReader, error) { path, ok := cfg.Options["folder"].(string) if !ok { @@ -152,20 +126,17 @@ func (fr *fileReader) readDashboardFromFile(path string) (*DashboardJson, error) return nil, err } - stat, _ := os.Stat(path) - dash := &DashboardJson{} - dash.Dashboard = models.NewDashboardFromJson(data) - dash.TitleLower = strings.ToLower(dash.Dashboard.Title) - dash.Path = path - dash.ModTime = stat.ModTime() - dash.OrgId = fr.Cfg.OrgId - dash.Folder = fr.Cfg.Folder - - if dash.Dashboard.Title == "" { - return nil, models.ErrDashboardTitleEmpty + stat, err := os.Stat(path) + if err != nil { + return nil, err } - fr.dashboardCache.addCache(dash) + dash, err := createDashboardJson(data, stat.ModTime(), fr.Cfg) + if err != nil { + return nil, err + } + + fr.dashboardCache.addCache(path, dash) return dash, nil } diff --git a/pkg/services/provisioning/dashboard/test-configs/dashboards-from-disk/dev-dashboards.yaml b/pkg/services/provisioning/dashboard/test-configs/dashboards-from-disk/dev-dashboards.yaml index 67cb383e813..a7c4a812092 100644 --- a/pkg/services/provisioning/dashboard/test-configs/dashboards-from-disk/dev-dashboards.yaml +++ b/pkg/services/provisioning/dashboard/test-configs/dashboards-from-disk/dev-dashboards.yaml @@ -1,6 +1,7 @@ - name: 'general dashboards' org_id: 2 folder: 'developers' + editable: true type: file options: folder: /var/lib/grafana/dashboards diff --git a/pkg/services/provisioning/dashboard/types.go b/pkg/services/provisioning/dashboard/types.go index cef6b217fee..24e31ac9f0a 100644 --- a/pkg/services/provisioning/dashboard/types.go +++ b/pkg/services/provisioning/dashboard/types.go @@ -1,6 +1,8 @@ package dashboard import ( + "github.com/grafana/grafana/pkg/components/simplejson" + "strings" "sync" "time" @@ -8,27 +10,60 @@ import ( ) type DashboardsAsConfig struct { - Name string `json:"name" yaml:"name"` - Type string `json:"type" yaml:"type"` - OrgId int64 `json:"org_id" yaml:"org_id"` - Folder string `json:"folder" yaml:"folder"` - Options map[string]interface{} `json:"options" yaml:"options"` + Name string `json:"name" yaml:"name"` + Type string `json:"type" yaml:"type"` + OrgId int64 `json:"org_id" yaml:"org_id"` + Folder string `json:"folder" yaml:"folder"` + Editable bool `json:"editable" yaml:"editable"` + Options map[string]interface{} `json:"options" yaml:"options"` } type DashboardJson struct { TitleLower string - Path string OrgId int64 Folder string ModTime time.Time Dashboard *models.Dashboard } -type DashboardIndex struct { - mutex *sync.Mutex - - PathToDashboard map[string]*DashboardJson +type dashboardCache struct { + mutex *sync.Mutex + dashboards map[string]*DashboardJson } -type InsertDashboard func(cmd *models.Dashboard) error -type UpdateDashboard func(cmd *models.SaveDashboardCommand) error +func newDashboardCache() *dashboardCache { + return &dashboardCache{ + dashboards: map[string]*DashboardJson{}, + mutex: &sync.Mutex{}, + } +} + +func (dc *dashboardCache) addCache(key string, json *DashboardJson) { + dc.mutex.Lock() + defer dc.mutex.Unlock() + dc.dashboards[key] = json +} + +func (dc *dashboardCache) getCache(key string) (*DashboardJson, bool) { + dc.mutex.Lock() + defer dc.mutex.Unlock() + v, exist := dc.dashboards[key] + return v, exist +} + +func createDashboardJson(data *simplejson.Json, lastModified time.Time, cfg *DashboardsAsConfig) (*DashboardJson, error) { + + dash := &DashboardJson{} + dash.Dashboard = models.NewDashboardFromJson(data) + dash.TitleLower = strings.ToLower(dash.Dashboard.Title) + dash.ModTime = lastModified + dash.OrgId = cfg.OrgId + dash.Folder = cfg.Folder + dash.Dashboard.Data.Set("editable", cfg.Editable) + + if dash.Dashboard.Title == "" { + return nil, models.ErrDashboardTitleEmpty + } + + return dash, nil +} From 09cb0f378b92c04ad9011738cfa8243f697b4ac5 Mon Sep 17 00:00:00 2001 From: bergquist Date: Thu, 30 Nov 2017 17:17:49 +0100 Subject: [PATCH 05/18] dashboards as cfg: minor tweaks --- .../provisioning/dashboard/dashboard.go | 5 +- .../provisioning/dashboard/file_reader.go | 23 ++- .../broken-dashboards/invalid.json | 170 +----------------- 3 files changed, 15 insertions(+), 183 deletions(-) diff --git a/pkg/services/provisioning/dashboard/dashboard.go b/pkg/services/provisioning/dashboard/dashboard.go index c67c645f242..820eaf3c0f5 100644 --- a/pkg/services/provisioning/dashboard/dashboard.go +++ b/pkg/services/provisioning/dashboard/dashboard.go @@ -20,10 +20,11 @@ func Provision(ctx context.Context, configDirectory string) (*DashboardProvision ctx: ctx, } - return d, d.Init(ctx) + err := d.Provision(ctx) + return d, err } -func (provider *DashboardProvisioner) Init(ctx context.Context) error { +func (provider *DashboardProvisioner) Provision(ctx context.Context) error { cfgs, err := provider.cfgReader.readConfig() if err != nil { return err diff --git a/pkg/services/provisioning/dashboard/file_reader.go b/pkg/services/provisioning/dashboard/file_reader.go index d27575523ee..d417a73f0da 100644 --- a/pkg/services/provisioning/dashboard/file_reader.go +++ b/pkg/services/provisioning/dashboard/file_reader.go @@ -42,7 +42,7 @@ func NewDashboardFilereader(cfg *DashboardsAsConfig, log log.Logger) (*fileReade } func (fr *fileReader) ReadAndListen(ctx context.Context) error { - ticker := time.NewTicker(time.Second * 10) + ticker := time.NewTicker(time.Second * 5) if err := fr.walkFolder(); err != nil { fr.log.Error("failed to search for dashboards", "error", err) @@ -105,11 +105,10 @@ func (fr *fileReader) walkFolder() error { } if cmd.Result.Updated.Unix() >= f.ModTime().Unix() { - fr.log.Debug("already using latest version", "dashboard", dash.Dashboard.Slug) return nil } - fr.log.Debug("no dashboard in cache. Loading dashboard from disk into database.", "file", path) + fr.log.Debug("no dashboard in cache. loading dashboard from disk into database.", "file", path) return fr.saveDashboard(dash) }) } @@ -141,16 +140,16 @@ func (fr *fileReader) readDashboardFromFile(path string) (*DashboardJson, error) return dash, nil } -func (fr *fileReader) saveDashboard(dashboardJson *DashboardJson) error { - dash := dashboardJson.Dashboard +func (fr *fileReader) saveDashboard(json *DashboardJson) error { + dashboard := json.Dashboard - if dash.Title == "" { + if dashboard.Title == "" { return models.ErrDashboardTitleEmpty } validateAlertsCmd := alerting.ValidateDashboardAlertsCommand{ - OrgId: dashboardJson.OrgId, - Dashboard: dash, + OrgId: json.OrgId, + Dashboard: dashboard, } if err := bus.Dispatch(&validateAlertsCmd); err != nil { @@ -158,11 +157,11 @@ func (fr *fileReader) saveDashboard(dashboardJson *DashboardJson) error { } cmd := models.SaveDashboardCommand{ - Dashboard: dash.Data, + Dashboard: dashboard.Data, Message: "Dashboard created from file.", - OrgId: dashboardJson.OrgId, + OrgId: json.OrgId, Overwrite: true, - UpdatedAt: dashboardJson.ModTime, + UpdatedAt: json.ModTime, } err := bus.Dispatch(&cmd) @@ -171,7 +170,7 @@ func (fr *fileReader) saveDashboard(dashboardJson *DashboardJson) error { } alertCmd := alerting.UpdateDashboardAlertsCommand{ - OrgId: dashboardJson.OrgId, + OrgId: json.OrgId, Dashboard: cmd.Result, } diff --git a/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/invalid.json b/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/invalid.json index 1aa388a6e78..0c5e34c2da7 100644 --- a/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/invalid.json +++ b/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/invalid.json @@ -1,174 +1,6 @@ [] { "title": "Grafana", - "tags": [], - "style": "dark", - "timezone": "browser", - "editable": true, - "rows": [ - { - "title": "New row", - "height": "150px", - "collapse": false, - "editable": true, - "panels": [ - { - "id": 1, - "span": 12, - "editable": true, - "type": "text", - "mode": "html", - "content": "
\n \n
", - "style": {}, - "title": "Welcome to" - } - ] - }, - { - "title": "Welcome to Grafana", - "height": "210px", - "collapse": false, - "editable": true, - "panels": [ - { - "id": 2, - "span": 6, - "type": "text", - "mode": "html", - "content": "
\n\n
\n
\n \n
\n
\n \n
\n
", - "style": {}, - "title": "Documentation Links" - }, - { - "id": 3, - "span": 6, - "type": "text", - "mode": "html", - "content": "
\n\n
\n
\n
    \n
  • Ctrl+S saves the current dashboard
    • \n
  • Ctrl+F Opens the dashboard finder
    • \n
  • Ctrl+H Hide/show row controls
    • \n
  • Click and drag graph title to move panel
    • \n
  • Hit Escape to exit graph when in fullscreen or edit mode
    • \n
  • Click the colored icon in the legend to change series color
    • \n
  • Ctrl or Shift + Click legend name to hide other series
    • \n
\n
\n
\n", - "style": {}, - "title": "Tips & Shortcuts" - } - ] - }, - { - "title": "test", - "height": "250px", - "editable": true, - "collapse": false, - "panels": [ - { - "id": 4, - "span": 12, - "type": "graph", - "x-axis": true, - "y-axis": true, - "scale": 1, - "y_formats": [ - "short", - "short" - ], - "grid": { - "max": null, - "min": null, - "leftMax": null, - "rightMax": null, - "leftMin": null, - "rightMin": null, - "threshold1": null, - "threshold2": null, - "threshold1Color": "rgba(216, 200, 27, 0.27)", - "threshold2Color": "rgba(234, 112, 112, 0.22)" - }, - "resolution": 100, - "lines": true, - "fill": 1, - "linewidth": 2, - "dashes": false, - "dashLength": 10, - "spaceLength": 10, - "points": false, - "pointradius": 5, - "bars": false, - "stack": true, - "spyable": true, - "options": false, - "legend": { - "show": true, - "values": false, - "min": false, - "max": false, - "current": false, - "total": false, - "avg": false - }, - "interactive": true, - "legend_counts": true, - "timezone": "browser", - "percentage": false, - "nullPointMode": "connected", - "steppedLine": false, - "tooltip": { - "value_type": "cumulative", - "query_as_alias": true - }, - "targets": [ - { - "target": "randomWalk('random walk')", - "function": "mean", - "column": "value" - } - ], - "aliasColors": {}, - "aliasYAxis": {}, - "title": "First Graph (click title to edit)", - "datasource": "graphite", - "renderer": "flot", - "annotate": { - "enable": false - } - } - ] - } - ], - "nav": [ - { - "type": "timepicker", - "collapse": false, - "enable": true, - "status": "Stable", - "time_options": [ - "5m", - "15m", - "1h", - "6h", - "12h", - "24h", - "2d", - "7d", - "30d" - ], - "refresh_intervals": [ - "5s", - "10s", - "30s", - "1m", - "5m", - "15m", - "30m", - "1h", - "2h", - "1d" - ], - "now": true - } - ], - "time": { - "from": "now-6h", - "to": "now" - }, - "templating": { - "list": [] - }, - "version": 5 + } \ No newline at end of file From 74e12c260f70f2a3843a4a3bef62b8736f354233 Mon Sep 17 00:00:00 2001 From: bergquist Date: Thu, 30 Nov 2017 17:35:58 +0100 Subject: [PATCH 06/18] dashboards as cfg: move dashboard saving into its own service --- pkg/services/dashboards/dashboards.go | 67 +++++++++++++++++++ .../provisioning/dashboard/file_reader.go | 49 ++------------ pkg/services/provisioning/dashboard/types.go | 21 ++---- 3 files changed, 78 insertions(+), 59 deletions(-) create mode 100644 pkg/services/dashboards/dashboards.go diff --git a/pkg/services/dashboards/dashboards.go b/pkg/services/dashboards/dashboards.go new file mode 100644 index 00000000000..a5d3c3a4766 --- /dev/null +++ b/pkg/services/dashboards/dashboards.go @@ -0,0 +1,67 @@ +package dashboards + +import ( + "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/models" + "github.com/grafana/grafana/pkg/services/alerting" + "time" +) + +type Repository interface { + SaveDashboard(*SaveDashboardItem) error +} + +type SaveDashboardItem struct { + TitleLower string + OrgId int64 + Folder string + ModTime time.Time + UserId int64 + Message string + Overwrite bool + Dashboard *models.Dashboard +} + +func SaveDashboard(json *SaveDashboardItem) error { + dashboard := json.Dashboard + + if dashboard.Title == "" { + return models.ErrDashboardTitleEmpty + } + + validateAlertsCmd := alerting.ValidateDashboardAlertsCommand{ + OrgId: json.OrgId, + Dashboard: dashboard, + } + + if err := bus.Dispatch(&validateAlertsCmd); err != nil { + return models.ErrDashboardContainsInvalidAlertData + } + + cmd := models.SaveDashboardCommand{ + Dashboard: dashboard.Data, + Message: json.Message, + OrgId: json.OrgId, + Overwrite: json.Overwrite, + } + + if !json.ModTime.IsZero() { + cmd.UpdatedAt = json.ModTime + } + + err := bus.Dispatch(&cmd) + if err != nil { + return err + } + + alertCmd := alerting.UpdateDashboardAlertsCommand{ + OrgId: json.OrgId, + Dashboard: cmd.Result, + } + + if err := bus.Dispatch(&alertCmd); err != nil { + return err + } + + return nil +} diff --git a/pkg/services/provisioning/dashboard/file_reader.go b/pkg/services/provisioning/dashboard/file_reader.go index d417a73f0da..08dbca81373 100644 --- a/pkg/services/provisioning/dashboard/file_reader.go +++ b/pkg/services/provisioning/dashboard/file_reader.go @@ -3,7 +3,7 @@ package dashboard import ( "context" "fmt" - "github.com/grafana/grafana/pkg/services/alerting" + "github.com/grafana/grafana/pkg/services/dashboards" "os" "path/filepath" "strings" @@ -96,7 +96,7 @@ func (fr *fileReader) walkFolder() error { if err == models.ErrDashboardNotFound { fr.log.Debug("saving new dashboard", "file", path) - return fr.saveDashboard(dash) + return dashboards.SaveDashboard(dash) } if err != nil { @@ -109,11 +109,11 @@ func (fr *fileReader) walkFolder() error { } fr.log.Debug("no dashboard in cache. loading dashboard from disk into database.", "file", path) - return fr.saveDashboard(dash) + return dashboards.SaveDashboard(dash) }) } -func (fr *fileReader) readDashboardFromFile(path string) (*DashboardJson, error) { +func (fr *fileReader) readDashboardFromFile(path string) (*dashboards.SaveDashboardItem, error) { reader, err := os.Open(path) if err != nil { return nil, err @@ -139,44 +139,3 @@ func (fr *fileReader) readDashboardFromFile(path string) (*DashboardJson, error) return dash, nil } - -func (fr *fileReader) saveDashboard(json *DashboardJson) error { - dashboard := json.Dashboard - - if dashboard.Title == "" { - return models.ErrDashboardTitleEmpty - } - - validateAlertsCmd := alerting.ValidateDashboardAlertsCommand{ - OrgId: json.OrgId, - Dashboard: dashboard, - } - - if err := bus.Dispatch(&validateAlertsCmd); err != nil { - return models.ErrDashboardContainsInvalidAlertData - } - - cmd := models.SaveDashboardCommand{ - Dashboard: dashboard.Data, - Message: "Dashboard created from file.", - OrgId: json.OrgId, - Overwrite: true, - UpdatedAt: json.ModTime, - } - - err := bus.Dispatch(&cmd) - if err != nil { - return err - } - - alertCmd := alerting.UpdateDashboardAlertsCommand{ - OrgId: json.OrgId, - Dashboard: cmd.Result, - } - - if err := bus.Dispatch(&alertCmd); err != nil { - return err - } - - return nil -} diff --git a/pkg/services/provisioning/dashboard/types.go b/pkg/services/provisioning/dashboard/types.go index 24e31ac9f0a..9480092f262 100644 --- a/pkg/services/provisioning/dashboard/types.go +++ b/pkg/services/provisioning/dashboard/types.go @@ -2,6 +2,7 @@ package dashboard import ( "github.com/grafana/grafana/pkg/components/simplejson" + "github.com/grafana/grafana/pkg/services/dashboards" "strings" "sync" "time" @@ -18,42 +19,34 @@ type DashboardsAsConfig struct { Options map[string]interface{} `json:"options" yaml:"options"` } -type DashboardJson struct { - TitleLower string - OrgId int64 - Folder string - ModTime time.Time - Dashboard *models.Dashboard -} - type dashboardCache struct { mutex *sync.Mutex - dashboards map[string]*DashboardJson + dashboards map[string]*dashboards.SaveDashboardItem } func newDashboardCache() *dashboardCache { return &dashboardCache{ - dashboards: map[string]*DashboardJson{}, + dashboards: map[string]*dashboards.SaveDashboardItem{}, mutex: &sync.Mutex{}, } } -func (dc *dashboardCache) addCache(key string, json *DashboardJson) { +func (dc *dashboardCache) addCache(key string, json *dashboards.SaveDashboardItem) { dc.mutex.Lock() defer dc.mutex.Unlock() dc.dashboards[key] = json } -func (dc *dashboardCache) getCache(key string) (*DashboardJson, bool) { +func (dc *dashboardCache) getCache(key string) (*dashboards.SaveDashboardItem, bool) { dc.mutex.Lock() defer dc.mutex.Unlock() v, exist := dc.dashboards[key] return v, exist } -func createDashboardJson(data *simplejson.Json, lastModified time.Time, cfg *DashboardsAsConfig) (*DashboardJson, error) { +func createDashboardJson(data *simplejson.Json, lastModified time.Time, cfg *DashboardsAsConfig) (*dashboards.SaveDashboardItem, error) { - dash := &DashboardJson{} + dash := &dashboards.SaveDashboardItem{} dash.Dashboard = models.NewDashboardFromJson(data) dash.TitleLower = strings.ToLower(dash.Dashboard.Title) dash.ModTime = lastModified From 9cebb23e01687fe3eaf42c467c37bd24f33646dd Mon Sep 17 00:00:00 2001 From: bergquist Date: Thu, 30 Nov 2017 17:43:28 +0100 Subject: [PATCH 07/18] dashboards as cfg: revert minor changes --- pkg/api/dashboard.go | 7 +++++++ .../{dashboard => dashboards}/config_reader.go | 2 +- .../provisioning/{dashboard => dashboards}/dashboard.go | 2 +- .../{dashboard => dashboards}/dashboard_test.go | 2 +- .../provisioning/{dashboard => dashboards}/file_reader.go | 2 +- .../{dashboard => dashboards}/file_reader_test.go | 2 +- .../test-configs/dashboards-from-disk/dev-dashboards.yaml | 0 .../test-dashboards/broken-dashboards/empty-json.json | 0 .../test-dashboards/broken-dashboards/invalid.json | 0 .../test-dashboards/folder-one/dashboard1.json | 0 .../test-dashboards/folder-one/dashboard2.json | 0 .../test-dashboards/one-dashboard/dashboard1.json | 0 .../provisioning/{dashboard => dashboards}/types.go | 2 +- .../{datasource => datasources}/datasources.go | 2 +- .../{datasource => datasources}/datasources_test.go | 2 +- .../test-configs/all-properties/all-properties.yaml | 0 .../test-configs/all-properties/not.yaml.txt | 0 .../test-configs/all-properties/second.yaml | 0 .../test-configs/broken-yaml/broken.yaml | 0 .../test-configs/double-default/default-1.yaml | 0 .../test-configs/double-default/default-2.yaml | 0 .../insert-two-delete-two/one-datasources.yaml | 0 .../insert-two-delete-two/two-datasources.yml | 0 .../test-configs/two-datasources/two-datasources.yaml | 0 .../test-configs/zero-datasources/placeholder-for-git | 0 .../provisioning/{datasource => datasources}/types.go | 2 +- pkg/services/provisioning/provisioning.go | 8 ++++---- 27 files changed, 20 insertions(+), 13 deletions(-) rename pkg/services/provisioning/{dashboard => dashboards}/config_reader.go (97%) rename pkg/services/provisioning/{dashboard => dashboards}/dashboard.go (98%) rename pkg/services/provisioning/{dashboard => dashboards}/dashboard_test.go (98%) rename pkg/services/provisioning/{dashboard => dashboards}/file_reader.go (99%) rename pkg/services/provisioning/{dashboard => dashboards}/file_reader_test.go (99%) rename pkg/services/provisioning/{dashboard => dashboards}/test-configs/dashboards-from-disk/dev-dashboards.yaml (100%) rename pkg/services/provisioning/{dashboard => dashboards}/test-dashboards/broken-dashboards/empty-json.json (100%) rename pkg/services/provisioning/{dashboard => dashboards}/test-dashboards/broken-dashboards/invalid.json (100%) rename pkg/services/provisioning/{dashboard => dashboards}/test-dashboards/folder-one/dashboard1.json (100%) rename pkg/services/provisioning/{dashboard => dashboards}/test-dashboards/folder-one/dashboard2.json (100%) rename pkg/services/provisioning/{dashboard => dashboards}/test-dashboards/one-dashboard/dashboard1.json (100%) rename pkg/services/provisioning/{dashboard => dashboards}/types.go (98%) rename pkg/services/provisioning/{datasource => datasources}/datasources.go (99%) rename pkg/services/provisioning/{datasource => datasources}/datasources_test.go (99%) rename pkg/services/provisioning/{datasource => datasources}/test-configs/all-properties/all-properties.yaml (100%) rename pkg/services/provisioning/{datasource => datasources}/test-configs/all-properties/not.yaml.txt (100%) rename pkg/services/provisioning/{datasource => datasources}/test-configs/all-properties/second.yaml (100%) rename pkg/services/provisioning/{datasource => datasources}/test-configs/broken-yaml/broken.yaml (100%) rename pkg/services/provisioning/{datasource => datasources}/test-configs/double-default/default-1.yaml (100%) rename pkg/services/provisioning/{datasource => datasources}/test-configs/double-default/default-2.yaml (100%) rename pkg/services/provisioning/{datasource => datasources}/test-configs/insert-two-delete-two/one-datasources.yaml (100%) rename pkg/services/provisioning/{datasource => datasources}/test-configs/insert-two-delete-two/two-datasources.yml (100%) rename pkg/services/provisioning/{datasource => datasources}/test-configs/two-datasources/two-datasources.yaml (100%) rename pkg/services/provisioning/{datasource => datasources}/test-configs/zero-datasources/placeholder-for-git (100%) rename pkg/services/provisioning/{datasource => datasources}/types.go (99%) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index df0cbbd745c..900524a8823 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -3,6 +3,7 @@ package api import ( "encoding/json" "fmt" + //"github.com/grafana/grafana/pkg/services/dashboards" "os" "path" "strings" @@ -124,6 +125,12 @@ func PostDashboard(c *middleware.Context, cmd m.SaveDashboardCommand) Response { dash := cmd.GetDashboardModel() + // dashItem := &dashboards.SaveDashboardItem{ + // Dashboard: dash, + // Message: cmd.Message, + // } + // err := dashboards.SaveDashboard(dashItem) + // Check if Title is empty if dash.Title == "" { return ApiError(400, m.ErrDashboardTitleEmpty.Error(), nil) diff --git a/pkg/services/provisioning/dashboard/config_reader.go b/pkg/services/provisioning/dashboards/config_reader.go similarity index 97% rename from pkg/services/provisioning/dashboard/config_reader.go rename to pkg/services/provisioning/dashboards/config_reader.go index d7ee92a592c..a602ca71df3 100644 --- a/pkg/services/provisioning/dashboard/config_reader.go +++ b/pkg/services/provisioning/dashboards/config_reader.go @@ -1,4 +1,4 @@ -package dashboard +package dashboards import ( "io/ioutil" diff --git a/pkg/services/provisioning/dashboard/dashboard.go b/pkg/services/provisioning/dashboards/dashboard.go similarity index 98% rename from pkg/services/provisioning/dashboard/dashboard.go rename to pkg/services/provisioning/dashboards/dashboard.go index 820eaf3c0f5..e2c802a0024 100644 --- a/pkg/services/provisioning/dashboard/dashboard.go +++ b/pkg/services/provisioning/dashboards/dashboard.go @@ -1,4 +1,4 @@ -package dashboard +package dashboards import ( "context" diff --git a/pkg/services/provisioning/dashboard/dashboard_test.go b/pkg/services/provisioning/dashboards/dashboard_test.go similarity index 98% rename from pkg/services/provisioning/dashboard/dashboard_test.go rename to pkg/services/provisioning/dashboards/dashboard_test.go index 450d0e62ff5..e9ab352a122 100644 --- a/pkg/services/provisioning/dashboard/dashboard_test.go +++ b/pkg/services/provisioning/dashboards/dashboard_test.go @@ -1,4 +1,4 @@ -package dashboard +package dashboards import ( "testing" diff --git a/pkg/services/provisioning/dashboard/file_reader.go b/pkg/services/provisioning/dashboards/file_reader.go similarity index 99% rename from pkg/services/provisioning/dashboard/file_reader.go rename to pkg/services/provisioning/dashboards/file_reader.go index 08dbca81373..c15fd7cb521 100644 --- a/pkg/services/provisioning/dashboard/file_reader.go +++ b/pkg/services/provisioning/dashboards/file_reader.go @@ -1,4 +1,4 @@ -package dashboard +package dashboards import ( "context" diff --git a/pkg/services/provisioning/dashboard/file_reader_test.go b/pkg/services/provisioning/dashboards/file_reader_test.go similarity index 99% rename from pkg/services/provisioning/dashboard/file_reader_test.go rename to pkg/services/provisioning/dashboards/file_reader_test.go index e335ee08aa2..55c26e47dec 100644 --- a/pkg/services/provisioning/dashboard/file_reader_test.go +++ b/pkg/services/provisioning/dashboards/file_reader_test.go @@ -1,4 +1,4 @@ -package dashboard +package dashboards import ( "github.com/grafana/grafana/pkg/bus" diff --git a/pkg/services/provisioning/dashboard/test-configs/dashboards-from-disk/dev-dashboards.yaml b/pkg/services/provisioning/dashboards/test-configs/dashboards-from-disk/dev-dashboards.yaml similarity index 100% rename from pkg/services/provisioning/dashboard/test-configs/dashboards-from-disk/dev-dashboards.yaml rename to pkg/services/provisioning/dashboards/test-configs/dashboards-from-disk/dev-dashboards.yaml diff --git a/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/empty-json.json b/pkg/services/provisioning/dashboards/test-dashboards/broken-dashboards/empty-json.json similarity index 100% rename from pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/empty-json.json rename to pkg/services/provisioning/dashboards/test-dashboards/broken-dashboards/empty-json.json diff --git a/pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/invalid.json b/pkg/services/provisioning/dashboards/test-dashboards/broken-dashboards/invalid.json similarity index 100% rename from pkg/services/provisioning/dashboard/test-dashboards/broken-dashboards/invalid.json rename to pkg/services/provisioning/dashboards/test-dashboards/broken-dashboards/invalid.json diff --git a/pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard1.json b/pkg/services/provisioning/dashboards/test-dashboards/folder-one/dashboard1.json similarity index 100% rename from pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard1.json rename to pkg/services/provisioning/dashboards/test-dashboards/folder-one/dashboard1.json diff --git a/pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard2.json b/pkg/services/provisioning/dashboards/test-dashboards/folder-one/dashboard2.json similarity index 100% rename from pkg/services/provisioning/dashboard/test-dashboards/folder-one/dashboard2.json rename to pkg/services/provisioning/dashboards/test-dashboards/folder-one/dashboard2.json diff --git a/pkg/services/provisioning/dashboard/test-dashboards/one-dashboard/dashboard1.json b/pkg/services/provisioning/dashboards/test-dashboards/one-dashboard/dashboard1.json similarity index 100% rename from pkg/services/provisioning/dashboard/test-dashboards/one-dashboard/dashboard1.json rename to pkg/services/provisioning/dashboards/test-dashboards/one-dashboard/dashboard1.json diff --git a/pkg/services/provisioning/dashboard/types.go b/pkg/services/provisioning/dashboards/types.go similarity index 98% rename from pkg/services/provisioning/dashboard/types.go rename to pkg/services/provisioning/dashboards/types.go index 9480092f262..5b73b6d10e3 100644 --- a/pkg/services/provisioning/dashboard/types.go +++ b/pkg/services/provisioning/dashboards/types.go @@ -1,4 +1,4 @@ -package dashboard +package dashboards import ( "github.com/grafana/grafana/pkg/components/simplejson" diff --git a/pkg/services/provisioning/datasource/datasources.go b/pkg/services/provisioning/datasources/datasources.go similarity index 99% rename from pkg/services/provisioning/datasource/datasources.go rename to pkg/services/provisioning/datasources/datasources.go index be854bfe2bc..325dbbbd757 100644 --- a/pkg/services/provisioning/datasource/datasources.go +++ b/pkg/services/provisioning/datasources/datasources.go @@ -1,4 +1,4 @@ -package datasource +package datasources import ( "errors" diff --git a/pkg/services/provisioning/datasource/datasources_test.go b/pkg/services/provisioning/datasources/datasources_test.go similarity index 99% rename from pkg/services/provisioning/datasource/datasources_test.go rename to pkg/services/provisioning/datasources/datasources_test.go index d746e794d92..f3252c28d9d 100644 --- a/pkg/services/provisioning/datasource/datasources_test.go +++ b/pkg/services/provisioning/datasources/datasources_test.go @@ -1,4 +1,4 @@ -package datasource +package datasources import ( "testing" diff --git a/pkg/services/provisioning/datasource/test-configs/all-properties/all-properties.yaml b/pkg/services/provisioning/datasources/test-configs/all-properties/all-properties.yaml similarity index 100% rename from pkg/services/provisioning/datasource/test-configs/all-properties/all-properties.yaml rename to pkg/services/provisioning/datasources/test-configs/all-properties/all-properties.yaml diff --git a/pkg/services/provisioning/datasource/test-configs/all-properties/not.yaml.txt b/pkg/services/provisioning/datasources/test-configs/all-properties/not.yaml.txt similarity index 100% rename from pkg/services/provisioning/datasource/test-configs/all-properties/not.yaml.txt rename to pkg/services/provisioning/datasources/test-configs/all-properties/not.yaml.txt diff --git a/pkg/services/provisioning/datasource/test-configs/all-properties/second.yaml b/pkg/services/provisioning/datasources/test-configs/all-properties/second.yaml similarity index 100% rename from pkg/services/provisioning/datasource/test-configs/all-properties/second.yaml rename to pkg/services/provisioning/datasources/test-configs/all-properties/second.yaml diff --git a/pkg/services/provisioning/datasource/test-configs/broken-yaml/broken.yaml b/pkg/services/provisioning/datasources/test-configs/broken-yaml/broken.yaml similarity index 100% rename from pkg/services/provisioning/datasource/test-configs/broken-yaml/broken.yaml rename to pkg/services/provisioning/datasources/test-configs/broken-yaml/broken.yaml diff --git a/pkg/services/provisioning/datasource/test-configs/double-default/default-1.yaml b/pkg/services/provisioning/datasources/test-configs/double-default/default-1.yaml similarity index 100% rename from pkg/services/provisioning/datasource/test-configs/double-default/default-1.yaml rename to pkg/services/provisioning/datasources/test-configs/double-default/default-1.yaml diff --git a/pkg/services/provisioning/datasource/test-configs/double-default/default-2.yaml b/pkg/services/provisioning/datasources/test-configs/double-default/default-2.yaml similarity index 100% rename from pkg/services/provisioning/datasource/test-configs/double-default/default-2.yaml rename to pkg/services/provisioning/datasources/test-configs/double-default/default-2.yaml diff --git a/pkg/services/provisioning/datasource/test-configs/insert-two-delete-two/one-datasources.yaml b/pkg/services/provisioning/datasources/test-configs/insert-two-delete-two/one-datasources.yaml similarity index 100% rename from pkg/services/provisioning/datasource/test-configs/insert-two-delete-two/one-datasources.yaml rename to pkg/services/provisioning/datasources/test-configs/insert-two-delete-two/one-datasources.yaml diff --git a/pkg/services/provisioning/datasource/test-configs/insert-two-delete-two/two-datasources.yml b/pkg/services/provisioning/datasources/test-configs/insert-two-delete-two/two-datasources.yml similarity index 100% rename from pkg/services/provisioning/datasource/test-configs/insert-two-delete-two/two-datasources.yml rename to pkg/services/provisioning/datasources/test-configs/insert-two-delete-two/two-datasources.yml diff --git a/pkg/services/provisioning/datasource/test-configs/two-datasources/two-datasources.yaml b/pkg/services/provisioning/datasources/test-configs/two-datasources/two-datasources.yaml similarity index 100% rename from pkg/services/provisioning/datasource/test-configs/two-datasources/two-datasources.yaml rename to pkg/services/provisioning/datasources/test-configs/two-datasources/two-datasources.yaml diff --git a/pkg/services/provisioning/datasource/test-configs/zero-datasources/placeholder-for-git b/pkg/services/provisioning/datasources/test-configs/zero-datasources/placeholder-for-git similarity index 100% rename from pkg/services/provisioning/datasource/test-configs/zero-datasources/placeholder-for-git rename to pkg/services/provisioning/datasources/test-configs/zero-datasources/placeholder-for-git diff --git a/pkg/services/provisioning/datasource/types.go b/pkg/services/provisioning/datasources/types.go similarity index 99% rename from pkg/services/provisioning/datasource/types.go rename to pkg/services/provisioning/datasources/types.go index 6434074d5d4..ee2175d6a90 100644 --- a/pkg/services/provisioning/datasource/types.go +++ b/pkg/services/provisioning/datasources/types.go @@ -1,4 +1,4 @@ -package datasource +package datasources import "github.com/grafana/grafana/pkg/models" import "github.com/grafana/grafana/pkg/components/simplejson" diff --git a/pkg/services/provisioning/provisioning.go b/pkg/services/provisioning/provisioning.go index c72ba6dc4f5..aa3610b596f 100644 --- a/pkg/services/provisioning/provisioning.go +++ b/pkg/services/provisioning/provisioning.go @@ -4,19 +4,19 @@ import ( "context" "path/filepath" - "github.com/grafana/grafana/pkg/services/provisioning/dashboard" - "github.com/grafana/grafana/pkg/services/provisioning/datasource" + "github.com/grafana/grafana/pkg/services/provisioning/dashboards" + "github.com/grafana/grafana/pkg/services/provisioning/datasources" ini "gopkg.in/ini.v1" ) func Init(ctx context.Context, homePath string, cfg *ini.File) error { datasourcePath := makeAbsolute(cfg.Section("paths").Key("datasources").String(), homePath) - if err := datasource.Provision(datasourcePath); err != nil { + if err := datasources.Provision(datasourcePath); err != nil { return err } dashboardPath := makeAbsolute(cfg.Section("paths").Key("dashboards").String(), homePath) - _, err := dashboard.Provision(ctx, dashboardPath) + _, err := dashboards.Provision(ctx, dashboardPath) if err != nil { return err } From 16f072b32023546a5aa17b0d397063e9d562936f Mon Sep 17 00:00:00 2001 From: bergquist Date: Fri, 1 Dec 2017 13:50:47 +0100 Subject: [PATCH 08/18] dashboards as cfg: move saving logic for dashboards into its own service --- pkg/api/dashboard.go | 41 +++++++------------ pkg/models/dashboards.go | 1 + pkg/services/dashboards/dashboards.go | 12 +++--- .../provisioning/dashboards/file_reader.go | 6 ++- 4 files changed, 26 insertions(+), 34 deletions(-) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index 900524a8823..67afad4c010 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -3,11 +3,12 @@ package api import ( "encoding/json" "fmt" - //"github.com/grafana/grafana/pkg/services/dashboards" "os" "path" "strings" + "github.com/grafana/grafana/pkg/services/dashboards" + "github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/components/dashdiffs" @@ -17,7 +18,6 @@ import ( "github.com/grafana/grafana/pkg/middleware" m "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/plugins" - "github.com/grafana/grafana/pkg/services/alerting" "github.com/grafana/grafana/pkg/services/search" "github.com/grafana/grafana/pkg/setting" "github.com/grafana/grafana/pkg/util" @@ -125,17 +125,6 @@ func PostDashboard(c *middleware.Context, cmd m.SaveDashboardCommand) Response { dash := cmd.GetDashboardModel() - // dashItem := &dashboards.SaveDashboardItem{ - // Dashboard: dash, - // Message: cmd.Message, - // } - // err := dashboards.SaveDashboard(dashItem) - - // Check if Title is empty - if dash.Title == "" { - return ApiError(400, m.ErrDashboardTitleEmpty.Error(), nil) - } - if dash.Id == 0 { limitReached, err := middleware.QuotaReached(c, "dashboard") if err != nil { @@ -146,17 +135,23 @@ func PostDashboard(c *middleware.Context, cmd m.SaveDashboardCommand) Response { } } - validateAlertsCmd := alerting.ValidateDashboardAlertsCommand{ + dashItem := &dashboards.SaveDashboardItem{ + Dashboard: dash, + Message: cmd.Message, OrgId: c.OrgId, UserId: c.UserId, - Dashboard: dash, } - if err := bus.Dispatch(&validateAlertsCmd); err != nil { + dashboard, err := dashboards.SaveDashboard(dashItem) + + if err == m.ErrDashboardTitleEmpty { + return ApiError(400, m.ErrDashboardTitleEmpty.Error(), nil) + } + + if err == m.ErrDashboardContainsInvalidAlertData { return ApiError(500, "Invalid alert data. Cannot save dashboard", err) } - err := bus.Dispatch(&cmd) if err != nil { if err == m.ErrDashboardWithSameNameExists { return Json(412, util.DynMap{"status": "name-exists", "message": err.Error()}) @@ -178,18 +173,12 @@ func PostDashboard(c *middleware.Context, cmd m.SaveDashboardCommand) Response { return ApiError(500, "Failed to save dashboard", err) } - alertCmd := alerting.UpdateDashboardAlertsCommand{ - OrgId: c.OrgId, - UserId: c.UserId, - Dashboard: cmd.Result, - } - - if err := bus.Dispatch(&alertCmd); err != nil { - return ApiError(500, "Failed to save alerts", err) + if err == m.ErrDashboardFailedToUpdateAlertData { + return ApiError(500, "Invalid alert data. Cannot save dashboard", err) } c.TimeRequest(metrics.M_Api_Dashboard_Save) - return Json(200, util.DynMap{"status": "success", "slug": cmd.Result.Slug, "version": cmd.Result.Version}) + return Json(200, util.DynMap{"status": "success", "slug": dashboard.Slug, "version": dashboard.Version}) } func canEditDashboard(role m.RoleType) bool { diff --git a/pkg/models/dashboards.go b/pkg/models/dashboards.go index 4d1d1f1f3d5..aab6d78db3f 100644 --- a/pkg/models/dashboards.go +++ b/pkg/models/dashboards.go @@ -17,6 +17,7 @@ var ( ErrDashboardVersionMismatch = errors.New("The dashboard has been changed by someone else") ErrDashboardTitleEmpty = errors.New("Dashboard title cannot be empty") ErrDashboardContainsInvalidAlertData = errors.New("Invalid alert data. Cannot save dashboard") + ErrDashboardFailedToUpdateAlertData = errors.New("Failed to save alert data") ) type UpdatePluginDashboardError struct { diff --git a/pkg/services/dashboards/dashboards.go b/pkg/services/dashboards/dashboards.go index a5d3c3a4766..c411f6106c2 100644 --- a/pkg/services/dashboards/dashboards.go +++ b/pkg/services/dashboards/dashboards.go @@ -22,11 +22,11 @@ type SaveDashboardItem struct { Dashboard *models.Dashboard } -func SaveDashboard(json *SaveDashboardItem) error { +func SaveDashboard(json *SaveDashboardItem) (*models.Dashboard, error) { dashboard := json.Dashboard if dashboard.Title == "" { - return models.ErrDashboardTitleEmpty + return nil, models.ErrDashboardTitleEmpty } validateAlertsCmd := alerting.ValidateDashboardAlertsCommand{ @@ -35,7 +35,7 @@ func SaveDashboard(json *SaveDashboardItem) error { } if err := bus.Dispatch(&validateAlertsCmd); err != nil { - return models.ErrDashboardContainsInvalidAlertData + return nil, models.ErrDashboardContainsInvalidAlertData } cmd := models.SaveDashboardCommand{ @@ -51,7 +51,7 @@ func SaveDashboard(json *SaveDashboardItem) error { err := bus.Dispatch(&cmd) if err != nil { - return err + return nil, err } alertCmd := alerting.UpdateDashboardAlertsCommand{ @@ -60,8 +60,8 @@ func SaveDashboard(json *SaveDashboardItem) error { } if err := bus.Dispatch(&alertCmd); err != nil { - return err + return nil, models.ErrDashboardFailedToUpdateAlertData } - return nil + return cmd.Result, nil } diff --git a/pkg/services/provisioning/dashboards/file_reader.go b/pkg/services/provisioning/dashboards/file_reader.go index c15fd7cb521..1b2feb2d591 100644 --- a/pkg/services/provisioning/dashboards/file_reader.go +++ b/pkg/services/provisioning/dashboards/file_reader.go @@ -96,7 +96,8 @@ func (fr *fileReader) walkFolder() error { if err == models.ErrDashboardNotFound { fr.log.Debug("saving new dashboard", "file", path) - return dashboards.SaveDashboard(dash) + _, err = dashboards.SaveDashboard(dash) + return err } if err != nil { @@ -109,7 +110,8 @@ func (fr *fileReader) walkFolder() error { } fr.log.Debug("no dashboard in cache. loading dashboard from disk into database.", "file", path) - return dashboards.SaveDashboard(dash) + _, err = dashboards.SaveDashboard(dash) + return err }) } From f5eac2e91dbee0d4fa926fc27c80a5183ff7b0bc Mon Sep 17 00:00:00 2001 From: bergquist Date: Fri, 1 Dec 2017 14:20:52 +0100 Subject: [PATCH 09/18] dashboards as cfg: expose dashboard service as interface --- pkg/api/dashboard.go | 2 +- pkg/services/dashboards/dashboards.go | 19 ++++++++++++++++--- .../provisioning/dashboards/file_reader.go | 9 ++++++--- 3 files changed, 23 insertions(+), 7 deletions(-) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index 67afad4c010..b2e4d2bf9d3 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -142,7 +142,7 @@ func PostDashboard(c *middleware.Context, cmd m.SaveDashboardCommand) Response { UserId: c.UserId, } - dashboard, err := dashboards.SaveDashboard(dashItem) + dashboard, err := dashboards.GetRepository().SaveDashboard(dashItem) if err == m.ErrDashboardTitleEmpty { return ApiError(400, m.ErrDashboardTitleEmpty.Error(), nil) diff --git a/pkg/services/dashboards/dashboards.go b/pkg/services/dashboards/dashboards.go index c411f6106c2..4f05b1f6663 100644 --- a/pkg/services/dashboards/dashboards.go +++ b/pkg/services/dashboards/dashboards.go @@ -1,14 +1,25 @@ package dashboards import ( + "time" + "github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/services/alerting" - "time" ) type Repository interface { - SaveDashboard(*SaveDashboardItem) error + SaveDashboard(*SaveDashboardItem) (*models.Dashboard, error) +} + +var repositoryInstance Repository + +func GetRepository() Repository { + return repositoryInstance +} + +func SetRepository(rep Repository) { + repositoryInstance = rep } type SaveDashboardItem struct { @@ -22,7 +33,9 @@ type SaveDashboardItem struct { Dashboard *models.Dashboard } -func SaveDashboard(json *SaveDashboardItem) (*models.Dashboard, error) { +type dashboardRepository struct{} + +func (dr *dashboardRepository) SaveDashboard(json *SaveDashboardItem) (*models.Dashboard, error) { dashboard := json.Dashboard if dashboard.Title == "" { diff --git a/pkg/services/provisioning/dashboards/file_reader.go b/pkg/services/provisioning/dashboards/file_reader.go index 1b2feb2d591..1af4f35de12 100644 --- a/pkg/services/provisioning/dashboards/file_reader.go +++ b/pkg/services/provisioning/dashboards/file_reader.go @@ -3,12 +3,13 @@ package dashboards import ( "context" "fmt" - "github.com/grafana/grafana/pkg/services/dashboards" "os" "path/filepath" "strings" "time" + "github.com/grafana/grafana/pkg/services/dashboards" + "github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/components/simplejson" @@ -21,6 +22,7 @@ type fileReader struct { Path string log log.Logger dashboardCache *dashboardCache + dashboardRepo dashboards.Repository } func NewDashboardFilereader(cfg *DashboardsAsConfig, log log.Logger) (*fileReader, error) { @@ -37,6 +39,7 @@ func NewDashboardFilereader(cfg *DashboardsAsConfig, log log.Logger) (*fileReade Cfg: cfg, Path: path, log: log, + dashboardRepo: dashboards.GetRepository(), dashboardCache: newDashboardCache(), }, nil } @@ -96,7 +99,7 @@ func (fr *fileReader) walkFolder() error { if err == models.ErrDashboardNotFound { fr.log.Debug("saving new dashboard", "file", path) - _, err = dashboards.SaveDashboard(dash) + _, err = fr.dashboardRepo.SaveDashboard(dash) return err } @@ -110,7 +113,7 @@ func (fr *fileReader) walkFolder() error { } fr.log.Debug("no dashboard in cache. loading dashboard from disk into database.", "file", path) - _, err = dashboards.SaveDashboard(dash) + _, err = fr.dashboardRepo.SaveDashboard(dash) return err }) } From 288cc355294119c125a1301fa496a30d25086061 Mon Sep 17 00:00:00 2001 From: bergquist Date: Fri, 1 Dec 2017 14:40:37 +0100 Subject: [PATCH 10/18] dashboards as cfg: use gocache for caching --- pkg/services/dashboards/dashboards.go | 8 ++-- .../provisioning/dashboards/file_reader.go | 45 +++++++++++++------ .../dashboards/file_reader_test.go | 31 +++++-------- pkg/services/provisioning/dashboards/types.go | 33 ++------------ 4 files changed, 52 insertions(+), 65 deletions(-) diff --git a/pkg/services/dashboards/dashboards.go b/pkg/services/dashboards/dashboards.go index 4f05b1f6663..11d77442c7c 100644 --- a/pkg/services/dashboards/dashboards.go +++ b/pkg/services/dashboards/dashboards.go @@ -26,7 +26,7 @@ type SaveDashboardItem struct { TitleLower string OrgId int64 Folder string - ModTime time.Time + UpdatedAt time.Time UserId int64 Message string Overwrite bool @@ -56,10 +56,11 @@ func (dr *dashboardRepository) SaveDashboard(json *SaveDashboardItem) (*models.D Message: json.Message, OrgId: json.OrgId, Overwrite: json.Overwrite, + UserId: json.UserId, } - if !json.ModTime.IsZero() { - cmd.UpdatedAt = json.ModTime + if !json.UpdatedAt.IsZero() { + cmd.UpdatedAt = json.UpdatedAt } err := bus.Dispatch(&cmd) @@ -69,6 +70,7 @@ func (dr *dashboardRepository) SaveDashboard(json *SaveDashboardItem) (*models.D alertCmd := alerting.UpdateDashboardAlertsCommand{ OrgId: json.OrgId, + UserId: json.UserId, Dashboard: cmd.Result, } diff --git a/pkg/services/provisioning/dashboards/file_reader.go b/pkg/services/provisioning/dashboards/file_reader.go index 1af4f35de12..708b2ea681f 100644 --- a/pkg/services/provisioning/dashboards/file_reader.go +++ b/pkg/services/provisioning/dashboards/file_reader.go @@ -15,14 +15,15 @@ import ( "github.com/grafana/grafana/pkg/components/simplejson" "github.com/grafana/grafana/pkg/log" "github.com/grafana/grafana/pkg/models" + gocache "github.com/patrickmn/go-cache" ) type fileReader struct { - Cfg *DashboardsAsConfig - Path string - log log.Logger - dashboardCache *dashboardCache - dashboardRepo dashboards.Repository + Cfg *DashboardsAsConfig + Path string + log log.Logger + dashboardRepo dashboards.Repository + cache *gocache.Cache } func NewDashboardFilereader(cfg *DashboardsAsConfig, log log.Logger) (*fileReader, error) { @@ -36,14 +37,32 @@ func NewDashboardFilereader(cfg *DashboardsAsConfig, log log.Logger) (*fileReade } return &fileReader{ - Cfg: cfg, - Path: path, - log: log, - dashboardRepo: dashboards.GetRepository(), - dashboardCache: newDashboardCache(), + Cfg: cfg, + Path: path, + log: log, + dashboardRepo: dashboards.GetRepository(), + cache: gocache.New(5*time.Minute, 10*time.Minute), }, nil } +func (fr *fileReader) addCache(key string, json *dashboards.SaveDashboardItem) { + fr.cache.Add(key, json, time.Minute*10) +} + +func (fr *fileReader) getCache(key string) (*dashboards.SaveDashboardItem, bool) { + obj, exist := fr.cache.Get(key) + if !exist { + return nil, exist + } + + dash, ok := obj.(*dashboards.SaveDashboardItem) + if !ok { + return nil, ok + } + + return dash, ok +} + func (fr *fileReader) ReadAndListen(ctx context.Context) error { ticker := time.NewTicker(time.Second * 5) @@ -83,8 +102,8 @@ func (fr *fileReader) walkFolder() error { return nil } - cachedDashboard, exist := fr.dashboardCache.getCache(path) - if exist && cachedDashboard.ModTime == f.ModTime() { + cachedDashboard, exist := fr.getCache(path) + if exist && cachedDashboard.UpdatedAt == f.ModTime() { return nil } @@ -140,7 +159,7 @@ func (fr *fileReader) readDashboardFromFile(path string) (*dashboards.SaveDashbo return nil, err } - fr.dashboardCache.addCache(path, dash) + fr.addCache(path, dash) return dash, nil } diff --git a/pkg/services/provisioning/dashboards/file_reader_test.go b/pkg/services/provisioning/dashboards/file_reader_test.go index 55c26e47dec..ba6e44114fa 100644 --- a/pkg/services/provisioning/dashboards/file_reader_test.go +++ b/pkg/services/provisioning/dashboards/file_reader_test.go @@ -1,13 +1,14 @@ package dashboards import ( - "github.com/grafana/grafana/pkg/bus" - "github.com/grafana/grafana/pkg/models" - "github.com/grafana/grafana/pkg/services/alerting" "os" "testing" "time" + "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/models" + "github.com/grafana/grafana/pkg/services/dashboards" + "github.com/grafana/grafana/pkg/log" . "github.com/smartystreets/goconvey/convey" ) @@ -26,9 +27,7 @@ func TestDashboardFileReader(t *testing.T) { fakeRepo = &fakeDashboardRepo{} bus.AddHandler("test", mockGetDashboardQuery) - bus.AddHandler("test", mockValidateDashboardAlertsCommand) - bus.AddHandler("test", mockSaveDashboardCommand) - bus.AddHandler("test", mockUpdateDashboardAlertsCommand) + dashboards.SetRepository(fakeRepo) logger := log.New("test.logger") cfg := &DashboardsAsConfig{ @@ -117,10 +116,15 @@ func TestDashboardFileReader(t *testing.T) { } type fakeDashboardRepo struct { - inserted []*models.SaveDashboardCommand + inserted []*dashboards.SaveDashboardItem getDashboard []*models.Dashboard } +func (repo *fakeDashboardRepo) SaveDashboard(json *dashboards.SaveDashboardItem) (*models.Dashboard, error) { + repo.inserted = append(repo.inserted, json) + return json.Dashboard, nil +} + func mockGetDashboardQuery(cmd *models.GetDashboardQuery) error { for _, d := range fakeRepo.getDashboard { if d.Slug == cmd.Slug { @@ -131,16 +135,3 @@ func mockGetDashboardQuery(cmd *models.GetDashboardQuery) error { return models.ErrDashboardNotFound } - -func mockValidateDashboardAlertsCommand(cmd *alerting.ValidateDashboardAlertsCommand) error { - return nil -} - -func mockSaveDashboardCommand(cmd *models.SaveDashboardCommand) error { - fakeRepo.inserted = append(fakeRepo.inserted, cmd) - return nil -} - -func mockUpdateDashboardAlertsCommand(cmd *alerting.UpdateDashboardAlertsCommand) error { - return nil -} diff --git a/pkg/services/provisioning/dashboards/types.go b/pkg/services/provisioning/dashboards/types.go index 5b73b6d10e3..0a065029a31 100644 --- a/pkg/services/provisioning/dashboards/types.go +++ b/pkg/services/provisioning/dashboards/types.go @@ -1,11 +1,11 @@ package dashboards import ( + "strings" + "time" + "github.com/grafana/grafana/pkg/components/simplejson" "github.com/grafana/grafana/pkg/services/dashboards" - "strings" - "sync" - "time" "github.com/grafana/grafana/pkg/models" ) @@ -19,37 +19,12 @@ type DashboardsAsConfig struct { Options map[string]interface{} `json:"options" yaml:"options"` } -type dashboardCache struct { - mutex *sync.Mutex - dashboards map[string]*dashboards.SaveDashboardItem -} - -func newDashboardCache() *dashboardCache { - return &dashboardCache{ - dashboards: map[string]*dashboards.SaveDashboardItem{}, - mutex: &sync.Mutex{}, - } -} - -func (dc *dashboardCache) addCache(key string, json *dashboards.SaveDashboardItem) { - dc.mutex.Lock() - defer dc.mutex.Unlock() - dc.dashboards[key] = json -} - -func (dc *dashboardCache) getCache(key string) (*dashboards.SaveDashboardItem, bool) { - dc.mutex.Lock() - defer dc.mutex.Unlock() - v, exist := dc.dashboards[key] - return v, exist -} - func createDashboardJson(data *simplejson.Json, lastModified time.Time, cfg *DashboardsAsConfig) (*dashboards.SaveDashboardItem, error) { dash := &dashboards.SaveDashboardItem{} dash.Dashboard = models.NewDashboardFromJson(data) dash.TitleLower = strings.ToLower(dash.Dashboard.Title) - dash.ModTime = lastModified + dash.UpdatedAt = lastModified dash.OrgId = cfg.OrgId dash.Folder = cfg.Folder dash.Dashboard.Data.Set("editable", cfg.Editable) From 099178466d8325c958c18e736af0e691964e2e68 Mon Sep 17 00:00:00 2001 From: bergquist Date: Fri, 1 Dec 2017 15:10:48 +0100 Subject: [PATCH 11/18] dashboards as cfg: wire up dashboard repo --- pkg/services/dashboards/dashboards.go | 4 ++-- .../provisioning/dashboards/file_reader.go | 18 ++++++++++-------- pkg/services/provisioning/dashboards/types.go | 1 + pkg/services/sqlstore/sqlstore.go | 2 ++ 4 files changed, 15 insertions(+), 10 deletions(-) diff --git a/pkg/services/dashboards/dashboards.go b/pkg/services/dashboards/dashboards.go index 11d77442c7c..24e9f240fd8 100644 --- a/pkg/services/dashboards/dashboards.go +++ b/pkg/services/dashboards/dashboards.go @@ -33,9 +33,9 @@ type SaveDashboardItem struct { Dashboard *models.Dashboard } -type dashboardRepository struct{} +type DashboardRepository struct{} -func (dr *dashboardRepository) SaveDashboard(json *SaveDashboardItem) (*models.Dashboard, error) { +func (dr *DashboardRepository) SaveDashboard(json *SaveDashboardItem) (*models.Dashboard, error) { dashboard := json.Dashboard if dashboard.Title == "" { diff --git a/pkg/services/provisioning/dashboards/file_reader.go b/pkg/services/provisioning/dashboards/file_reader.go index 708b2ea681f..bf12eb2e722 100644 --- a/pkg/services/provisioning/dashboards/file_reader.go +++ b/pkg/services/provisioning/dashboards/file_reader.go @@ -41,7 +41,7 @@ func NewDashboardFilereader(cfg *DashboardsAsConfig, log log.Logger) (*fileReade Path: path, log: log, dashboardRepo: dashboards.GetRepository(), - cache: gocache.New(5*time.Minute, 10*time.Minute), + cache: gocache.New(5*time.Minute, 30*time.Minute), }, nil } @@ -87,23 +87,23 @@ func (fr *fileReader) walkFolder() error { } } - return filepath.Walk(fr.Path, func(path string, f os.FileInfo, err error) error { + return filepath.Walk(fr.Path, func(path string, fileInfo os.FileInfo, err error) error { if err != nil { return err } - if f.IsDir() { - if strings.HasPrefix(f.Name(), ".") { + if fileInfo.IsDir() { + if strings.HasPrefix(fileInfo.Name(), ".") { return filepath.SkipDir } return nil } - if !strings.HasSuffix(f.Name(), ".json") { + if !strings.HasSuffix(fileInfo.Name(), ".json") { return nil } cachedDashboard, exist := fr.getCache(path) - if exist && cachedDashboard.UpdatedAt == f.ModTime() { + if exist && cachedDashboard.UpdatedAt == fileInfo.ModTime() { return nil } @@ -116,6 +116,7 @@ func (fr *fileReader) walkFolder() error { cmd := &models.GetDashboardQuery{Slug: dash.Dashboard.Slug} err = bus.Dispatch(cmd) + // if we dont have the dashboard in the db, save it! if err == models.ErrDashboardNotFound { fr.log.Debug("saving new dashboard", "file", path) _, err = fr.dashboardRepo.SaveDashboard(dash) @@ -127,11 +128,12 @@ func (fr *fileReader) walkFolder() error { return nil } - if cmd.Result.Updated.Unix() >= f.ModTime().Unix() { + // break if db version is newer then fil version + if cmd.Result.Updated.Unix() >= fileInfo.ModTime().Unix() { return nil } - fr.log.Debug("no dashboard in cache. loading dashboard from disk into database.", "file", path) + fr.log.Debug("loading dashboard from disk into database.", "file", path) _, err = fr.dashboardRepo.SaveDashboard(dash) return err }) diff --git a/pkg/services/provisioning/dashboards/types.go b/pkg/services/provisioning/dashboards/types.go index 0a065029a31..002a56b5f3c 100644 --- a/pkg/services/provisioning/dashboards/types.go +++ b/pkg/services/provisioning/dashboards/types.go @@ -25,6 +25,7 @@ func createDashboardJson(data *simplejson.Json, lastModified time.Time, cfg *Das dash.Dashboard = models.NewDashboardFromJson(data) dash.TitleLower = strings.ToLower(dash.Dashboard.Title) dash.UpdatedAt = lastModified + dash.Overwrite = true dash.OrgId = cfg.OrgId dash.Folder = cfg.Folder dash.Dashboard.Data.Set("editable", cfg.Editable) diff --git a/pkg/services/sqlstore/sqlstore.go b/pkg/services/sqlstore/sqlstore.go index f37499bd60f..2655bf9c22e 100644 --- a/pkg/services/sqlstore/sqlstore.go +++ b/pkg/services/sqlstore/sqlstore.go @@ -12,6 +12,7 @@ import ( "github.com/grafana/grafana/pkg/log" m "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/services/annotations" + "github.com/grafana/grafana/pkg/services/dashboards" "github.com/grafana/grafana/pkg/services/sqlstore/migrations" "github.com/grafana/grafana/pkg/services/sqlstore/migrator" "github.com/grafana/grafana/pkg/setting" @@ -100,6 +101,7 @@ func SetEngine(engine *xorm.Engine) (err error) { // Init repo instances annotations.SetRepository(&SqlAnnotationRepo{}) + dashboards.SetRepository(&dashboards.DashboardRepository{}) return nil } From 2a18345eb2e01595fb5fa9cd2c0b7f6251f8a8f3 Mon Sep 17 00:00:00 2001 From: bergquist Date: Fri, 1 Dec 2017 15:16:13 +0100 Subject: [PATCH 12/18] dashboards as cfg: disable loading dashboards from disk by default --- conf/dashboards/dashboards.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/conf/dashboards/dashboards.yaml b/conf/dashboards/dashboards.yaml index 909a621ca18..40992d1461e 100644 --- a/conf/dashboards/dashboards.yaml +++ b/conf/dashboards/dashboards.yaml @@ -1,6 +1,6 @@ -- name: 'default' - org_id: 1 - folder: '' - type: file - options: - folder: /var/lib/grafana/dashboards \ No newline at end of file +# - name: 'default' +# org_id: 1 +# folder: '' +# type: file +# options: +# folder: /var/lib/grafana/dashboards \ No newline at end of file From b28ea0b407bfa2d9da9b3f132c968e09b08abebb Mon Sep 17 00:00:00 2001 From: bergquist Date: Tue, 5 Dec 2017 13:57:39 +0100 Subject: [PATCH 13/18] dashboards as cfg: type --- pkg/services/provisioning/dashboards/dashboard.go | 2 +- pkg/services/provisioning/dashboards/file_reader.go | 2 +- .../provisioning/dashboards/file_reader_test.go | 10 +++++----- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/pkg/services/provisioning/dashboards/dashboard.go b/pkg/services/provisioning/dashboards/dashboard.go index e2c802a0024..1ee0f78497d 100644 --- a/pkg/services/provisioning/dashboards/dashboard.go +++ b/pkg/services/provisioning/dashboards/dashboard.go @@ -33,7 +33,7 @@ func (provider *DashboardProvisioner) Provision(ctx context.Context) error { for _, cfg := range cfgs { switch cfg.Type { case "file": - fileReader, err := NewDashboardFilereader(cfg, provider.log.New("type", cfg.Type, "name", cfg.Name)) + fileReader, err := NewDashboardFileReader(cfg, provider.log.New("type", cfg.Type, "name", cfg.Name)) if err != nil { return err } diff --git a/pkg/services/provisioning/dashboards/file_reader.go b/pkg/services/provisioning/dashboards/file_reader.go index bf12eb2e722..3491960e329 100644 --- a/pkg/services/provisioning/dashboards/file_reader.go +++ b/pkg/services/provisioning/dashboards/file_reader.go @@ -26,7 +26,7 @@ type fileReader struct { cache *gocache.Cache } -func NewDashboardFilereader(cfg *DashboardsAsConfig, log log.Logger) (*fileReader, error) { +func NewDashboardFileReader(cfg *DashboardsAsConfig, log log.Logger) (*fileReader, error) { path, ok := cfg.Options["folder"].(string) if !ok { return nil, fmt.Errorf("Failed to load dashboards. folder param is not a string") diff --git a/pkg/services/provisioning/dashboards/file_reader_test.go b/pkg/services/provisioning/dashboards/file_reader_test.go index ba6e44114fa..e91f278322a 100644 --- a/pkg/services/provisioning/dashboards/file_reader_test.go +++ b/pkg/services/provisioning/dashboards/file_reader_test.go @@ -41,7 +41,7 @@ func TestDashboardFileReader(t *testing.T) { Convey("Can read default dashboard", func() { cfg.Options["folder"] = defaultDashboards - reader, err := NewDashboardFilereader(cfg, logger) + reader, err := NewDashboardFileReader(cfg, logger) So(err, ShouldBeNil) err = reader.walkFolder() @@ -58,7 +58,7 @@ func TestDashboardFileReader(t *testing.T) { Slug: "grafana", }) - reader, err := NewDashboardFilereader(cfg, logger) + reader, err := NewDashboardFileReader(cfg, logger) So(err, ShouldBeNil) err = reader.walkFolder() @@ -77,7 +77,7 @@ func TestDashboardFileReader(t *testing.T) { Slug: "grafana", }) - reader, err := NewDashboardFilereader(cfg, logger) + reader, err := NewDashboardFileReader(cfg, logger) So(err, ShouldBeNil) err = reader.walkFolder() @@ -94,7 +94,7 @@ func TestDashboardFileReader(t *testing.T) { Folder: "", } - _, err := NewDashboardFilereader(cfg, logger) + _, err := NewDashboardFileReader(cfg, logger) So(err, ShouldNotBeNil) }) @@ -109,7 +109,7 @@ func TestDashboardFileReader(t *testing.T) { }, } - _, err := NewDashboardFilereader(cfg, logger) + _, err := NewDashboardFileReader(cfg, logger) So(err, ShouldBeNil) }) }) From 1dfa529941643b486ceadb7f38cfd8f2b1f3d0eb Mon Sep 17 00:00:00 2001 From: bergquist Date: Tue, 5 Dec 2017 13:58:56 +0100 Subject: [PATCH 14/18] dashboards as cfg: avoid walking fs in parallel --- pkg/services/provisioning/dashboards/file_reader.go | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/pkg/services/provisioning/dashboards/file_reader.go b/pkg/services/provisioning/dashboards/file_reader.go index 3491960e329..42f232bca82 100644 --- a/pkg/services/provisioning/dashboards/file_reader.go +++ b/pkg/services/provisioning/dashboards/file_reader.go @@ -64,16 +64,24 @@ func (fr *fileReader) getCache(key string) (*dashboards.SaveDashboardItem, bool) } func (fr *fileReader) ReadAndListen(ctx context.Context) error { - ticker := time.NewTicker(time.Second * 5) + ticker := time.NewTicker(time.Second * 3) if err := fr.walkFolder(); err != nil { fr.log.Error("failed to search for dashboards", "error", err) } + running := false + for { select { case <-ticker.C: - fr.walkFolder() + if !running { // avoid walking the filesystem in parallel. incase fs is very slow. + running = true + go func() { + fr.walkFolder() + running = false + }() + } case <-ctx.Done(): return nil } From 361acd3fa1fc3ed5eff413d16f2c74960ec9f9ba Mon Sep 17 00:00:00 2001 From: bergquist Date: Tue, 5 Dec 2017 15:44:10 +0100 Subject: [PATCH 15/18] dashboards as cfg: include cfg files in dist packages --- conf/dashboards/{dashboards.yaml => sample.yaml} | 0 .../{datasources.yaml => sample.yaml} | 0 packaging/deb/control/postinst | 4 ++++ packaging/deb/default/grafana-server | 4 ++++ packaging/deb/init.d/grafana-server | 4 +++- packaging/deb/systemd/grafana-server.service | 16 ++++++++++------ packaging/mac/bin/grafana | 4 +++- packaging/rpm/control/postinst | 4 ++++ packaging/rpm/init.d/grafana-server | 4 +++- packaging/rpm/sysconfig/grafana-server | 4 ++++ packaging/rpm/systemd/grafana-server.service | 15 +++++++++------ pkg/setting/setting.go | 4 ++-- scripts/grunt/release_task.js | 2 +- 13 files changed, 47 insertions(+), 18 deletions(-) rename conf/dashboards/{dashboards.yaml => sample.yaml} (100%) rename conf/datasources/{datasources.yaml => sample.yaml} (100%) diff --git a/conf/dashboards/dashboards.yaml b/conf/dashboards/sample.yaml similarity index 100% rename from conf/dashboards/dashboards.yaml rename to conf/dashboards/sample.yaml diff --git a/conf/datasources/datasources.yaml b/conf/datasources/sample.yaml similarity index 100% rename from conf/datasources/datasources.yaml rename to conf/datasources/sample.yaml diff --git a/packaging/deb/control/postinst b/packaging/deb/control/postinst index 8e25a0e4124..c71d11bcbde 100755 --- a/packaging/deb/control/postinst +++ b/packaging/deb/control/postinst @@ -29,6 +29,10 @@ case "$1" in if [ ! -f $CONF_FILE ]; then cp /usr/share/grafana/conf/sample.ini $CONF_FILE cp /usr/share/grafana/conf/ldap.toml /etc/grafana/ldap.toml + + mkdir -p /etc/grafana/dashboards /etc/grafana/datasources + cp /usr/share/grafana/conf/dashboards/sample.yaml /etc/grafana/dashboards/sample.yaml + cp /usr/share/grafana/conf/datasources/sample.yaml /etc/grafana/datasources/sample.yaml fi # configuration files should not be modifiable by grafana user, as this can be a security issue diff --git a/packaging/deb/default/grafana-server b/packaging/deb/default/grafana-server index eaa75830d44..b1a59ae1b5f 100644 --- a/packaging/deb/default/grafana-server +++ b/packaging/deb/default/grafana-server @@ -18,5 +18,9 @@ RESTART_ON_UPGRADE=true PLUGINS_DIR=/var/lib/grafana/plugins +DATASOURCES_CFG_DIR=/etc/grafana/datasources + +DASHBOARDS_CFG_DIR=/etc/grafana/dashboards + # Only used on systemd systems PID_FILE_DIR=/var/run/grafana diff --git a/packaging/deb/init.d/grafana-server b/packaging/deb/init.d/grafana-server index 85b0e412d35..44f29c3c6fd 100755 --- a/packaging/deb/init.d/grafana-server +++ b/packaging/deb/init.d/grafana-server @@ -33,6 +33,8 @@ DATA_DIR=/var/lib/grafana PLUGINS_DIR=/var/lib/grafana/plugins LOG_DIR=/var/log/grafana CONF_FILE=$CONF_DIR/grafana.ini +DATASOURCES_CFG_DIR=$CONF_DIR/datasources +DASHBOARDS_CFG_DIR=$CONF_DIR/dashboards MAX_OPEN_FILES=10000 PID_FILE=/var/run/$NAME.pid DAEMON=/usr/sbin/$NAME @@ -55,7 +57,7 @@ if [ -f "$DEFAULT" ]; then . "$DEFAULT" fi -DAEMON_OPTS="--pidfile=${PID_FILE} --config=${CONF_FILE} cfg:default.paths.data=${DATA_DIR} cfg:default.paths.logs=${LOG_DIR} cfg:default.paths.plugins=${PLUGINS_DIR}" +DAEMON_OPTS="--pidfile=${PID_FILE} --config=${CONF_FILE} cfg:default.paths.datasources=$DATASOURCES_CFG_DIR cfg:default.paths.dashboards=$DASHBOARDS_CFG_DIR cfg:default.paths.data=${DATA_DIR} cfg:default.paths.logs=${LOG_DIR} cfg:default.paths.plugins=${PLUGINS_DIR}" function checkUser() { if [ `id -u` -ne 0 ]; then diff --git a/packaging/deb/systemd/grafana-server.service b/packaging/deb/systemd/grafana-server.service index cb7b87932d1..10682a155ee 100644 --- a/packaging/deb/systemd/grafana-server.service +++ b/packaging/deb/systemd/grafana-server.service @@ -14,12 +14,16 @@ Restart=on-failure WorkingDirectory=/usr/share/grafana RuntimeDirectory=grafana RuntimeDirectoryMode=0750 -ExecStart=/usr/sbin/grafana-server \ - --config=${CONF_FILE} \ - --pidfile=${PID_FILE_DIR}/grafana-server.pid \ - cfg:default.paths.logs=${LOG_DIR} \ - cfg:default.paths.data=${DATA_DIR} \ - cfg:default.paths.plugins=${PLUGINS_DIR} +ExecStart=/usr/sbin/grafana-server \ + --config=${CONF_FILE} \ + --pidfile=${PID_FILE_DIR}/grafana-server.pid \ + cfg:default.paths.logs=${LOG_DIR} \ + cfg:default.paths.data=${DATA_DIR} \ + cfg:default.paths.plugins=${PLUGINS_DIR} \ + cfg:default.paths.datasources=${DATASOURCES_CFG_DIR} \ + cfg:default.paths.dashboards=${DASHBOARDS_CFG_DIR} + + LimitNOFILE=10000 TimeoutStopSec=20 UMask=0027 diff --git a/packaging/mac/bin/grafana b/packaging/mac/bin/grafana index fb33079079e..74f4b00662b 100755 --- a/packaging/mac/bin/grafana +++ b/packaging/mac/bin/grafana @@ -6,10 +6,12 @@ HOMEPATH=/usr/local/share/grafana LOGPATH=/usr/local/var/log/grafana DATAPATH=/usr/local/var/lib/grafana PLUGINPATH=/usr/local/var/lib/grafana/plugins +DATASOURCECFGPATH=/usr/local/etc/grafana/datasources +DASHBOARDSCFGPATH=/usr/local/etc/grafana/dashboards case "$1" in start) - $EXECUTABLE --config=$CONFIG --homepath=$HOMEPATH cfg:default.paths.logs=$LOGPATH cfg:default.paths.data=$DATAPATH cfg:default.paths.plugins=$PLUGINPATH 2> /dev/null & + $EXECUTABLE --config=$CONFIG --homepath=$HOMEPATH cfg:default.paths.datasources=$DATASOURCECFGPATH cfg:default.paths.dashboards=$DASHBOARDSCFGPATH cfg:default.paths.logs=$LOGPATH cfg:default.paths.data=$DATAPATH cfg:default.paths.plugins=$PLUGINPATH 2> /dev/null & [ $? -eq 0 ] && echo "$DAEMON started" ;; stop) diff --git a/packaging/rpm/control/postinst b/packaging/rpm/control/postinst index 0bfca949e7f..07ddbc178de 100755 --- a/packaging/rpm/control/postinst +++ b/packaging/rpm/control/postinst @@ -43,6 +43,10 @@ if [ $1 -eq 1 ] ; then if [ ! -f $CONF_FILE ]; then cp /usr/share/grafana/conf/sample.ini $CONF_FILE cp /usr/share/grafana/conf/ldap.toml /etc/grafana/ldap.toml + + mkdir -p /etc/grafana/dashboards /etc/grafana/datasources + cp /usr/share/grafana/conf/dashboards/sample.yaml /etc/grafana/dashboards/sample.yaml + cp /usr/share/grafana/conf/datasources/sample.yaml /etc/grafana/datasources/sample.yaml fi # Set user permissions on /var/log/grafana, /var/lib/grafana diff --git a/packaging/rpm/init.d/grafana-server b/packaging/rpm/init.d/grafana-server index dc63e1ef4c6..eb7d169bb0e 100755 --- a/packaging/rpm/init.d/grafana-server +++ b/packaging/rpm/init.d/grafana-server @@ -32,6 +32,8 @@ DATA_DIR=/var/lib/grafana PLUGINS_DIR=/var/lib/grafana/plugins LOG_DIR=/var/log/grafana CONF_FILE=$CONF_DIR/grafana.ini +DATASOURCES_CFG_DIR=$CONF_DIR/datasources +DASHBOARDS_CFG_DIR=$CONF_DIR/dashboards MAX_OPEN_FILES=10000 PID_FILE=/var/run/$NAME.pid DAEMON=/usr/sbin/$NAME @@ -59,7 +61,7 @@ fi # overwrite settings from default file [ -e /etc/sysconfig/$NAME ] && . /etc/sysconfig/$NAME -DAEMON_OPTS="--pidfile=${PID_FILE} --config=${CONF_FILE} cfg:default.paths.data=${DATA_DIR} cfg:default.paths.logs=${LOG_DIR} cfg:default.paths.plugins=${PLUGINS_DIR}" +DAEMON_OPTS="--pidfile=${PID_FILE} --config=${CONF_FILE} cfg:default.paths.datasources=$DATASOURCES_CFG_DIR cfg:default.paths.dashboards=$DASHBOARDS_CFG_DIR cfg:default.paths.data=${DATA_DIR} cfg:default.paths.logs=${LOG_DIR} cfg:default.paths.plugins=${PLUGINS_DIR}" function isRunning() { status -p $PID_FILE $NAME > /dev/null 2>&1 diff --git a/packaging/rpm/sysconfig/grafana-server b/packaging/rpm/sysconfig/grafana-server index eaa75830d44..b1a59ae1b5f 100644 --- a/packaging/rpm/sysconfig/grafana-server +++ b/packaging/rpm/sysconfig/grafana-server @@ -18,5 +18,9 @@ RESTART_ON_UPGRADE=true PLUGINS_DIR=/var/lib/grafana/plugins +DATASOURCES_CFG_DIR=/etc/grafana/datasources + +DASHBOARDS_CFG_DIR=/etc/grafana/dashboards + # Only used on systemd systems PID_FILE_DIR=/var/run/grafana diff --git a/packaging/rpm/systemd/grafana-server.service b/packaging/rpm/systemd/grafana-server.service index b23e5196e17..e9c93baba6e 100644 --- a/packaging/rpm/systemd/grafana-server.service +++ b/packaging/rpm/systemd/grafana-server.service @@ -14,12 +14,15 @@ Restart=on-failure WorkingDirectory=/usr/share/grafana RuntimeDirectory=grafana RuntimeDirectoryMode=0750 -ExecStart=/usr/sbin/grafana-server \ - --config=${CONF_FILE} \ - --pidfile=${PID_FILE_DIR}/grafana-server.pid \ - cfg:default.paths.logs=${LOG_DIR} \ - cfg:default.paths.data=${DATA_DIR} \ - cfg:default.paths.plugins=${PLUGINS_DIR} +ExecStart=/usr/sbin/grafana-server \ + --config=${CONF_FILE} \ + --pidfile=${PID_FILE_DIR}/grafana-server.pid \ + cfg:default.paths.logs=${LOG_DIR} \ + cfg:default.paths.data=${DATA_DIR} \ + cfg:default.paths.plugins=${PLUGINS_DIR} \ + cfg:default.paths.datasources=${DATASOURCES_CFG_DIR} \ + cfg:default.paths.dashboards=${DASHBOARDS_CFG_DIR} + LimitNOFILE=10000 TimeoutStopSec=20 diff --git a/pkg/setting/setting.go b/pkg/setting/setting.go index f604cdd680b..69499c233fe 100644 --- a/pkg/setting/setting.go +++ b/pkg/setting/setting.go @@ -475,8 +475,8 @@ func NewConfigContext(args *CommandLineArgs) error { Env = Cfg.Section("").Key("app_mode").MustString("development") InstanceName = Cfg.Section("").Key("instance_name").MustString("unknown_instance_name") PluginsPath = makeAbsolute(Cfg.Section("paths").Key("plugins").String(), HomePath) - DatasourcesPath = makeAbsolute(Cfg.Section("paths").Key("datasources").String(), HomePath) - DashboardsPath = makeAbsolute(Cfg.Section("paths").Key("dashboards").String(), HomePath) + DatasourcesPath = Cfg.Section("paths").Key("datasources").String() + DashboardsPath = Cfg.Section("paths").Key("dashboards").String() server := Cfg.Section("server") AppUrl, AppSubUrl = parseAppUrlAndSubUrl(server) diff --git a/scripts/grunt/release_task.js b/scripts/grunt/release_task.js index ecce22f20bd..28208ed0086 100644 --- a/scripts/grunt/release_task.js +++ b/scripts/grunt/release_task.js @@ -26,7 +26,7 @@ module.exports = function(grunt) { }); grunt.config('copy.backend_files', { expand: true, - src: ['conf/*', 'vendor/phantomjs/*', 'scripts/*'], + src: ['conf/**', 'vendor/phantomjs/*', 'scripts/*'], options: { mode: true}, dest: '<%= tempDir %>' }); From 50bc801f1ca5f3a85a9818fec1ab33069b6e48b6 Mon Sep 17 00:00:00 2001 From: bergquist Date: Wed, 6 Dec 2017 10:17:05 +0100 Subject: [PATCH 16/18] dashboards as cfg: copy dash/ds files if missing --- packaging/deb/control/postinst | 10 ++++++---- packaging/rpm/control/postinst | 10 ++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/packaging/deb/control/postinst b/packaging/deb/control/postinst index c71d11bcbde..b38f9edadef 100755 --- a/packaging/deb/control/postinst +++ b/packaging/deb/control/postinst @@ -29,12 +29,14 @@ case "$1" in if [ ! -f $CONF_FILE ]; then cp /usr/share/grafana/conf/sample.ini $CONF_FILE cp /usr/share/grafana/conf/ldap.toml /etc/grafana/ldap.toml - - mkdir -p /etc/grafana/dashboards /etc/grafana/datasources - cp /usr/share/grafana/conf/dashboards/sample.yaml /etc/grafana/dashboards/sample.yaml - cp /usr/share/grafana/conf/datasources/sample.yaml /etc/grafana/datasources/sample.yaml fi + if [ ! -f $DATASOURCES_CFG_DIR ]; then + mkdir -p /etc/grafana/dashboards /etc/grafana/datasources + cp /usr/share/grafana/conf/dashboards/sample.yaml $DASHBOARDS_CFG_DIR/sample.yaml + cp /usr/share/grafana/conf/datasources/sample.yaml $DATASOURCES_CFG_DIR/sample.yaml + fi + # configuration files should not be modifiable by grafana user, as this can be a security issue chown -Rh root:$GRAFANA_GROUP /etc/grafana/* chmod 755 /etc/grafana diff --git a/packaging/rpm/control/postinst b/packaging/rpm/control/postinst index 07ddbc178de..68e556b7f2d 100755 --- a/packaging/rpm/control/postinst +++ b/packaging/rpm/control/postinst @@ -43,12 +43,14 @@ if [ $1 -eq 1 ] ; then if [ ! -f $CONF_FILE ]; then cp /usr/share/grafana/conf/sample.ini $CONF_FILE cp /usr/share/grafana/conf/ldap.toml /etc/grafana/ldap.toml - - mkdir -p /etc/grafana/dashboards /etc/grafana/datasources - cp /usr/share/grafana/conf/dashboards/sample.yaml /etc/grafana/dashboards/sample.yaml - cp /usr/share/grafana/conf/datasources/sample.yaml /etc/grafana/datasources/sample.yaml fi + if [ ! -f $DATASOURCES_CFG_DIR ]; then + mkdir -p /etc/grafana/dashboards /etc/grafana/datasources + cp /usr/share/grafana/conf/dashboards/sample.yaml $DASHBOARDS_CFG_DIR/sample.yaml + cp /usr/share/grafana/conf/datasources/sample.yaml $DATASOURCES_CFG_DIR/sample.yaml + fi + # Set user permissions on /var/log/grafana, /var/lib/grafana mkdir -p /var/log/grafana /var/lib/grafana chown -R $GRAFANA_USER:$GRAFANA_GROUP /var/log/grafana /var/lib/grafana From 2e610cb25614df7603ece97961b94a717dd9f938 Mon Sep 17 00:00:00 2001 From: bergquist Date: Thu, 7 Dec 2017 15:14:57 +0100 Subject: [PATCH 17/18] dashboards as cfg: move dash/ds config files to /provisioning/* --- conf/defaults.ini | 7 +-- conf/provisioning/dashboards/custom.yaml | 6 +++ .../{ => provisioning}/dashboards/sample.yaml | 0 conf/provisioning/datasources/custom.yaml | 48 +++++++++++++++++++ .../datasources/sample.yaml | 0 packaging/deb/control/postinst | 8 ++-- packaging/deb/default/grafana-server | 4 +- packaging/deb/init.d/grafana-server | 5 +- packaging/deb/systemd/grafana-server.service | 15 +++--- packaging/rpm/control/postinst | 8 ++-- packaging/rpm/init.d/grafana-server | 5 +- packaging/rpm/sysconfig/grafana-server | 4 +- packaging/rpm/systemd/grafana-server.service | 15 +++--- pkg/services/provisioning/provisioning.go | 7 ++- pkg/setting/setting.go | 19 ++++---- 15 files changed, 97 insertions(+), 54 deletions(-) create mode 100644 conf/provisioning/dashboards/custom.yaml rename conf/{ => provisioning}/dashboards/sample.yaml (100%) create mode 100644 conf/provisioning/datasources/custom.yaml rename conf/{ => provisioning}/datasources/sample.yaml (100%) diff --git a/conf/defaults.ini b/conf/defaults.ini index 9dd1857f270..6e099949af1 100644 --- a/conf/defaults.ini +++ b/conf/defaults.ini @@ -20,11 +20,8 @@ logs = data/log # Directory where grafana will automatically scan and look for plugins plugins = data/plugins -# Config files containing datasources that will be configured at startup -datasources = conf/datasources - -# Config files containing folders to read dashboards from and insert into the database. -dashboards = conf/dashboards +# folder that contains provisioning config files that grafana will apply on startup and while running. +provisioning = conf/provisioning #################################### Server ############################## [server] diff --git a/conf/provisioning/dashboards/custom.yaml b/conf/provisioning/dashboards/custom.yaml new file mode 100644 index 00000000000..909a621ca18 --- /dev/null +++ b/conf/provisioning/dashboards/custom.yaml @@ -0,0 +1,6 @@ +- name: 'default' + org_id: 1 + folder: '' + type: file + options: + folder: /var/lib/grafana/dashboards \ No newline at end of file diff --git a/conf/dashboards/sample.yaml b/conf/provisioning/dashboards/sample.yaml similarity index 100% rename from conf/dashboards/sample.yaml rename to conf/provisioning/dashboards/sample.yaml diff --git a/conf/provisioning/datasources/custom.yaml b/conf/provisioning/datasources/custom.yaml new file mode 100644 index 00000000000..3d3e36ff108 --- /dev/null +++ b/conf/provisioning/datasources/custom.yaml @@ -0,0 +1,48 @@ +# list of datasources that should be deleted from the database +delete_datasources: + - name: Graphite + org_id: 1 + +# list of datasources to insert/update depending +# whats available in the datbase +datasources: + # name of the datasource. Required +- name: Graphite + # datasource type. Required + type: graphite + # access mode. direct or proxy. Required + access: proxy + # org id. will default to org_id 1 if not specified + org_id: 1 + # url + url: http://localhost:8080 + # database password, if used + password: + # database user, if used + user: + # database name, if used + database: + # enable/disable basic auth + basic_auth: + # basic auth username + basic_auth_user: + # basic auth password + basic_auth_password: + # enable/disable with credentials headers + with_credentials: + # mark as default datasource. Max one per org + is_default: + # fields that will be converted to json and stored in json_data + json_data: + graphiteVersion: "1.1" + tlsAuth: true + tlsAuthWithCACert: true + # json object of data that will be encrypted. + secure_json_data: + tlsCACert: "..." + tlsClientCert: "..." + tlsClientKey: "..." + version: 1 + # allow users to edit datasources from the UI. + editable: false + diff --git a/conf/datasources/sample.yaml b/conf/provisioning/datasources/sample.yaml similarity index 100% rename from conf/datasources/sample.yaml rename to conf/provisioning/datasources/sample.yaml diff --git a/packaging/deb/control/postinst b/packaging/deb/control/postinst index b38f9edadef..351c966a8e6 100755 --- a/packaging/deb/control/postinst +++ b/packaging/deb/control/postinst @@ -31,10 +31,10 @@ case "$1" in cp /usr/share/grafana/conf/ldap.toml /etc/grafana/ldap.toml fi - if [ ! -f $DATASOURCES_CFG_DIR ]; then - mkdir -p /etc/grafana/dashboards /etc/grafana/datasources - cp /usr/share/grafana/conf/dashboards/sample.yaml $DASHBOARDS_CFG_DIR/sample.yaml - cp /usr/share/grafana/conf/datasources/sample.yaml $DATASOURCES_CFG_DIR/sample.yaml + if [ ! -f $PROVISIONING_CFG_DIR ]; then + mkdir -p $PROVISIONING_CFG_DIR/dashboards $PROVISIONING_CFG_DIR/datasources + cp /usr/share/grafana/conf/provisioning/dashboards/sample.yaml $PROVISIONING_CFG_DIR/dashboards/sample.yaml + cp /usr/share/grafana/conf/provisioning/datasources/sample.yaml $PROVISIONING_CFG_DIR/datasources/sample.yaml fi # configuration files should not be modifiable by grafana user, as this can be a security issue diff --git a/packaging/deb/default/grafana-server b/packaging/deb/default/grafana-server index b1a59ae1b5f..eb77e62d774 100644 --- a/packaging/deb/default/grafana-server +++ b/packaging/deb/default/grafana-server @@ -18,9 +18,7 @@ RESTART_ON_UPGRADE=true PLUGINS_DIR=/var/lib/grafana/plugins -DATASOURCES_CFG_DIR=/etc/grafana/datasources - -DASHBOARDS_CFG_DIR=/etc/grafana/dashboards +PROVISIONING_CFG_DIR=/etc/grafana/provisioning # Only used on systemd systems PID_FILE_DIR=/var/run/grafana diff --git a/packaging/deb/init.d/grafana-server b/packaging/deb/init.d/grafana-server index 44f29c3c6fd..567da94f881 100755 --- a/packaging/deb/init.d/grafana-server +++ b/packaging/deb/init.d/grafana-server @@ -33,8 +33,7 @@ DATA_DIR=/var/lib/grafana PLUGINS_DIR=/var/lib/grafana/plugins LOG_DIR=/var/log/grafana CONF_FILE=$CONF_DIR/grafana.ini -DATASOURCES_CFG_DIR=$CONF_DIR/datasources -DASHBOARDS_CFG_DIR=$CONF_DIR/dashboards +PROVISIONING_CFG_DIR=$CONF_DIR/provisioning MAX_OPEN_FILES=10000 PID_FILE=/var/run/$NAME.pid DAEMON=/usr/sbin/$NAME @@ -57,7 +56,7 @@ if [ -f "$DEFAULT" ]; then . "$DEFAULT" fi -DAEMON_OPTS="--pidfile=${PID_FILE} --config=${CONF_FILE} cfg:default.paths.datasources=$DATASOURCES_CFG_DIR cfg:default.paths.dashboards=$DASHBOARDS_CFG_DIR cfg:default.paths.data=${DATA_DIR} cfg:default.paths.logs=${LOG_DIR} cfg:default.paths.plugins=${PLUGINS_DIR}" +DAEMON_OPTS="--pidfile=${PID_FILE} --config=${CONF_FILE} cfg:default.paths.provisioning=$PROVISIONING_CFG_DIR cfg:default.paths.data=${DATA_DIR} cfg:default.paths.logs=${LOG_DIR} cfg:default.paths.plugins=${PLUGINS_DIR}" function checkUser() { if [ `id -u` -ne 0 ]; then diff --git a/packaging/deb/systemd/grafana-server.service b/packaging/deb/systemd/grafana-server.service index 10682a155ee..acd2a360a93 100644 --- a/packaging/deb/systemd/grafana-server.service +++ b/packaging/deb/systemd/grafana-server.service @@ -14,14 +14,13 @@ Restart=on-failure WorkingDirectory=/usr/share/grafana RuntimeDirectory=grafana RuntimeDirectoryMode=0750 -ExecStart=/usr/sbin/grafana-server \ - --config=${CONF_FILE} \ - --pidfile=${PID_FILE_DIR}/grafana-server.pid \ - cfg:default.paths.logs=${LOG_DIR} \ - cfg:default.paths.data=${DATA_DIR} \ - cfg:default.paths.plugins=${PLUGINS_DIR} \ - cfg:default.paths.datasources=${DATASOURCES_CFG_DIR} \ - cfg:default.paths.dashboards=${DASHBOARDS_CFG_DIR} +ExecStart=/usr/sbin/grafana-server \ + --config=${CONF_FILE} \ + --pidfile=${PID_FILE_DIR}/grafana-server.pid \ + cfg:default.paths.logs=${LOG_DIR} \ + cfg:default.paths.data=${DATA_DIR} \ + cfg:default.paths.plugins=${PLUGINS_DIR} \ + cfg:default.paths.provisioning=${PROVISIONING_CFG_DIR} LimitNOFILE=10000 diff --git a/packaging/rpm/control/postinst b/packaging/rpm/control/postinst index 68e556b7f2d..e75850f258e 100755 --- a/packaging/rpm/control/postinst +++ b/packaging/rpm/control/postinst @@ -45,10 +45,10 @@ if [ $1 -eq 1 ] ; then cp /usr/share/grafana/conf/ldap.toml /etc/grafana/ldap.toml fi - if [ ! -f $DATASOURCES_CFG_DIR ]; then - mkdir -p /etc/grafana/dashboards /etc/grafana/datasources - cp /usr/share/grafana/conf/dashboards/sample.yaml $DASHBOARDS_CFG_DIR/sample.yaml - cp /usr/share/grafana/conf/datasources/sample.yaml $DATASOURCES_CFG_DIR/sample.yaml + if [ ! -f $PROVISIONING_CFG_DIR ]; then + mkdir -p $PROVISIONING_CFG_DIR/dashboards $PROVISIONING_CFG_DIR/datasources + cp /usr/share/grafana/conf/provisioning/dashboards/sample.yaml $PROVISIONING_CFG_DIR/dashboards/sample.yaml + cp /usr/share/grafana/conf/provisioning/datasources/sample.yaml $PROVISIONING_CFG_DIR/datasources/sample.yaml fi # Set user permissions on /var/log/grafana, /var/lib/grafana diff --git a/packaging/rpm/init.d/grafana-server b/packaging/rpm/init.d/grafana-server index eb7d169bb0e..cefe212116c 100755 --- a/packaging/rpm/init.d/grafana-server +++ b/packaging/rpm/init.d/grafana-server @@ -32,8 +32,7 @@ DATA_DIR=/var/lib/grafana PLUGINS_DIR=/var/lib/grafana/plugins LOG_DIR=/var/log/grafana CONF_FILE=$CONF_DIR/grafana.ini -DATASOURCES_CFG_DIR=$CONF_DIR/datasources -DASHBOARDS_CFG_DIR=$CONF_DIR/dashboards +PROVISIONING_CFG_DIR=$CONF_DIR/provisioning MAX_OPEN_FILES=10000 PID_FILE=/var/run/$NAME.pid DAEMON=/usr/sbin/$NAME @@ -61,7 +60,7 @@ fi # overwrite settings from default file [ -e /etc/sysconfig/$NAME ] && . /etc/sysconfig/$NAME -DAEMON_OPTS="--pidfile=${PID_FILE} --config=${CONF_FILE} cfg:default.paths.datasources=$DATASOURCES_CFG_DIR cfg:default.paths.dashboards=$DASHBOARDS_CFG_DIR cfg:default.paths.data=${DATA_DIR} cfg:default.paths.logs=${LOG_DIR} cfg:default.paths.plugins=${PLUGINS_DIR}" +DAEMON_OPTS="--pidfile=${PID_FILE} --config=${CONF_FILE} cfg:default.paths.provisioning=$PROVISIONING_CFG_DIR cfg:default.paths.data=${DATA_DIR} cfg:default.paths.logs=${LOG_DIR} cfg:default.paths.plugins=${PLUGINS_DIR}" function isRunning() { status -p $PID_FILE $NAME > /dev/null 2>&1 diff --git a/packaging/rpm/sysconfig/grafana-server b/packaging/rpm/sysconfig/grafana-server index b1a59ae1b5f..eb77e62d774 100644 --- a/packaging/rpm/sysconfig/grafana-server +++ b/packaging/rpm/sysconfig/grafana-server @@ -18,9 +18,7 @@ RESTART_ON_UPGRADE=true PLUGINS_DIR=/var/lib/grafana/plugins -DATASOURCES_CFG_DIR=/etc/grafana/datasources - -DASHBOARDS_CFG_DIR=/etc/grafana/dashboards +PROVISIONING_CFG_DIR=/etc/grafana/provisioning # Only used on systemd systems PID_FILE_DIR=/var/run/grafana diff --git a/packaging/rpm/systemd/grafana-server.service b/packaging/rpm/systemd/grafana-server.service index e9c93baba6e..f228c8d8b14 100644 --- a/packaging/rpm/systemd/grafana-server.service +++ b/packaging/rpm/systemd/grafana-server.service @@ -14,14 +14,13 @@ Restart=on-failure WorkingDirectory=/usr/share/grafana RuntimeDirectory=grafana RuntimeDirectoryMode=0750 -ExecStart=/usr/sbin/grafana-server \ - --config=${CONF_FILE} \ - --pidfile=${PID_FILE_DIR}/grafana-server.pid \ - cfg:default.paths.logs=${LOG_DIR} \ - cfg:default.paths.data=${DATA_DIR} \ - cfg:default.paths.plugins=${PLUGINS_DIR} \ - cfg:default.paths.datasources=${DATASOURCES_CFG_DIR} \ - cfg:default.paths.dashboards=${DASHBOARDS_CFG_DIR} +ExecStart=/usr/sbin/grafana-server \ + --config=${CONF_FILE} \ + --pidfile=${PID_FILE_DIR}/grafana-server.pid \ + cfg:default.paths.logs=${LOG_DIR} \ + cfg:default.paths.data=${DATA_DIR} \ + cfg:default.paths.plugins=${PLUGINS_DIR} \ + cfg:default.paths.provisioning=${PROVISIONING_CFG_DIR} LimitNOFILE=10000 TimeoutStopSec=20 diff --git a/pkg/services/provisioning/provisioning.go b/pkg/services/provisioning/provisioning.go index aa3610b596f..b41ec37b797 100644 --- a/pkg/services/provisioning/provisioning.go +++ b/pkg/services/provisioning/provisioning.go @@ -2,6 +2,7 @@ package provisioning import ( "context" + "path" "path/filepath" "github.com/grafana/grafana/pkg/services/provisioning/dashboards" @@ -10,12 +11,14 @@ import ( ) func Init(ctx context.Context, homePath string, cfg *ini.File) error { - datasourcePath := makeAbsolute(cfg.Section("paths").Key("datasources").String(), homePath) + provisioningPath := makeAbsolute(cfg.Section("paths").Key("provisioning").String(), homePath) + + datasourcePath := path.Join(provisioningPath, "datasources") if err := datasources.Provision(datasourcePath); err != nil { return err } - dashboardPath := makeAbsolute(cfg.Section("paths").Key("dashboards").String(), homePath) + dashboardPath := path.Join(provisioningPath, "dashboards") _, err := dashboards.Provision(ctx, dashboardPath) if err != nil { return err diff --git a/pkg/setting/setting.go b/pkg/setting/setting.go index 69499c233fe..ef4a7c42e86 100644 --- a/pkg/setting/setting.go +++ b/pkg/setting/setting.go @@ -50,13 +50,12 @@ var ( BuildStamp int64 // Paths - LogsPath string - HomePath string - DataPath string - PluginsPath string - DatasourcesPath string - DashboardsPath string - CustomInitPath = "conf/custom.ini" + LogsPath string + HomePath string + DataPath string + PluginsPath string + ProvisioningPath string + CustomInitPath = "conf/custom.ini" // Log settings. LogModes []string @@ -475,9 +474,7 @@ func NewConfigContext(args *CommandLineArgs) error { Env = Cfg.Section("").Key("app_mode").MustString("development") InstanceName = Cfg.Section("").Key("instance_name").MustString("unknown_instance_name") PluginsPath = makeAbsolute(Cfg.Section("paths").Key("plugins").String(), HomePath) - DatasourcesPath = Cfg.Section("paths").Key("datasources").String() - DashboardsPath = Cfg.Section("paths").Key("dashboards").String() - + ProvisioningPath = makeAbsolute(Cfg.Section("paths").Key("provisioning").String(), HomePath) server := Cfg.Section("server") AppUrl, AppSubUrl = parseAppUrlAndSubUrl(server) @@ -672,6 +669,6 @@ func LogConfigurationInfo() { logger.Info("Path Data", "path", DataPath) logger.Info("Path Logs", "path", LogsPath) logger.Info("Path Plugins", "path", PluginsPath) - logger.Info("Path Datasources", "path", DatasourcesPath) + logger.Info("Path Provisioning", "path", ProvisioningPath) logger.Info("App mode " + Env) } From 5006f9e4c57ef2c66e5c5a5cb9111f5bfa4c7c3c Mon Sep 17 00:00:00 2001 From: bergquist Date: Thu, 7 Dec 2017 15:23:14 +0100 Subject: [PATCH 18/18] dashboards as cfg: update docs to use /provisioning --- conf/defaults.ini | 5 ----- conf/sample.ini | 12 ++---------- docs/sources/administration/provisioning.md | 19 ++++++++++++++++++- docs/sources/installation/configuration.md | 8 +++----- 4 files changed, 23 insertions(+), 21 deletions(-) diff --git a/conf/defaults.ini b/conf/defaults.ini index 6e099949af1..218c91608cc 100644 --- a/conf/defaults.ini +++ b/conf/defaults.ini @@ -391,11 +391,6 @@ facility = # Syslog tag. By default, the process' argv[0] is used. tag = -#################################### Dashboard JSON files ################ -[dashboards.json] -enabled = false -path = /var/lib/grafana/dashboards - #################################### Usage Quotas ######################## [quota] enabled = false diff --git a/conf/sample.ini b/conf/sample.ini index 44e6f0d4ca3..7107f8354d6 100644 --- a/conf/sample.ini +++ b/conf/sample.ini @@ -20,11 +20,8 @@ # Directory where grafana will automatically scan and look for plugins ;plugins = /var/lib/grafana/plugins -# Config files containing datasources that will be configured at startup -;datasources = conf/datasources - -# Config files containing folders to read dashboards from and insert into the database. -;dashboards = conf/dashboards +# folder that contains provisioning config files that grafana will apply on startup and while running. +; provisioning = conf/provisioning #################################### Server #################################### [server] @@ -370,11 +367,6 @@ log_queries = ;tag = -;#################################### Dashboard JSON files ########################## -[dashboards.json] -;enabled = false -;path = /var/lib/grafana/dashboards - #################################### Alerting ############################ [alerting] # Disable alerting engine & UI features diff --git a/docs/sources/administration/provisioning.md b/docs/sources/administration/provisioning.md index 0745794496f..3dd5c5fd1d3 100644 --- a/docs/sources/administration/provisioning.md +++ b/docs/sources/administration/provisioning.md @@ -74,7 +74,7 @@ Saltstack | [https://github.com/salt-formulas/salt-formula-grafana](https://gith > This feature is available from v5.0 -It's possible to manage datasources in Grafana by adding one or more yaml config files in the [`conf/datasources`](/installation/configuration/#datasources) directory. Each config file can contain a list of `datasources` that will be added or updated during start up. If the datasource already exists, Grafana will update it to match the configuration file. The config file can also contain a list of datasources that should be deleted. That list is called `delete_datasources`. Grafana will delete datasources listed in `delete_datasources` before inserting/updating those in the `datasource` list. +It's possible to manage datasources in Grafana by adding one or more yaml config files in the [`provisioning/datasources`](/installation/configuration/#provisioning) directory. Each config file can contain a list of `datasources` that will be added or updated during start up. If the datasource already exists, Grafana will update it to match the configuration file. The config file can also contain a list of datasources that should be deleted. That list is called `delete_datasources`. Grafana will delete datasources listed in `delete_datasources` before inserting/updating those in the `datasource` list. ### Running multiple grafana instances. If you are running multiple instances of Grafana you might run into problems if they have different versions of the datasource.yaml configuration file. The best way to solve this problem is to add a version number to each datasource in the configuration and increase it when you update the config. Grafana will only update datasources with the same or lower version number than specified in the config. That way old configs cannot overwrite newer configs if they restart at the same time. @@ -165,3 +165,20 @@ Secure json data is a map of settings that will be encrypted with [secret key](/ | tlsClientKey | string | *All* |TLS Client key for outgoing requests | | password | string | Postgre | password | | user | string | Postgre | user | + +### Dashboards + +It's possible to manage dashboards in Grafana by adding one or more yaml config files in the [`provisioning/dashboards`](/installation/configuration/#provisioning) directory. Each config file can contain a list of `dashboards providers` that will load dashboards into grafana. Currently we only support reading dashboards from file but we will add more providers in the future. + +The dashboard provider config file looks like this + +```yaml +- name: 'default' + org_id: 1 + folder: '' + type: file + options: + folder: /var/lib/grafana/dashboards +``` + +When grafana starts it will update/insert all dashboards available in the configured folders. If you modify the file the dashboard will also be updated. \ No newline at end of file diff --git a/docs/sources/installation/configuration.md b/docs/sources/installation/configuration.md index d454455a26b..1333c8c191d 100644 --- a/docs/sources/installation/configuration.md +++ b/docs/sources/installation/configuration.md @@ -91,12 +91,11 @@ file. Directory where grafana will automatically scan and look for plugins -### datasources +### provisioning > This feature is available in 5.0+ -Config files containing datasources that will be configured at startup. -You can read more about the config files at the [provisioning page](/administration/provisioning/#datasources). +Folder that contains [provisioning](/administration/provisioning) config files that grafana will apply on startup. Dashboards will be reloaded when the json files changes ## [server] @@ -635,8 +634,7 @@ Number dashboard versions to keep (per dashboard). Default: 20, Minimum: 1. ## [dashboards.json] -If you have a system that automatically builds dashboards as json files you can enable this feature to have the -Grafana backend index those json dashboards which will make them appear in regular dashboard search. +> This have been replaced with dashboards [provisioning](/administration/provisioning) in 5.0+ ### enabled `true` or `false`. Is disabled by default.