feat(coderd/database): add dbrollup service to rollup insights
#12665
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| package dbrollup | ||
|
|
||
| import ( | ||
| "context" | ||
| "flag" | ||
| "time" | ||
|
|
||
| "golang.org/x/sync/errgroup" | ||
|
|
||
| "cdr.dev/slog" | ||
|
|
||
| "github.com/coder/coder/v2/coderd/database" | ||
| "github.com/coder/coder/v2/coderd/database/dbauthz" | ||
| ) | ||
|
|
||
| const ( | ||
| // DefaultInterval is the default time between rollups. | ||
| // Rollups will be synchronized with the clock so that | ||
| // they happen 13:00, 13:05, 13:10, etc. | ||
| DefaultInterval = 5 * time.Minute | ||
| ) | ||
|
|
||
| type Event struct { | ||
| TemplateUsageStats bool | ||
| } | ||
|
|
||
| type Rolluper struct { | ||
| cancel context.CancelFunc | ||
| closed chan struct{} | ||
| db database.Store | ||
| logger slog.Logger | ||
| interval time.Duration | ||
| event chan<- Event | ||
| } | ||
|
|
||
| type Option func(*Rolluper) | ||
|
|
||
| // WithInterval sets the interval between rollups. | ||
| func WithInterval(interval time.Duration) Option { | ||
| return func(r *Rolluper) { | ||
| r.interval = interval | ||
| } | ||
| } | ||
|
|
||
| // WithEventChannel sets the event channel to use for rollup events. | ||
| // | ||
| // This is only used for testing. | ||
| func WithEventChannel(ch chan<- Event) Option { | ||
| if flag.Lookup("test.v") == nil { | ||
| panic("developer error: WithEventChannel is not to be used outside of tests") | ||
| } | ||
| return func(r *Rolluper) { | ||
| r.event = ch | ||
| } | ||
| } | ||
|
|
||
| // New creates a new DB rollup service that periodically runs rollup queries. | ||
| // It is the caller's responsibility to call Close on the returned instance. | ||
| // | ||
| // This is for e.g. generating insights data (template_usage_stats) from | ||
| // raw data (workspace_agent_stats, workspace_app_stats). | ||
| func New(logger slog.Logger, db database.Store, opts ...Option) *Rolluper { | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
|
|
||
| r := &Rolluper{ | ||
| cancel: cancel, | ||
| closed: make(chan struct{}), | ||
| db: db, | ||
| logger: logger, | ||
| interval: DefaultInterval, | ||
| } | ||
|
|
||
| for _, opt := range opts { | ||
| opt(r) | ||
| } | ||
|
|
||
| //nolint:gocritic // The system rolls up database tables without user input. | ||
| ctx = dbauthz.AsSystemRestricted(ctx) | ||
| go r.start(ctx) | ||
|
|
||
| return r | ||
| } | ||
|
|
||
| func (r *Rolluper) start(ctx context.Context) { | ||
| defer close(r.closed) | ||
|
|
||
| do := func() { | ||
| var eg errgroup.Group | ||
|
|
||
| r.logger.Debug(ctx, "rolling up data") | ||
| now := time.Now() | ||
|
|
||
| // Track whether or not we performed a rollup (we got the advisory lock). | ||
| var ev Event | ||
|
|
||
| eg.Go(func() error { | ||
| return r.db.InTx(func(tx database.Store) error { | ||
| // Acquire a lock to ensure that only one instance of | ||
| // the rollup is running at a time. | ||
| ok, err := tx.TryAcquireLock(ctx, database.LockIDDBRollup) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if !ok { | ||
| return nil | ||
| } | ||
|
|
||
| ev.TemplateUsageStats = true | ||
| return tx.UpsertTemplateUsageStats(ctx) | ||
| }, nil) | ||
| }) | ||
|
|
||
| err := eg.Wait() | ||
| if err != nil { | ||
| if database.IsQueryCanceledError(err) { | ||
| return | ||
| } | ||
| // Only log if Close hasn't been called. | ||
| if ctx.Err() == nil { | ||
| r.logger.Error(ctx, "failed to rollup data", slog.Error(err)) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| r.logger.Debug(ctx, | ||
| "rolled up data", | ||
| slog.F("took", time.Since(now)), | ||
| slog.F("event", ev), | ||
| ) | ||
|
|
||
| // For testing. | ||
| if r.event != nil { | ||
| select { | ||
| case <-ctx.Done(): | ||
| return | ||
| case r.event <- ev: | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Perform do immediately and on every tick of the ticker, | ||
| // disregarding the execution time of do. This ensure that | ||
| // the rollup is performed every interval assuming do does | ||
| // not take longer than the interval to execute. | ||
| t := time.NewTicker(time.Microsecond) | ||
| defer t.Stop() | ||
| for { | ||
| select { | ||
| case <-ctx.Done(): | ||
| return | ||
| case <-t.C: | ||
| // Ensure we're on the interval. | ||
| now := time.Now() | ||
| next := now.Add(r.interval).Truncate(r.interval) // Ensure we're on the interval and synced with the clock. | ||
| d := next.Sub(now) | ||
| // Safety check (shouldn't be possible). | ||
| if d <= 0 { | ||
| d = r.interval | ||
| } | ||
| t.Reset(d) | ||
|
|
||
| do() | ||
|
|
||
| r.logger.Debug(ctx, "next rollup at", slog.F("next", next)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (r *Rolluper) Close() error { | ||
|
There was a problem hiding this comment. Is the error return value here to satisfy an interface? Do we need it? There was a problem hiding this comment. Yeah, I feel the io.Closer interface is so common it's worth using this signature even if the error is not used at the moment or ever in the future. |
||
| r.cancel() | ||
| <-r.closed | ||
| return nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see a potential abstraction here -- the PR I'm working on in parallel #12659 has a similar logic of "run a query every interval". There are definitely other areas of the codebase that could benefit from a similar framework.