From 7010df0fe804ded726375752281adc6f45110bed Mon Sep 17 00:00:00 2001 From: Anthony Woods Date: Sat, 21 Mar 2015 07:14:13 +0800 Subject: [PATCH 01/12] fixes #1619 Secure PhantomJS Png rendering removes auth hack to allow phantomjs to query pages as a user without auth. Instead we pass phantomjs the session cookie, which it then includes in the request. --- pkg/api/render.go | 9 +++++---- pkg/components/renderer/renderer.go | 11 +++++++---- pkg/middleware/auth.go | 7 ------- vendor/phantomjs/render.js | 10 ++++++++-- 4 files changed, 20 insertions(+), 17 deletions(-) diff --git a/pkg/api/render.go b/pkg/api/render.go index 8649dfe4c6b..0398d455cc8 100644 --- a/pkg/api/render.go +++ b/pkg/api/render.go @@ -12,12 +12,13 @@ import ( func RenderToPng(c *middleware.Context) { queryReader := util.NewUrlQueryReader(c.Req.URL) - queryParams := fmt.Sprintf("?render=1&%s=%d&%s", middleware.SESS_KEY_USERID, c.UserId, c.Req.URL.RawQuery) + queryParams := fmt.Sprintf("?%s", c.Req.URL.RawQuery) renderOpts := &renderer.RenderOpts{ - Url: c.Params("*") + queryParams, - Width: queryReader.Get("width", "800"), - Height: queryReader.Get("height", "400"), + Url: c.Params("*") + queryParams, + Width: queryReader.Get("width", "800"), + Height: queryReader.Get("height", "400"), + SessionId: c.Session.ID(), } renderOpts.Url = setting.ToAbsUrl(renderOpts.Url) diff --git a/pkg/components/renderer/renderer.go b/pkg/components/renderer/renderer.go index cd8979a57bc..054632395ce 100644 --- a/pkg/components/renderer/renderer.go +++ b/pkg/components/renderer/renderer.go @@ -14,9 +14,10 @@ import ( ) type RenderOpts struct { - Url string - Width string - Height string + Url string + Width string + Height string + SessionId string } func RenderToPng(params *RenderOpts) (string, error) { @@ -26,7 +27,9 @@ func RenderToPng(params *RenderOpts) (string, error) { pngPath, _ := filepath.Abs(filepath.Join(setting.ImagesDir, getHash(params.Url))) pngPath = pngPath + ".png" - cmd := exec.Command(binPath, scriptPath, "url="+params.Url, "width="+params.Width, "height="+params.Height, "png="+pngPath) + cmd := exec.Command(binPath, scriptPath, "url="+params.Url, "width="+params.Width, + "height="+params.Height, "png="+pngPath, "cookiename="+setting.SessionOptions.CookieName, + "domain="+setting.Domain, "sessionid="+params.SessionId) stdout, err := cmd.StdoutPipe() if err != nil { diff --git a/pkg/middleware/auth.go b/pkg/middleware/auth.go index 7c8f8f30087..53b554942a6 100644 --- a/pkg/middleware/auth.go +++ b/pkg/middleware/auth.go @@ -22,13 +22,6 @@ func getRequestUserId(c *Context) int64 { return userId.(int64) } - // TODO: figure out a way to secure this - if c.Req.URL.Query().Get("render") == "1" { - userId := c.QueryInt64(SESS_KEY_USERID) - c.Session.Set(SESS_KEY_USERID, userId) - return userId - } - return 0 } diff --git a/vendor/phantomjs/render.js b/vendor/phantomjs/render.js index b8f91e1c73b..58afcd44eba 100644 --- a/vendor/phantomjs/render.js +++ b/vendor/phantomjs/render.js @@ -9,13 +9,19 @@ args.forEach(function(arg) { params[parts[1]] = parts[2]; }); -var usage = "url= png= width= height="; +var usage = "url= png= width= height= cookiename= sessionid= domain="; -if (!params.url || !params.png) { +if (!params.url || !params.png || !params.cookiename || ! params.sessionid || !params.domain) { console.log(usage); phantom.exit(); } +phantom.addCookie({ + 'name': params.cookiename, + 'value': params.sessionid, + 'domain': params.domain +}); + page.viewportSize = { width: params.width || '800', height: params.height || '400' From 245c6dbff00aa71fd778270db3f2d3a7b2cf8e65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Fri, 20 Mar 2015 22:01:39 -0400 Subject: [PATCH 02/12] Share Panel: The share modal now has an embed option, gives you an iframe that you can use to embedd a single graph on another web site, #1622 --- CHANGELOG.md | 1 + .../features/dashboard/dashboardNavCtrl.js | 2 +- .../dashboard/partials/shareDashboard.html | 48 ++++++++++++++ .../dashboard/partials/shareModal.html | 53 --------------- .../dashboard/partials/sharePanel.html | 65 +++++++++++++++++++ src/app/features/dashboard/sharePanelCtrl.js | 5 +- src/app/features/panel/panelSrv.js | 2 +- src/app/features/panel/soloPanelCtrl.js | 16 ++++- src/css/less/forms.less | 6 ++ src/test/specs/soloPanelCtrl-specs.js | 6 ++ 10 files changed, 146 insertions(+), 58 deletions(-) create mode 100644 src/app/features/dashboard/partials/shareDashboard.html delete mode 100644 src/app/features/dashboard/partials/shareModal.html create mode 100644 src/app/features/dashboard/partials/sharePanel.html diff --git a/CHANGELOG.md b/CHANGELOG.md index eb1ffcdecb9..15e1527ad8c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # 2.0.0 (unreleased) **New features** +- [Issue #1622](https://github.com/grafana/grafana/issues/1622). Share Panel: The share modal now has an embed option, gives you an iframe that you can use to embedd a single graph on another web site - [Issue #718](https://github.com/grafana/grafana/issues/718). Dashboard: When saving a dashboard and another user has made changes inbetween the user is promted with a warning if he really wants to overwrite the other's changes - [Issue #1331](https://github.com/grafana/grafana/issues/1331). Graph & Singlestat: New axis/unit format selector and more units (kbytes, Joule, Watt, eV), and new design for graph axis & grid tab and single stat options tab views - [Issue #1241](https://github.com/grafana/grafana/issues/1242). Timepicker: New option in timepicker (under dashboard settings), to change ``now`` to be for example ``now-1m``, usefull when you want to ignore last minute because it contains incomplete data diff --git a/src/app/features/dashboard/dashboardNavCtrl.js b/src/app/features/dashboard/dashboardNavCtrl.js index a47e19b561f..5950c504a3a 100644 --- a/src/app/features/dashboard/dashboardNavCtrl.js +++ b/src/app/features/dashboard/dashboardNavCtrl.js @@ -42,7 +42,7 @@ function (angular, _, moment) { $scope.shareDashboard = function() { $scope.appEvent('show-modal', { - src: './app/features/dashboard/partials/shareModal.html', + src: './app/features/dashboard/partials/shareDashboard.html', scope: $scope.$new(), }); }; diff --git a/src/app/features/dashboard/partials/shareDashboard.html b/src/app/features/dashboard/partials/shareDashboard.html new file mode 100644 index 00000000000..e052c5b298f --- /dev/null +++ b/src/app/features/dashboard/partials/shareDashboard.html @@ -0,0 +1,48 @@ +
+
+
+ + Share +
+ +
+
+
+
+ + +
+ +
+
+
+
+ +
+
+
+
+ +
+
+ +
+
+
+ + + + +
+ +
+
+ +
diff --git a/src/app/features/dashboard/partials/shareModal.html b/src/app/features/dashboard/partials/shareModal.html deleted file mode 100644 index a9707be94b1..00000000000 --- a/src/app/features/dashboard/partials/shareModal.html +++ /dev/null @@ -1,53 +0,0 @@ -
-
-
- - Share -
- -
-
-
-
- - -
- -
- -
-
-
- -
-
-
-
- -
-
-
-
- -
-
- -
-
-
- - - - -
- - -
-
diff --git a/src/app/features/dashboard/partials/sharePanel.html b/src/app/features/dashboard/partials/sharePanel.html new file mode 100644 index 00000000000..e56fe89be59 --- /dev/null +++ b/src/app/features/dashboard/partials/sharePanel.html @@ -0,0 +1,65 @@ +
+
+
+ + Share Panel +
+ +
+
+
+
+ + +
+ +
+
+
+
+ +
+
+
+
+ +
+
+ +
+
+
+ + + + +
+ +
+
+ +
+
IFrame embedding
+

The html code below can be pasted and included in another web page. Unless anonymous access + is enabled the user viewing that page need to be signed into grafana for the graph to load. + +

+
+
+ + + +
+ +
+
+
+
+
diff --git a/src/app/features/dashboard/sharePanelCtrl.js b/src/app/features/dashboard/sharePanelCtrl.js index eca10678806..40c7ba45a90 100644 --- a/src/app/features/dashboard/sharePanelCtrl.js +++ b/src/app/features/dashboard/sharePanelCtrl.js @@ -72,8 +72,11 @@ function (angular, _, require, config) { }); $scope.shareUrl = baseUrl + "?" + paramsArray.join('&'); - $scope.imageUrl = $scope.shareUrl.replace('/dashboard/db/', '/render/dashboard/solo/'); + $scope.soloUrl = $scope.shareUrl.replace('/dashboard/db/', '/dashboard/solo/'); + $scope.iframeHtml = ''; + + $scope.imageUrl = $scope.shareUrl.replace('/dashboard/db/', '/render/dashboard/solo/'); $scope.imageUrl += '&width=1000'; $scope.imageUrl += '&height=500'; }; diff --git a/src/app/features/panel/panelSrv.js b/src/app/features/panel/panelSrv.js index ec3373c3426..7ce3d69b376 100644 --- a/src/app/features/panel/panelSrv.js +++ b/src/app/features/panel/panelSrv.js @@ -26,7 +26,7 @@ function (angular, _, config) { $scope.sharePanel = function() { $scope.appEvent('show-modal', { - src: './app/features/dashboard/partials/shareModal.html', + src: './app/features/dashboard/partials/sharePanel.html', scope: $scope.$new() }); }; diff --git a/src/app/features/panel/soloPanelCtrl.js b/src/app/features/panel/soloPanelCtrl.js index 1d134a73827..c6a01d9ccfe 100644 --- a/src/app/features/panel/soloPanelCtrl.js +++ b/src/app/features/panel/soloPanelCtrl.js @@ -7,10 +7,22 @@ function (angular, $) { var module = angular.module('grafana.routes'); - module.controller('SoloPanelCtrl', function($scope, backendSrv, $routeParams, dashboardSrv, timeSrv, $location, templateValuesSrv) { + module.controller('SoloPanelCtrl', + function( + $scope, + backendSrv, + $routeParams, + dashboardSrv, + timeSrv, + $location, + templateValuesSrv, + contextSrv) { + var panelId; $scope.init = function() { + contextSrv.sidemenu = false; + var params = $location.search(); panelId = parseInt(params.panelId); @@ -26,7 +38,7 @@ function (angular, $) { $scope.dashboard = dashboardSrv.create(dashboard.model); $scope.row = { - height: $(window).height() + 'px', + height: ($(window).height() - 10) + 'px', }; $scope.test = "Hej"; diff --git a/src/css/less/forms.less b/src/css/less/forms.less index 2a6512dd882..eaceabc5834 100644 --- a/src/css/less/forms.less +++ b/src/css/less/forms.less @@ -46,5 +46,11 @@ input[type="checkbox"]:checked+label { height: 100%; box-sizing: border-box; } + textarea { + width: 100%; + padding: 5px 6px; + height: 100%; + box-sizing: border-box; + } } diff --git a/src/test/specs/soloPanelCtrl-specs.js b/src/test/specs/soloPanelCtrl-specs.js index 533f966a040..31b45c353f2 100644 --- a/src/test/specs/soloPanelCtrl-specs.js +++ b/src/test/specs/soloPanelCtrl-specs.js @@ -10,11 +10,13 @@ define([ var backendSrv = {}; var routeParams = {}; var search = {}; + var contextSrv = {}; beforeEach(module('grafana.routes')); beforeEach(module('grafana.services')); beforeEach(ctx.providePhase({ $routeParams: routeParams, + contextSrv: contextSrv, $location: { search: function() { return search; @@ -57,6 +59,10 @@ define([ expect(ctx.scope.panel.some).to.be('prop'); }); + it('should hide sidemenu', function() { + expect(contextSrv.sidemenu).to.be(false); + }); + }); }); From bf898138b7334051eac80b6327ba1186629c2394 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sat, 21 Mar 2015 12:08:29 -0400 Subject: [PATCH 03/12] Small update to drilldown link editor --- src/app/features/panellinkeditor/module.html | 36 +++++++++++++------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/src/app/features/panellinkeditor/module.html b/src/app/features/panellinkeditor/module.html index 7d79eff5a6b..4aacb6675fc 100644 --- a/src/app/features/panellinkeditor/module.html +++ b/src/app/features/panellinkeditor/module.html @@ -2,23 +2,23 @@
Drilldown / detail linkThese links appear in the dropdown menu in the panel menu.
-
+
    • -
  • title
    • +
  • Link title
    • -
  • type
    • +
  • Type
    • -
  • dashboard
    • +
  • Dashboard
    • -
  • url
    • +
  • Url
  • - -
    • - -
  • params - Use var-variableName=value to pass templating variables. -
    • -
  • - +
+ +
+ +
+
+
From 9bae19a7ec34add85a76ff381fb89ba7b56182eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sat, 21 Mar 2015 15:34:26 -0400 Subject: [PATCH 04/12] Small fix to logarithmic scale --- src/app/panels/graph/graph.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/app/panels/graph/graph.js b/src/app/panels/graph/graph.js index 9efe99dee87..5e8bcb2d964 100755 --- a/src/app/panels/graph/graph.js +++ b/src/app/panels/graph/graph.js @@ -396,8 +396,8 @@ function (angular, $, kbn, moment, _, GraphTooltip) { } } - axis.min = axis.min !== null ? axis.min : 1; - axis.ticks = [1]; + axis.min = axis.min !== null ? axis.min : 0; + axis.ticks = [0, 1]; var nextTick = 1; while (true) { @@ -409,10 +409,10 @@ function (angular, $, kbn, moment, _, GraphTooltip) { } if (axis.logBase === 10) { - axis.transform = function(v) { return Math.log(v+0.0001); }; + axis.transform = function(v) { return Math.log(v+0.1); }; axis.inverseTransform = function (v) { return Math.pow(10,v); }; } else { - axis.transform = function(v) { return Math.log(v+0.0001) / Math.log(axis.logBase); }; + axis.transform = function(v) { return Math.log(v+0.1) / Math.log(axis.logBase); }; axis.inverseTransform = function (v) { return Math.pow(axis.logBase,v); }; } } From 7d4293f849d6c8d32e4ee05df809823e2ca3a722 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sun, 22 Mar 2015 06:48:53 -0400 Subject: [PATCH 05/12] removed cli commands, need to be mobed to a seperate binary using http api, #1570 --- main.go | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/main.go b/main.go index f23a544e1e9..3b25b73039d 100644 --- a/main.go +++ b/main.go @@ -39,17 +39,7 @@ func main() { app.Name = "Grafana Backend" app.Usage = "grafana web" app.Version = version - app.Commands = []cli.Command{ - cmd.ListOrgs, - cmd.CreateOrg, - cmd.DeleteOrg, - cmd.ExportDashboard, - cmd.ImportDashboard, - cmd.ListDataSources, - cmd.CreateDataSource, - cmd.DescribeDataSource, - cmd.DeleteDataSource, - cmd.Web} + app.Commands = []cli.Command{cmd.ImportDashboard, cmd.Web} app.Flags = append(app.Flags, []cli.Flag{ cli.StringFlag{ Name: "config", From d987532262435937215e72664101257058d2057e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sun, 22 Mar 2015 15:14:00 -0400 Subject: [PATCH 06/12] Added server metrics --- conf/defaults.ini | 7 ++ pkg/api/admin_users.go | 3 + pkg/api/dashboard.go | 5 ++ pkg/api/index.go | 2 +- pkg/api/login.go | 4 +- pkg/api/login_oauth.go | 3 + pkg/api/org.go | 3 + pkg/api/signup.go | 3 + pkg/cmd/web.go | 5 ++ pkg/metrics/counter.go | 72 ++++++++++++++++++++ pkg/metrics/metric_ref.go | 39 +++++++++++ pkg/metrics/metrics.go | 25 +++++++ pkg/metrics/registry.go | 102 +++++++++++++++++++++++++++++ pkg/metrics/report_usage.go | 60 +++++++++++++++++ pkg/middleware/middleware.go | 12 ++++ pkg/models/stats.go | 11 ++++ pkg/services/sqlstore/dashboard.go | 2 + pkg/services/sqlstore/stats.go | 36 ++++++++++ pkg/setting/setting.go | 4 ++ 19 files changed, 396 insertions(+), 2 deletions(-) create mode 100644 pkg/metrics/counter.go create mode 100644 pkg/metrics/metric_ref.go create mode 100644 pkg/metrics/metrics.go create mode 100644 pkg/metrics/registry.go create mode 100644 pkg/metrics/report_usage.go create mode 100644 pkg/models/stats.go create mode 100644 pkg/services/sqlstore/stats.go diff --git a/conf/defaults.ini b/conf/defaults.ini index 5318e89b2ad..095457dd2a2 100644 --- a/conf/defaults.ini +++ b/conf/defaults.ini @@ -1,6 +1,13 @@ app_name = Grafana app_mode = production +# Once every 24 hours Grafana will report anonymous data to +# stats.grafana.org (https). No ip addresses are being tracked. +# only simple counters to track running instances, dashboard +# count and errors. It is very helpful to us. +# Change this option to false to disable reporting. +reporting-enabled = true + [server] ; protocol (http or https) protocol = http diff --git a/pkg/api/admin_users.go b/pkg/api/admin_users.go index d3fa111d333..f7e8fca2b5e 100644 --- a/pkg/api/admin_users.go +++ b/pkg/api/admin_users.go @@ -3,6 +3,7 @@ package api import ( "github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/metrics" "github.com/grafana/grafana/pkg/middleware" m "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/util" @@ -64,6 +65,8 @@ func AdminCreateUser(c *middleware.Context, form dtos.AdminCreateUserForm) { return } + metrics.M_Api_Admin_User_Create.Inc(1) + c.JsonOK("User created") } diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index 8cde5a8bc8a..278264f22d7 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -7,6 +7,7 @@ import ( "github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/metrics" "github.com/grafana/grafana/pkg/middleware" m "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/setting" @@ -27,6 +28,8 @@ func isDasboardStarredByUser(c *middleware.Context, dashId int64) (bool, error) } func GetDashboard(c *middleware.Context) { + metrics.M_Api_Dashboard_Get.Inc(1) + slug := c.Params(":slug") query := m.GetDashboardQuery{Slug: slug, OrgId: c.OrgId} @@ -88,6 +91,8 @@ func PostDashboard(c *middleware.Context, cmd m.SaveDashboardCommand) { return } + metrics.M_Api_Dashboard_Post.Inc(1) + c.JSON(200, util.DynMap{"status": "success", "slug": cmd.Result.Slug, "version": cmd.Result.Version}) } diff --git a/pkg/api/index.go b/pkg/api/index.go index 3006c54e8ab..4af66f18133 100644 --- a/pkg/api/index.go +++ b/pkg/api/index.go @@ -47,7 +47,7 @@ func Index(c *middleware.Context) { func NotFound(c *middleware.Context) { if c.IsApiRequest() { - c.JsonApiErr(200, "Not found", nil) + c.JsonApiErr(404, "Not found", nil) return } diff --git a/pkg/api/login.go b/pkg/api/login.go index e7707c53138..56a61697cb9 100644 --- a/pkg/api/login.go +++ b/pkg/api/login.go @@ -6,6 +6,7 @@ import ( "github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/log" + "github.com/grafana/grafana/pkg/metrics" "github.com/grafana/grafana/pkg/middleware" m "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/setting" @@ -75,7 +76,6 @@ func LoginView(c *middleware.Context) { } func LoginPost(c *middleware.Context, cmd dtos.LoginCommand) { - userQuery := m.GetUserByLoginQuery{LoginOrEmail: cmd.User} err := bus.Dispatch(&userQuery) @@ -112,6 +112,8 @@ func LoginPost(c *middleware.Context, cmd dtos.LoginCommand) { c.SetCookie("redirect_to", "", -1, setting.AppSubUrl+"/") } + metrics.M_Api_Login_Post.Inc(1) + c.JSON(200, result) } diff --git a/pkg/api/login_oauth.go b/pkg/api/login_oauth.go index 9ccb8f0b60d..a234ef02bf3 100644 --- a/pkg/api/login_oauth.go +++ b/pkg/api/login_oauth.go @@ -8,6 +8,7 @@ import ( "github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/log" + "github.com/grafana/grafana/pkg/metrics" "github.com/grafana/grafana/pkg/middleware" m "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/setting" @@ -81,5 +82,7 @@ func OAuthLogin(ctx *middleware.Context) { // login loginUserWithUser(userQuery.Result, ctx) + metrics.M_Api_Login_OAuth.Inc(1) + ctx.Redirect(setting.AppSubUrl + "/") } diff --git a/pkg/api/org.go b/pkg/api/org.go index 8b41b0e3f5f..ed180b1af77 100644 --- a/pkg/api/org.go +++ b/pkg/api/org.go @@ -2,6 +2,7 @@ package api import ( "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/metrics" "github.com/grafana/grafana/pkg/middleware" m "github.com/grafana/grafana/pkg/models" ) @@ -35,6 +36,8 @@ func CreateOrg(c *middleware.Context, cmd m.CreateOrgCommand) { return } + metrics.M_Api_Org_Create.Inc(1) + c.JsonOK("Organization created") } diff --git a/pkg/api/signup.go b/pkg/api/signup.go index 74f00509b98..63bb34c72ac 100644 --- a/pkg/api/signup.go +++ b/pkg/api/signup.go @@ -2,6 +2,7 @@ package api import ( "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/metrics" "github.com/grafana/grafana/pkg/middleware" m "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/setting" @@ -26,4 +27,6 @@ func SignUp(c *middleware.Context, cmd m.CreateUserCommand) { loginUserWithUser(&user, c) c.JsonOK("User created and logged in") + + metrics.M_Api_User_SignUp.Inc(1) } diff --git a/pkg/cmd/web.go b/pkg/cmd/web.go index 6619e5b1e0e..e5516fb52d9 100644 --- a/pkg/cmd/web.go +++ b/pkg/cmd/web.go @@ -21,6 +21,7 @@ import ( "github.com/grafana/grafana/pkg/api" "github.com/grafana/grafana/pkg/log" + "github.com/grafana/grafana/pkg/metrics" "github.com/grafana/grafana/pkg/middleware" "github.com/grafana/grafana/pkg/plugins" "github.com/grafana/grafana/pkg/services/eventpublisher" @@ -88,6 +89,10 @@ func runWeb(c *cli.Context) { m := newMacaron() api.Register(m) + if setting.ReportingEnabled { + go metrics.StartUsageReportLoop() + } + listenAddr := fmt.Sprintf("%s:%s", setting.HttpAddr, setting.HttpPort) log.Info("Listen: %v://%s%s", setting.Protocol, listenAddr, setting.AppSubUrl) switch setting.Protocol { diff --git a/pkg/metrics/counter.go b/pkg/metrics/counter.go new file mode 100644 index 00000000000..1a4a88be37b --- /dev/null +++ b/pkg/metrics/counter.go @@ -0,0 +1,72 @@ +package metrics + +import "sync/atomic" + +// Counters hold an int64 value that can be incremented and decremented. +type Counter interface { + Clear() + Count() int64 + Dec(int64) + Inc(int64) + Snapshot() Counter +} + +// NewCounter constructs a new StandardCounter. +func NewCounter() Counter { + return &StandardCounter{0} +} + +// CounterSnapshot is a read-only copy of another Counter. +type CounterSnapshot int64 + +// Clear panics. +func (CounterSnapshot) Clear() { + panic("Clear called on a CounterSnapshot") +} + +// Count returns the count at the time the snapshot was taken. +func (c CounterSnapshot) Count() int64 { return int64(c) } + +// Dec panics. +func (CounterSnapshot) Dec(int64) { + panic("Dec called on a CounterSnapshot") +} + +// Inc panics. +func (CounterSnapshot) Inc(int64) { + panic("Inc called on a CounterSnapshot") +} + +// Snapshot returns the snapshot. +func (c CounterSnapshot) Snapshot() Counter { return c } + +// StandardCounter is the standard implementation of a Counter and uses the +// sync/atomic package to manage a single int64 value. +type StandardCounter struct { + count int64 +} + +// Clear sets the counter to zero. +func (c *StandardCounter) Clear() { + atomic.StoreInt64(&c.count, 0) +} + +// Count returns the current count. +func (c *StandardCounter) Count() int64 { + return atomic.LoadInt64(&c.count) +} + +// Dec decrements the counter by the given amount. +func (c *StandardCounter) Dec(i int64) { + atomic.AddInt64(&c.count, -i) +} + +// Inc increments the counter by the given amount. +func (c *StandardCounter) Inc(i int64) { + atomic.AddInt64(&c.count, i) +} + +// Snapshot returns a read-only copy of the counter. +func (c *StandardCounter) Snapshot() Counter { + return CounterSnapshot(c.Count()) +} diff --git a/pkg/metrics/metric_ref.go b/pkg/metrics/metric_ref.go new file mode 100644 index 00000000000..f9e5d693d4c --- /dev/null +++ b/pkg/metrics/metric_ref.go @@ -0,0 +1,39 @@ +package metrics + +type comboCounterRef struct { + usageCounter Counter + metricCounter Counter +} + +func NewComboCounterRef(name string) Counter { + cr := &comboCounterRef{} + cr.usageCounter = UsageStats.GetOrRegister(name, NewCounter).(Counter) + cr.metricCounter = MetricStats.GetOrRegister(name, NewCounter).(Counter) + return cr +} + +func (c comboCounterRef) Clear() { + c.usageCounter.Clear() + c.metricCounter.Clear() +} + +func (c comboCounterRef) Count() int64 { + panic("Count called on a combocounter ref") +} + +// Dec panics. +func (c comboCounterRef) Dec(i int64) { + c.usageCounter.Dec(i) + c.metricCounter.Dec(i) +} + +// Inc panics. +func (c comboCounterRef) Inc(i int64) { + c.usageCounter.Inc(i) + c.metricCounter.Inc(i) +} + +// Snapshot returns the snapshot. +func (c comboCounterRef) Snapshot() Counter { + panic("snapshot called on a combocounter ref") +} diff --git a/pkg/metrics/metrics.go b/pkg/metrics/metrics.go new file mode 100644 index 00000000000..45b964fb56e --- /dev/null +++ b/pkg/metrics/metrics.go @@ -0,0 +1,25 @@ +package metrics + +var UsageStats = NewRegistry() +var MetricStats = NewRegistry() + +var ( + M_Instance_Start = NewComboCounterRef("instance.start") + + M_Page_Status_200 = NewComboCounterRef("page.status.200") + M_Page_Status_500 = NewComboCounterRef("page.status.500") + M_Page_Status_404 = NewComboCounterRef("page.status.404") + + M_Api_Status_500 = NewComboCounterRef("api.status.500") + M_Api_Status_404 = NewComboCounterRef("api.status.404") + + M_Api_User_SignUp = NewComboCounterRef("api.user.signup") + M_Api_Dashboard_Get = NewComboCounterRef("api.dashboard.get") + M_Api_Dashboard_Post = NewComboCounterRef("api.dashboard.post") + M_Api_Admin_User_Create = NewComboCounterRef("api.admin.user_create") + M_Api_Login_Post = NewComboCounterRef("api.login.post") + M_Api_Login_OAuth = NewComboCounterRef("api.login.oauth") + M_Api_Org_Create = NewComboCounterRef("api.org.create") + + M_Models_Dashboard_Insert = NewComboCounterRef("models.dashboard.insert") +) diff --git a/pkg/metrics/registry.go b/pkg/metrics/registry.go new file mode 100644 index 00000000000..9e1618f3691 --- /dev/null +++ b/pkg/metrics/registry.go @@ -0,0 +1,102 @@ +package metrics + +import ( + "fmt" + "reflect" + "sync" +) + +// DuplicateMetric is the error returned by Registry.Register when a metric +// already exists. If you mean to Register that metric you must first +// Unregister the existing metric. +type DuplicateMetric string + +func (err DuplicateMetric) Error() string { + return fmt.Sprintf("duplicate metric: %s", string(err)) +} + +type Registry interface { + // Call the given function for each registered metric. + Each(func(string, interface{})) + + // Get the metric by the given name or nil if none is registered. + Get(string) interface{} + + // Gets an existing metric or registers the given one. + // The interface can be the metric to register if not found in registry, + // or a function returning the metric for lazy instantiation. + GetOrRegister(string, interface{}) interface{} + + // Register the given metric under the given name. + Register(string, interface{}) error +} + +// The standard implementation of a Registry is a mutex-protected map +// of names to metrics. +type StandardRegistry struct { + metrics map[string]interface{} + mutex sync.Mutex +} + +// Create a new registry. +func NewRegistry() Registry { + return &StandardRegistry{metrics: make(map[string]interface{})} +} + +// Call the given function for each registered metric. +func (r *StandardRegistry) Each(f func(string, interface{})) { + for name, i := range r.registered() { + f(name, i) + } +} + +// Get the metric by the given name or nil if none is registered. +func (r *StandardRegistry) Get(name string) interface{} { + r.mutex.Lock() + defer r.mutex.Unlock() + return r.metrics[name] +} + +// Gets an existing metric or creates and registers a new one. Threadsafe +// alternative to calling Get and Register on failure. +// The interface can be the metric to register if not found in registry, +// or a function returning the metric for lazy instantiation. +func (r *StandardRegistry) GetOrRegister(name string, i interface{}) interface{} { + r.mutex.Lock() + defer r.mutex.Unlock() + if metric, ok := r.metrics[name]; ok { + return metric + } + if v := reflect.ValueOf(i); v.Kind() == reflect.Func { + i = v.Call(nil)[0].Interface() + } + r.register(name, i) + return i +} + +// Register the given metric under the given name. Returns a DuplicateMetric +// if a metric by the given name is already registered. +func (r *StandardRegistry) Register(name string, i interface{}) error { + r.mutex.Lock() + defer r.mutex.Unlock() + return r.register(name, i) +} + +func (r *StandardRegistry) register(name string, i interface{}) error { + if _, ok := r.metrics[name]; ok { + return DuplicateMetric(name) + } + + r.metrics[name] = i + return nil +} + +func (r *StandardRegistry) registered() map[string]interface{} { + metrics := make(map[string]interface{}, len(r.metrics)) + r.mutex.Lock() + defer r.mutex.Unlock() + for name, i := range r.metrics { + metrics[name] = i + } + return metrics +} diff --git a/pkg/metrics/report_usage.go b/pkg/metrics/report_usage.go new file mode 100644 index 00000000000..af6552b5c1e --- /dev/null +++ b/pkg/metrics/report_usage.go @@ -0,0 +1,60 @@ +package metrics + +import ( + "bytes" + "encoding/json" + "net/http" + "time" + + "github.com/grafana/grafana/pkg/log" + "github.com/grafana/grafana/pkg/setting" +) + +func StartUsageReportLoop() chan struct{} { + M_Instance_Start.Inc(1) + + ticker := time.NewTicker(10 * time.Minute) + for { + select { + case <-ticker.C: + sendUsageStats() + } + } +} + +func sendUsageStats() { + log.Trace("Sending anonymous usage stats to stats.grafana.org") + + metrics := map[string]interface{}{} + report := map[string]interface{}{ + "version": setting.BuildVersion, + "metrics": metrics, + } + + // statsQuery := m.GetSystemStatsQuery{} + // if err := bus.Dispatch(&statsQuery); err != nil { + // log.Error(3, "Failed to get system stats", err) + // return + // } + + UsageStats.Each(func(name string, i interface{}) { + switch metric := i.(type) { + case Counter: + if metric.Count() > 0 { + metrics[name+".count"] = metric.Count() + metric.Clear() + } + } + }) + + // metrics["stats.dashboards.count"] = statsQuery.Result.DashboardCount + // metrics["stats.users.count"] = statsQuery.Result.UserCount + // metrics["stats.orgs.count"] = statsQuery.Result.OrgCount + + out, _ := json.Marshal(report) + data := bytes.NewBuffer(out) + + client := http.Client{Timeout: time.Duration(5 * time.Second)} + + go client.Post("http://stats.grafana.org/grafana-usage-report", "application/json", data) +} diff --git a/pkg/middleware/middleware.go b/pkg/middleware/middleware.go index a15fd075fca..20e1eb196e5 100644 --- a/pkg/middleware/middleware.go +++ b/pkg/middleware/middleware.go @@ -10,6 +10,7 @@ import ( "github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/components/apikeygen" "github.com/grafana/grafana/pkg/log" + "github.com/grafana/grafana/pkg/metrics" m "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/setting" ) @@ -99,6 +100,15 @@ func (ctx *Context) Handle(status int, title string, err error) { } } + switch status { + case 200: + metrics.M_Page_Status_200.Inc(1) + case 404: + metrics.M_Page_Status_404.Inc(1) + case 500: + metrics.M_Page_Status_500.Inc(1) + } + ctx.Data["Title"] = title ctx.HTML(status, strconv.Itoa(status)) } @@ -128,7 +138,9 @@ func (ctx *Context) JsonApiErr(status int, message string, err error) { switch status { case 404: resp["message"] = "Not Found" + metrics.M_Api_Status_500.Inc(1) case 500: + metrics.M_Api_Status_404.Inc(1) resp["message"] = "Internal Server Error" } diff --git a/pkg/models/stats.go b/pkg/models/stats.go new file mode 100644 index 00000000000..0d83882e666 --- /dev/null +++ b/pkg/models/stats.go @@ -0,0 +1,11 @@ +package models + +type SystemStats struct { + DashboardCount int + UserCount int + OrgCount int +} + +type GetSystemStatsQuery struct { + Result *SystemStats +} diff --git a/pkg/services/sqlstore/dashboard.go b/pkg/services/sqlstore/dashboard.go index bf748b600f4..0384a5bb6e6 100644 --- a/pkg/services/sqlstore/dashboard.go +++ b/pkg/services/sqlstore/dashboard.go @@ -6,6 +6,7 @@ import ( "github.com/go-xorm/xorm" "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/metrics" m "github.com/grafana/grafana/pkg/models" ) @@ -48,6 +49,7 @@ func SaveDashboard(cmd *m.SaveDashboardCommand) error { } if dash.Id == 0 { + metrics.M_Models_Dashboard_Insert.Inc(1) _, err = sess.Insert(dash) } else { dash.Version += 1 diff --git a/pkg/services/sqlstore/stats.go b/pkg/services/sqlstore/stats.go new file mode 100644 index 00000000000..7995dd43f38 --- /dev/null +++ b/pkg/services/sqlstore/stats.go @@ -0,0 +1,36 @@ +package sqlstore + +import ( + "github.com/grafana/grafana/pkg/bus" + m "github.com/grafana/grafana/pkg/models" +) + +func init() { + bus.AddHandler("sql", GetSystemStats) +} + +func GetSystemStats(query *m.GetSystemStatsQuery) error { + var rawSql = `SELECT + ( + SELECT COUNT(*) + FROM ` + dialect.Quote("user") + ` + ) AS user_count, + ( + SELECT COUNT(*) + FROM ` + dialect.Quote("org") + ` + ) AS org_count, + ( + SELECT COUNT(*) + FROM ` + dialect.Quote("dashboard") + ` + ) AS dashboard_count + ` + + var stats m.SystemStats + _, err := x.Sql(rawSql).Get(&stats) + if err != nil { + return err + } + + query.Result = &stats + return err +} diff --git a/pkg/setting/setting.go b/pkg/setting/setting.go index b8d038dbc29..defa8311e8c 100644 --- a/pkg/setting/setting.go +++ b/pkg/setting/setting.go @@ -96,6 +96,8 @@ var ( PhantomDir string configFiles []string + + ReportingEnabled bool ) func init() { @@ -233,6 +235,8 @@ func NewConfigContext(config string) { ImagesDir = "data/png" PhantomDir = "vendor/phantomjs" + ReportingEnabled = Cfg.Section("").Key("reporting-enabled").MustBool(true) + readSessionConfig() } From 9c9ebb49875941805e9e2e71284dcb30afdd13a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sun, 22 Mar 2015 15:24:35 -0400 Subject: [PATCH 07/12] Updated server stats --- pkg/metrics/report_usage.go | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/pkg/metrics/report_usage.go b/pkg/metrics/report_usage.go index af6552b5c1e..1887f7f60a9 100644 --- a/pkg/metrics/report_usage.go +++ b/pkg/metrics/report_usage.go @@ -6,7 +6,6 @@ import ( "net/http" "time" - "github.com/grafana/grafana/pkg/log" "github.com/grafana/grafana/pkg/setting" ) @@ -23,8 +22,6 @@ func StartUsageReportLoop() chan struct{} { } func sendUsageStats() { - log.Trace("Sending anonymous usage stats to stats.grafana.org") - metrics := map[string]interface{}{} report := map[string]interface{}{ "version": setting.BuildVersion, @@ -56,5 +53,5 @@ func sendUsageStats() { client := http.Client{Timeout: time.Duration(5 * time.Second)} - go client.Post("http://stats.grafana.org/grafana-usage-report", "application/json", data) + go client.Post("https://stats.grafana.org/grafana-usage-report", "application/json", data) } From c67291da33a1f3a9ecbd54c3f54e2e3b24e864ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sun, 22 Mar 2015 15:25:21 -0400 Subject: [PATCH 08/12] Updated --- conf/sample.ini | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/conf/sample.ini b/conf/sample.ini index 4e4c335ae18..a51600a606d 100644 --- a/conf/sample.ini +++ b/conf/sample.ini @@ -5,6 +5,13 @@ app_mode = production +# Once every 24 hours Grafana will report anonymous data to +# stats.grafana.org (https). No ip addresses are being tracked. +# only simple counters to track running instances, dashboard +# count and errors. It is very helpful to us. +# Change this option to false to disable reporting. +reporting-enabled = true + [server] ; protocol (http or https) protocol = http From 526f3e1a314248430fa7e18ae94fc71dd6822a62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sun, 22 Mar 2015 15:27:05 -0400 Subject: [PATCH 09/12] Fixed failing unit test --- src/test/specs/graph-specs.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/test/specs/graph-specs.js b/src/test/specs/graph-specs.js index 7e870bfd7d0..a234323ee01 100644 --- a/src/test/specs/graph-specs.js +++ b/src/test/specs/graph-specs.js @@ -153,9 +153,9 @@ define([ it('should apply axis transform and ticks', function() { var axis = ctx.plotOptions.yaxes[0]; - expect(axis.transform(100)).to.be(Math.log(100+0.0001)); - expect(axis.ticks[0]).to.be(1); - expect(axis.ticks[1]).to.be(10); + expect(axis.transform(100)).to.be(Math.log(100+0.1)); + expect(axis.ticks[0]).to.be(0); + expect(axis.ticks[1]).to.be(1); }); }); From 1e4c62a70d12f3cc9027691cee9dc66b76d5b540 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sun, 22 Mar 2015 15:45:13 -0400 Subject: [PATCH 10/12] updated server reporting --- pkg/metrics/report_usage.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pkg/metrics/report_usage.go b/pkg/metrics/report_usage.go index 1887f7f60a9..e5cbf7a45f1 100644 --- a/pkg/metrics/report_usage.go +++ b/pkg/metrics/report_usage.go @@ -6,13 +6,14 @@ import ( "net/http" "time" + "github.com/grafana/grafana/pkg/log" "github.com/grafana/grafana/pkg/setting" ) func StartUsageReportLoop() chan struct{} { M_Instance_Start.Inc(1) - ticker := time.NewTicker(10 * time.Minute) + ticker := time.NewTicker(24 * time.Hour) for { select { case <-ticker.C: @@ -22,6 +23,8 @@ func StartUsageReportLoop() chan struct{} { } func sendUsageStats() { + log.Trace("Sending anonymous usage stats to stats.grafana.org") + metrics := map[string]interface{}{} report := map[string]interface{}{ "version": setting.BuildVersion, From a26436f59bae959087fba7c506e4312cb47aec1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sun, 22 Mar 2015 16:13:16 -0400 Subject: [PATCH 11/12] Server metrics fix --- pkg/metrics/report_usage.go | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/pkg/metrics/report_usage.go b/pkg/metrics/report_usage.go index e5cbf7a45f1..b31b55333cc 100644 --- a/pkg/metrics/report_usage.go +++ b/pkg/metrics/report_usage.go @@ -4,6 +4,7 @@ import ( "bytes" "encoding/json" "net/http" + "strings" "time" "github.com/grafana/grafana/pkg/log" @@ -13,7 +14,7 @@ import ( func StartUsageReportLoop() chan struct{} { M_Instance_Start.Inc(1) - ticker := time.NewTicker(24 * time.Hour) + ticker := time.NewTicker(10 * time.Minute) for { select { case <-ticker.C: @@ -25,9 +26,11 @@ func StartUsageReportLoop() chan struct{} { func sendUsageStats() { log.Trace("Sending anonymous usage stats to stats.grafana.org") + version := strings.Replace(setting.BuildVersion, ".", "_", -1) + metrics := map[string]interface{}{} report := map[string]interface{}{ - "version": setting.BuildVersion, + "version": version, "metrics": metrics, } From 44bc2b2d56423c3b25283bb3d0c4721d91441a70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sun, 22 Mar 2015 16:30:28 -0400 Subject: [PATCH 12/12] Updated conf description, metrics interval --- conf/defaults.ini | 2 +- conf/sample.ini | 4 ++-- pkg/metrics/report_usage.go | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/conf/defaults.ini b/conf/defaults.ini index 095457dd2a2..d35f71fa4ce 100644 --- a/conf/defaults.ini +++ b/conf/defaults.ini @@ -1,7 +1,7 @@ app_name = Grafana app_mode = production -# Once every 24 hours Grafana will report anonymous data to +# Once every 1 hour Grafana will report anonymous data to # stats.grafana.org (https). No ip addresses are being tracked. # only simple counters to track running instances, dashboard # count and errors. It is very helpful to us. diff --git a/conf/sample.ini b/conf/sample.ini index a51600a606d..f7207668c8f 100644 --- a/conf/sample.ini +++ b/conf/sample.ini @@ -5,10 +5,10 @@ app_mode = production -# Once every 24 hours Grafana will report anonymous data to +# Once every 1 hour Grafana will report anonymous data to # stats.grafana.org (https). No ip addresses are being tracked. # only simple counters to track running instances, dashboard -# count and errors. It is very helpful to us. +# counts and errors. It is very helpful to us. # Change this option to false to disable reporting. reporting-enabled = true diff --git a/pkg/metrics/report_usage.go b/pkg/metrics/report_usage.go index b31b55333cc..f952e56fab6 100644 --- a/pkg/metrics/report_usage.go +++ b/pkg/metrics/report_usage.go @@ -14,7 +14,7 @@ import ( func StartUsageReportLoop() chan struct{} { M_Instance_Start.Inc(1) - ticker := time.NewTicker(10 * time.Minute) + ticker := time.NewTicker(time.Hour) for { select { case <-ticker.C: