Skip to content

feat: add total users insight #15486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 23 commits into from
Closed
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions coderd/apidoc/docs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

53 changes: 53 additions & 0 deletions coderd/apidoc/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions coderd/coderd.go
Original file line number Diff line number Diff line change
Expand Up @@ -1260,6 +1260,7 @@ func New(options *Options) *API {
r.Get("/user-activity", api.insightsUserActivity)
r.Get("/user-latency", api.insightsUserLatency)
r.Get("/templates", api.insightsTemplates)
r.Get("/total-users", api.insightsTotalUsers)
})
r.Route("/debug", func(r chi.Router) {
r.Use(
Expand Down
7 changes: 7 additions & 0 deletions coderd/database/dbauthz/dbauthz.go
Original file line number Diff line number Diff line change
Expand Up @@ -1377,6 +1377,13 @@ func (q *querier) GetAPIKeysLastUsedAfter(ctx context.Context, lastUsed time.Tim
return fetchWithPostFilter(q.auth, policy.ActionRead, q.db.GetAPIKeysLastUsedAfter)(ctx, lastUsed)
}

func (q *querier) GetAccumulatedUsersInsights(ctx context.Context, arg database.GetAccumulatedUsersInsightsParams) ([]database.GetAccumulatedUsersInsightsRow, error) {
if err := q.authorizeContext(ctx, policy.ActionRead, rbac.ResourceSystem); err != nil {
return nil, err
}
return q.db.GetAccumulatedUsersInsights(ctx, arg)
}

func (q *querier) GetActiveUserCount(ctx context.Context) (int64, error) {
if err := q.authorizeContext(ctx, policy.ActionRead, rbac.ResourceSystem); err != nil {
return 0, err
Expand Down
7 changes: 7 additions & 0 deletions coderd/database/dbauthz/dbauthz_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2346,6 +2346,13 @@ func (s *MethodTestSuite) TestSystemFunctions() {
dbgen.WorkspaceBuild(s.T(), db, database.WorkspaceBuild{})
check.Args().Asserts(rbac.ResourceSystem, policy.ActionRead)
}))
s.Run("GetAccumulatedUsersInsights", s.Subtest(func(db database.Store, check *expects) {
check.Args(database.GetAccumulatedUsersInsightsParams{
StartTime: dbtime.Time(time.Now()),
EndTime: dbtime.Time(time.Now()),
Timezone: "UTC",
}).Asserts(rbac.ResourceSystem, policy.ActionRead)
}))
s.Run("GetActiveUserCount", s.Subtest(func(db database.Store, check *expects) {
check.Args().Asserts(rbac.ResourceSystem, policy.ActionRead).Returns(int64(0))
}))
Expand Down
35 changes: 35 additions & 0 deletions coderd/database/dbmem/dbmem.go
Original file line number Diff line number Diff line change
Expand Up @@ -2320,6 +2320,41 @@ func (q *FakeQuerier) GetAPIKeysLastUsedAfter(_ context.Context, after time.Time
return apiKeys, nil
}

func (q *FakeQuerier) GetAccumulatedUsersInsights(_ context.Context, arg database.GetAccumulatedUsersInsightsParams) ([]database.GetAccumulatedUsersInsightsRow, error) {
q.mutex.RLock()
defer q.mutex.RUnlock()

newUsersByDate := make(map[time.Time]int64)
for _, user := range q.users {
if user.CreatedAt.Before(arg.StartTime) || user.CreatedAt.After(arg.EndTime) {
continue
}
date := user.CreatedAt.Truncate(24 * time.Hour)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this work correctly with timezones?

newUsersByDate[date]++
}

dateSeries := make([]time.Time, 0)
for date := arg.StartTime.Truncate(24 * time.Hour); date.Before(arg.EndTime); date = date.AddDate(0, 0, 1) {
dateSeries = append(dateSeries, date)
}

accumulatedByDate := make(map[time.Time]int64)
var accumulatedCount int64
for _, date := range dateSeries {
accumulatedCount += newUsersByDate[date]
accumulatedByDate[date] = accumulatedCount
}

var rows []database.GetAccumulatedUsersInsightsRow
for _, date := range dateSeries {
rows = append(rows, database.GetAccumulatedUsersInsightsRow{
Date: date,
Total: accumulatedByDate[date],
})
}
return rows, nil
}

func (q *FakeQuerier) GetActiveUserCount(_ context.Context) (int64, error) {
q.mutex.RLock()
defer q.mutex.RUnlock()
Expand Down
7 changes: 7 additions & 0 deletions coderd/database/dbmetrics/querymetrics.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions coderd/database/dbmock/dbmock.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions coderd/database/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

54 changes: 54 additions & 0 deletions coderd/database/queries.sql.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions coderd/database/queries/insights.sql
Original file line number Diff line number Diff line change
Expand Up @@ -771,3 +771,22 @@ SELECT
FROM unique_template_params utp
JOIN workspace_build_parameters wbp ON (utp.workspace_build_ids @> ARRAY[wbp.workspace_build_id] AND utp.name = wbp.name)
GROUP BY utp.num, utp.template_ids, utp.name, utp.type, utp.display_name, utp.description, utp.options, wbp.value;

-- name: GetAccumulatedUsersInsights :many
-- GetAccumulatedUsersInsights returns the accumulated number of users created
-- in the given timeframe. It returns the accumulated number of users for each date
-- within the specified timeframe, providing a running total of user sign-ups.
WITH RECURSIVE date_series AS (
SELECT @start_time::timestamptz AS date
UNION ALL
SELECT date + INTERVAL '1 day'
FROM date_series
WHERE date + INTERVAL '1 day' <= @end_time::timestamptz
)
SELECT
(d.date AT TIME ZONE @timezone::text)::date AS date,
(SELECT COUNT(*) FROM users u WHERE u.created_at <= d.date) AS total
FROM
date_series d
ORDER BY
d.date;
Loading
Loading