Stats: Use more efficient SQL and add timeouts (#27390)

pkg/services/sqlstore/stats.go

@@ -14,7 +14,7 @@ func init() {
 	bus.AddHandler("sql", GetDataSourceStats)
 	bus.AddHandler("sql", GetDataSourceStats)
 	bus.AddHandler("sql", GetDataSourceAccessStats)
 	bus.AddHandler("sql", GetDataSourceAccessStats)
 	bus.AddHandler("sql", GetAdminStats)
 	bus.AddHandler("sql", GetAdminStats)
-	bus.AddHandler("sql", GetUserStats)
+	bus.AddHandlerCtx("sql", GetUserStats)
 	bus.AddHandlerCtx("sql", GetAlertNotifiersUsageStats)
 	bus.AddHandlerCtx("sql", GetAlertNotifiersUsageStats)
 	bus.AddHandlerCtx("sql", GetSystemUserCountStats)
 	bus.AddHandlerCtx("sql", GetSystemUserCountStats)
 }
 }
@@ -95,7 +95,10 @@ func GetSystemStats(query *models.GetSystemStatsQuery) error {
 }
 }
 
 
 func roleCounterSQL() string {
 func roleCounterSQL() string {
-	_ = updateUserRoleCountsIfNecessary(false)
+	const roleCounterTimeout = 20 * time.Second
+	ctx, cancel := context.WithTimeout(context.Background(), roleCounterTimeout)
+	defer cancel()
+	_ = updateUserRoleCountsIfNecessary(ctx, false)
 	sqlQuery :=
 	sqlQuery :=
 		strconv.FormatInt(userStatsCache.total.Admins, 10) + ` AS admins, ` +
 		strconv.FormatInt(userStatsCache.total.Admins, 10) + ` AS admins, ` +
 			strconv.FormatInt(userStatsCache.total.Editors, 10) + ` AS editors, ` +
 			strconv.FormatInt(userStatsCache.total.Editors, 10) + ` AS editors, ` +
@@ -182,8 +185,8 @@ func GetSystemUserCountStats(ctx context.Context, query *models.GetSystemUserCou
 	})
 	})
 }
 }
 
 
-func GetUserStats(query *models.GetUserStatsQuery) error {
-	err := updateUserRoleCountsIfNecessary(query.MustUpdate)
+func GetUserStats(ctx context.Context, query *models.GetUserStatsQuery) error {
+	err := updateUserRoleCountsIfNecessary(ctx, query.MustUpdate)
 	if err != nil {
 	if err != nil {
 		return err
 		return err
 	}
 	}
@@ -197,10 +200,10 @@ func GetUserStats(query *models.GetUserStatsQuery) error {
 	return nil
 	return nil
 }
 }
 
 
-func updateUserRoleCountsIfNecessary(forced bool) error {
+func updateUserRoleCountsIfNecessary(ctx context.Context, forced bool) error {
 	memoizationPeriod := time.Now().Add(-userStatsCacheLimetime)
 	memoizationPeriod := time.Now().Add(-userStatsCacheLimetime)
 	if forced || userStatsCache.memoized.Before(memoizationPeriod) {
 	if forced || userStatsCache.memoized.Before(memoizationPeriod) {
-		err := updateUserRoleCounts()
+		err := updateUserRoleCounts(ctx)
 		if err != nil {
 		if err != nil {
 			return err
 			return err
 		}
 		}
@@ -220,21 +223,21 @@ var (
 	userStatsCacheLimetime = 5 * time.Minute
 	userStatsCacheLimetime = 5 * time.Minute
 )
 )
 
 
-func updateUserRoleCounts() error {
+func updateUserRoleCounts(ctx context.Context) error {
 	query := `
 	query := `
 SELECT role AS bitrole, active, COUNT(role) AS count FROM
 SELECT role AS bitrole, active, COUNT(role) AS count FROM
-    (SELECT active, SUM(role) AS role
-     FROM (SELECT
-               u.id,
-               CASE org_user.role
-                   WHEN 'Admin' THEN 4
-                   WHEN 'Editor' THEN 2
-                   ELSE 1
-                   END AS role,
-               u.last_seen_at>? AS active
-           FROM ` + dialect.Quote("user") + ` AS u LEFT JOIN org_user ON org_user.user_id = u.id
-           GROUP BY u.id, u.last_seen_at, org_user.role) AS t2
-     GROUP BY active, id) AS t1
+  (SELECT last_seen_at>? AS active, SUM(role) AS role
+   FROM (SELECT
+      u.id,
+      CASE org_user.role
+        WHEN 'Admin' THEN 4
+        WHEN 'Editor' THEN 2
+        ELSE 1
+      END AS role,
+      u.last_seen_at
+    FROM ` + dialect.Quote("user") + ` AS u INNER JOIN org_user ON org_user.user_id = u.id
+    GROUP BY u.id, u.last_seen_at, org_user.role) AS t2
+  GROUP BY id, last_seen_at) AS t1
 GROUP BY active, role;`
 GROUP BY active, role;`
 
 
 	activeUserDeadline := time.Now().Add(-activeUserTimeLimit)
 	activeUserDeadline := time.Now().Add(-activeUserTimeLimit)
@@ -246,7 +249,7 @@ GROUP BY active, role;`
 	}
 	}
 
 
 	bitmap := []rolebitmap{}
 	bitmap := []rolebitmap{}
-	err := x.SQL(query, activeUserDeadline).Find(&bitmap)
+	err := x.Context(ctx).SQL(query, activeUserDeadline).Find(&bitmap)
 	if err != nil {
 	if err != nil {
 		return err
 		return err
 	}
 	}

pkg/services/sqlstore/stats_integration_test.go

@@ -6,6 +6,7 @@ import (
 	"context"
 	"context"
 	"fmt"
 	"fmt"
 	"testing"
 	"testing"
+	"time"
 
 
 	"github.com/grafana/grafana/pkg/models"
 	"github.com/grafana/grafana/pkg/models"
 	"github.com/grafana/grafana/pkg/setting"
 	"github.com/grafana/grafana/pkg/setting"
@@ -51,7 +52,8 @@ func TestIntegration_GetUserStats(t *testing.T) {
 		}()
 		}()
 	}
 	}
 
 
-	users := make([]models.User, 5)
+	const nUsers = 100
+	users := make([]models.User, nUsers)
 
 
 	for i := range users {
 	for i := range users {
 		cmd := &models.CreateUserCommand{
 		cmd := &models.CreateUserCommand{
@@ -65,15 +67,43 @@ func TestIntegration_GetUserStats(t *testing.T) {
 		users[i] = cmd.Result
 		users[i] = cmd.Result
 	}
 	}
 
 
+	orgs := make([]models.Org, 10)
+
+	for i := range orgs {
+		cmd := &models.CreateOrgCommand{
+			Name:   fmt.Sprintf("org %d", i),
+			UserId: firstUser.Id,
+		}
+		err := CreateOrg(cmd)
+		require.NoError(t, err)
+		orgs[i] = cmd.Result
+	}
+
+	for _, u := range users {
+		for _, o := range orgs {
+			cmd := &models.AddOrgUserCommand{
+				Role:   "Viewer",
+				UserId: u.Id,
+				OrgId:  o.Id,
+			}
+			err := AddOrgUser(cmd)
+			require.NoErrorf(t, err, "uID %d oID %d", u.Id, o.Id)
+		}
+	}
+
 	query := models.GetUserStatsQuery{
 	query := models.GetUserStatsQuery{
 		MustUpdate: true,
 		MustUpdate: true,
 	}
 	}
-	err = GetUserStats(&query)
+
+	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	defer cancel()
+
+	err = GetUserStats(ctx, &query)
 	require.NoError(t, err)
 	require.NoError(t, err)
 	assert.EqualValues(t, models.UserStats{
 	assert.EqualValues(t, models.UserStats{
-		Users:   6,
+		Users:   nUsers + 1,
 		Admins:  1,
 		Admins:  1,
-		Editors: 5,
+		Editors: nUsers,
 		Viewers: 0,
 		Viewers: 0,
 	}, query.Result)
 	}, query.Result)
 }
 }

pkg/services/sqlstore/stats_test.go

@@ -59,7 +59,7 @@ func TestStatsDataAccess(t *testing.T) {
 			MustUpdate: true,
 			MustUpdate: true,
 			Active:     true,
 			Active:     true,
 		}
 		}
-		err := GetUserStats(&query)
+		err := GetUserStats(context.Background(), &query)
 		require.NoError(t, err)
 		require.NoError(t, err)
 		assert.Equal(t, int64(1), query.Result.Users)
 		assert.Equal(t, int64(1), query.Result.Users)
 		assert.Equal(t, int64(1), query.Result.Admins)
 		assert.Equal(t, int64(1), query.Result.Admins)
@@ -133,6 +133,6 @@ func populateDB(t *testing.T) {
 		MustUpdate: true,
 		MustUpdate: true,
 		Active:     true,
 		Active:     true,
 	}
 	}
-	err = GetUserStats(&query)
+	err = GetUserStats(context.Background(), &query)
 	require.NoError(t, err)
 	require.NoError(t, err)
 }
 }