Skip to content

chore: wire up usage tracking for managed agents #19096

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

Draft
wants to merge 1 commit into
base: 07-30-chore_add_usage_tracking_package
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions coderd/coderd.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (

"github.com/coder/coder/v2/coderd/oauth2provider"
"github.com/coder/coder/v2/coderd/prebuilds"
"github.com/coder/coder/v2/coderd/usage"
"github.com/coder/coder/v2/coderd/wsbuilder"

"github.com/andybalholm/brotli"
Expand Down Expand Up @@ -198,6 +199,7 @@ type Options struct {
TemplateScheduleStore *atomic.Pointer[schedule.TemplateScheduleStore]
UserQuietHoursScheduleStore *atomic.Pointer[schedule.UserQuietHoursScheduleStore]
AccessControlStore *atomic.Pointer[dbauthz.AccessControlStore]
UsageCollector *atomic.Pointer[usage.Collector]
// CoordinatorResumeTokenProvider is used to provide and validate resume
// tokens issued by and passed to the coordinator DRPC API.
CoordinatorResumeTokenProvider tailnet.ResumeTokenProvider
Expand Down Expand Up @@ -426,6 +428,13 @@ func New(options *Options) *API {
v := schedule.NewAGPLUserQuietHoursScheduleStore()
options.UserQuietHoursScheduleStore.Store(&v)
}
if options.UsageCollector == nil {
options.UsageCollector = &atomic.Pointer[usage.Collector]{}
}
if options.UsageCollector.Load() == nil {
collector := usage.NewAGPLCollector()
options.UsageCollector.Store(&collector)
}
if options.OneTimePasscodeValidityPeriod == 0 {
options.OneTimePasscodeValidityPeriod = 20 * time.Minute
}
Expand Down Expand Up @@ -588,6 +597,7 @@ func New(options *Options) *API {
UserQuietHoursScheduleStore: options.UserQuietHoursScheduleStore,
AccessControlStore: options.AccessControlStore,
BuildUsageChecker: &buildUsageChecker,
UsageCollector: options.UsageCollector,
FileCache: files.New(options.PrometheusRegistry, options.Authorizer),
Experiments: experiments,
WebpushDispatcher: options.WebPushDispatcher,
Expand Down Expand Up @@ -1662,6 +1672,9 @@ type API struct {
// BuildUsageChecker is a pointer as it's passed around to multiple
// components.
BuildUsageChecker *atomic.Pointer[wsbuilder.UsageChecker]
// UsageCollector is a pointer to an atomic pointer because it is passed to
// multiple components.
UsageCollector *atomic.Pointer[usage.Collector]

UpdatesProvider tailnet.WorkspaceUpdatesProvider

Expand Down Expand Up @@ -1877,6 +1890,7 @@ func (api *API) CreateInMemoryTaggedProvisionerDaemon(dialCtx context.Context, n
&api.Auditor,
api.TemplateScheduleStore,
api.UserQuietHoursScheduleStore,
api.UsageCollector,
api.DeploymentValues,
provisionerdserver.Options{
OIDCConfig: api.OIDCConfig,
Expand Down
19 changes: 19 additions & 0 deletions coderd/provisionerdserver/provisionerdserver.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import (

"cdr.dev/slog"

"github.com/coder/coder/v2/coderd/usage"
"github.com/coder/coder/v2/coderd/util/slice"

"github.com/coder/coder/v2/codersdk/drpcsdk"
Expand Down Expand Up @@ -121,6 +122,7 @@ type server struct {
DeploymentValues *codersdk.DeploymentValues
NotificationsEnqueuer notifications.Enqueuer
PrebuildsOrchestrator *atomic.Pointer[prebuilds.ReconciliationOrchestrator]
UsageCollector *atomic.Pointer[usage.Collector]

OIDCConfig promoauth.OAuth2Config

Expand Down Expand Up @@ -174,6 +176,7 @@ func NewServer(
auditor *atomic.Pointer[audit.Auditor],
templateScheduleStore *atomic.Pointer[schedule.TemplateScheduleStore],
userQuietHoursScheduleStore *atomic.Pointer[schedule.UserQuietHoursScheduleStore],
usageCollector *atomic.Pointer[usage.Collector],
deploymentValues *codersdk.DeploymentValues,
options Options,
enqueuer notifications.Enqueuer,
Expand All @@ -195,6 +198,9 @@ func NewServer(
if userQuietHoursScheduleStore == nil {
return nil, xerrors.New("userQuietHoursScheduleStore is nil")
}
if usageCollector == nil {
return nil, xerrors.New("usageCollector is nil")
}
if deploymentValues == nil {
return nil, xerrors.New("deploymentValues is nil")
}
Expand Down Expand Up @@ -244,6 +250,7 @@ func NewServer(
heartbeatInterval: options.HeartbeatInterval,
heartbeatFn: options.HeartbeatFn,
PrebuildsOrchestrator: prebuildsOrchestrator,
UsageCollector: usageCollector,
}

if s.heartbeatFn == nil {
Expand Down Expand Up @@ -1892,6 +1899,18 @@ func (s *server) completeWorkspaceBuildJob(ctx context.Context, job database.Pro
}

sidebarAppID = uuid.NullUUID{UUID: id, Valid: true}

// Collect usage event for managed agents.
usageCollector := s.UsageCollector.Load()
if usageCollector != nil {
event := usage.DCManagedAgentsV1{
Count: 1,
}
err = (*usageCollector).CollectDiscreteUsageEvent(ctx, db, event)
if err != nil {
return xerrors.Errorf("collect %q event: %w", event.EventType(), err)
}
}
}

// Regardless of whether there is an AI task or not, update the field to indicate one way or the other since it
Expand Down
62 changes: 60 additions & 2 deletions coderd/provisionerdserver/provisionerdserver_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ import (
"github.com/coder/coder/v2/coderd/schedule"
"github.com/coder/coder/v2/coderd/schedule/cron"
"github.com/coder/coder/v2/coderd/telemetry"
"github.com/coder/coder/v2/coderd/usage"
"github.com/coder/coder/v2/coderd/wspubsub"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/codersdk/agentsdk"
Expand All @@ -67,6 +68,13 @@ func testUserQuietHoursScheduleStore() *atomic.Pointer[schedule.UserQuietHoursSc
return ptr
}

func testUsageCollector() *atomic.Pointer[usage.Collector] {
ptr := &atomic.Pointer[usage.Collector]{}
collector := usage.NewAGPLCollector()
ptr.Store(&collector)
return ptr
}

func TestAcquireJob_LongPoll(t *testing.T) {
t.Parallel()
//nolint:dogsled
Expand Down Expand Up @@ -2469,7 +2477,10 @@ func TestCompleteJob(t *testing.T) {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()

srv, db, _, pd := setup(t, false, &overrides{})
fakeUsageCollector, usageCollectorPtr := newFakeUsageCollector()
srv, db, _, pd := setup(t, false, &overrides{
usageCollector: usageCollectorPtr,
})

importJobID := uuid.New()
tvID := uuid.New()
Expand Down Expand Up @@ -2535,6 +2546,10 @@ func TestCompleteJob(t *testing.T) {
require.NoError(t, err)
require.True(t, version.HasAITask.Valid) // We ALWAYS expect a value to be set, therefore not nil, i.e. valid = true.
require.Equal(t, tc.expected, version.HasAITask.Bool)

// We never expect a usage event to be collected for
// template imports.
require.Empty(t, fakeUsageCollector.collectedEvents)
})
}
})
Expand Down Expand Up @@ -2576,7 +2591,10 @@ func TestCompleteJob(t *testing.T) {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()

srv, db, _, pd := setup(t, false, &overrides{})
fakeUsageCollector, usageCollectorPtr := newFakeUsageCollector()
srv, db, _, pd := setup(t, false, &overrides{
usageCollector: usageCollectorPtr,
})

importJobID := uuid.New()
tvID := uuid.New()
Expand Down Expand Up @@ -2657,6 +2675,15 @@ func TestCompleteJob(t *testing.T) {

if tc.expected {
require.Equal(t, sidebarAppID, build.AITaskSidebarAppID.UUID.String())

// Check that a usage event was collected.
require.Len(t, fakeUsageCollector.collectedEvents, 1)
require.Equal(t, usage.DCManagedAgentsV1{
Count: 1,
}, fakeUsageCollector.collectedEvents[0])
} else {
// Check that no usage event was collected.
require.Empty(t, fakeUsageCollector.collectedEvents)
}
})
}
Expand Down Expand Up @@ -3582,6 +3609,7 @@ type overrides struct {
externalAuthConfigs []*externalauth.Config
templateScheduleStore *atomic.Pointer[schedule.TemplateScheduleStore]
userQuietHoursScheduleStore *atomic.Pointer[schedule.UserQuietHoursScheduleStore]
usageCollector *atomic.Pointer[usage.Collector]
clock *quartz.Mock
acquireJobLongPollDuration time.Duration
heartbeatFn func(ctx context.Context) error
Expand All @@ -3603,6 +3631,7 @@ func setup(t *testing.T, ignoreLogErrors bool, ov *overrides) (proto.DRPCProvisi
var externalAuthConfigs []*externalauth.Config
tss := testTemplateScheduleStore()
uqhss := testUserQuietHoursScheduleStore()
usageCollector := testUsageCollector()
clock := quartz.NewReal()
pollDur := time.Duration(0)
if ov == nil {
Expand Down Expand Up @@ -3640,6 +3669,15 @@ func setup(t *testing.T, ignoreLogErrors bool, ov *overrides) (proto.DRPCProvisi
require.True(t, swapped)
}
}
if ov.usageCollector != nil {
tusageCollector := usageCollector.Load()
// keep the initial test value if the override hasn't set the atomic pointer.
usageCollector = ov.usageCollector
if usageCollector.Load() == nil {
swapped := usageCollector.CompareAndSwap(nil, tusageCollector)
require.True(t, swapped)
}
}
if ov.clock != nil {
clock = ov.clock
}
Expand Down Expand Up @@ -3695,6 +3733,7 @@ func setup(t *testing.T, ignoreLogErrors bool, ov *overrides) (proto.DRPCProvisi
auditPtr,
tss,
uqhss,
usageCollector,
deploymentValues,
provisionerdserver.Options{
ExternalAuthConfigs: externalAuthConfigs,
Expand Down Expand Up @@ -3809,3 +3848,22 @@ func (s *fakeStream) cancel() {
s.canceled = true
s.c.Broadcast()
}

type fakeUsageCollector struct {
collectedEvents []usage.Event
}

var _ usage.Collector = &fakeUsageCollector{}

func newFakeUsageCollector() (*fakeUsageCollector, *atomic.Pointer[usage.Collector]) {
ptr := &atomic.Pointer[usage.Collector]{}
fake := &fakeUsageCollector{}
var collector usage.Collector = fake
ptr.Store(&collector)
return fake, ptr
}

func (f *fakeUsageCollector) CollectDiscreteUsageEvent(_ context.Context, _ database.Store, event usage.DiscreteEvent) error {
f.collectedEvents = append(f.collectedEvents, event)
return nil
}
45 changes: 44 additions & 1 deletion enterprise/cli/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"github.com/coder/coder/v2/enterprise/audit/backends"
"github.com/coder/coder/v2/enterprise/coderd"
"github.com/coder/coder/v2/enterprise/coderd/dormancy"
"github.com/coder/coder/v2/enterprise/coderd/usage"
"github.com/coder/coder/v2/enterprise/dbcrypt"
"github.com/coder/coder/v2/enterprise/trialer"
"github.com/coder/coder/v2/tailnet"
Expand Down Expand Up @@ -116,15 +117,57 @@ func (r *RootCmd) Server(_ func()) *serpent.Command {
o.ExternalTokenEncryption = cs
}

if o.LicenseKeys == nil {
o.LicenseKeys = coderd.Keys
}

multiCloser := &multiCloser{}

// Create the enterprise API.
api, err := coderd.New(ctx, o)
if err != nil {
return nil, nil, err
}
return api.AGPL, api, nil
multiCloser.Add(api)

// Start the enterprise usage publisher routine. This won't do anything
// unless the deployment is licensed and one of the licenses has usage
// publishing enabled.
publisher := usage.NewTallymanPublisher(ctx, options.Logger, options.Database, o.LicenseKeys,
usage.PublisherWithHTTPClient(api.HTTPClient),
)
err = publisher.Start()
if err != nil {
_ = multiCloser.Close()
return nil, nil, xerrors.Errorf("start usage publisher: %w", err)
}
multiCloser.Add(publisher)

return api.AGPL, multiCloser, nil
})

cmd.AddSubcommands(
r.dbcryptCmd(),
)
return cmd
}

type multiCloser struct {
closers []io.Closer
}

var _ io.Closer = &multiCloser{}

func (m *multiCloser) Add(closer io.Closer) {
m.closers = append(m.closers, closer)
}

func (m *multiCloser) Close() error {
var mErr error
for _, closer := range m.closers {
if err := closer.Close(); err != nil {
mErr = xerrors.Errorf("close %T: %w", closer, err)
}
}
return mErr
}
10 changes: 10 additions & 0 deletions enterprise/coderd/coderd.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"strconv"
"strings"
"sync"
"sync/atomic"
"time"

"github.com/coder/quartz"
Expand All @@ -22,10 +23,12 @@ import (
agplportsharing "github.com/coder/coder/v2/coderd/portsharing"
agplprebuilds "github.com/coder/coder/v2/coderd/prebuilds"
"github.com/coder/coder/v2/coderd/rbac/policy"
agplusage "github.com/coder/coder/v2/coderd/usage"
"github.com/coder/coder/v2/coderd/wsbuilder"
"github.com/coder/coder/v2/enterprise/coderd/connectionlog"
"github.com/coder/coder/v2/enterprise/coderd/enidpsync"
"github.com/coder/coder/v2/enterprise/coderd/portsharing"
"github.com/coder/coder/v2/enterprise/coderd/usage"

"golang.org/x/xerrors"
"tailscale.com/tailcfg"
Expand Down Expand Up @@ -90,6 +93,13 @@ func New(ctx context.Context, options *Options) (_ *API, err error) {
if options.Entitlements == nil {
options.Entitlements = entitlements.New()
}
if options.Options.UsageCollector == nil {
options.Options.UsageCollector = &atomic.Pointer[agplusage.Collector]{}
}
if options.Options.UsageCollector.Load() == nil {
collector := usage.NewDBCollector()
options.Options.UsageCollector.Store(&collector)
}

ctx, cancelFunc := context.WithCancel(ctx)

Expand Down
1 change: 1 addition & 0 deletions enterprise/coderd/provisionerdaemons.go
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ func (api *API) provisionerDaemonServe(rw http.ResponseWriter, r *http.Request)
&api.AGPL.Auditor,
api.AGPL.TemplateScheduleStore,
api.AGPL.UserQuietHoursScheduleStore,
api.AGPL.UsageCollector,
api.DeploymentValues,
provisionerdserver.Options{
ExternalAuthConfigs: api.ExternalAuthConfigs,
Expand Down
Loading
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy