Skip to content

chore: add more pprof labels for various go routines #19243

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 7, 2025
+25 −14
Merged

chore: add more pprof labels for various go routines #19243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions coderd/database/dbpurge/dbpurge.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbauthz"
"github.com/coder/coder/v2/coderd/database/dbtime"
"github.com/coder/coder/v2/coderd/pproflabel"
"github.com/coder/quartz"
)

Expand All @@ -38,7 +39,7 @@ func New(ctx context.Context, logger slog.Logger, db database.Store, clk quartz.

// Start the ticker with the initial delay.
ticker := clk.NewTicker(delay)
doTick := func(start time.Time) {
doTick := func(ctx context.Context, start time.Time) {
defer ticker.Reset(delay)
// Start a transaction to grab advisory lock, we don't want to run
// multiple purges at the same time (multiple replicas).
Expand Down Expand Up @@ -85,21 +86,21 @@ func New(ctx context.Context, logger slog.Logger, db database.Store, clk quartz.
}
}

go func() {
pproflabel.Go(ctx, pproflabel.Service(pproflabel.ServiceDBPurge), func(ctx context.Context) {
defer close(closed)
defer ticker.Stop()
// Force an initial tick.
doTick(dbtime.Time(clk.Now()).UTC())
doTick(ctx, dbtime.Time(clk.Now()).UTC())
for {
select {
case <-ctx.Done():
return
case tick := <-ticker.C:
ticker.Stop()
doTick(dbtime.Time(tick).UTC())
doTick(ctx, dbtime.Time(tick).UTC())
}
}
}()
})
return &instance{
cancel: cancelFunc,
closed: closed,
Expand Down
7 changes: 4 additions & 3 deletions coderd/notifications/manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ import (
"golang.org/x/xerrors"

"cdr.dev/slog"
"github.com/coder/quartz"

"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/pubsub"
"github.com/coder/coder/v2/coderd/notifications/dispatch"
"github.com/coder/coder/v2/coderd/pproflabel"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/quartz"
)

var ErrInvalidDispatchTimeout = xerrors.New("dispatch timeout must be less than lease period")
Expand Down Expand Up @@ -145,7 +146,7 @@ func (m *Manager) Run(ctx context.Context) {

m.runOnce.Do(func() {
// Closes when Stop() is called or context is canceled.
go func() {
pproflabel.Go(ctx, pproflabel.Service(pproflabel.ServiceNotifications), func(ctx context.Context) {
err := m.loop(ctx)
if err != nil {
if xerrors.Is(err, ErrManagerAlreadyClosed) {
Expand All @@ -154,7 +155,7 @@ func (m *Manager) Run(ctx context.Context) {
m.log.Error(ctx, "notification manager stopped with error", slog.Error(err))
}
}
}()
})
})
}

Expand Down
10 changes: 9 additions & 1 deletion coderd/pproflabel/pproflabel.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,17 @@ const (

ServiceHTTPServer = "http-api"
ServiceLifecycles = "lifecycle-executor"
ServiceMetricCollector = "metrics-collector"
ServicePrebuildReconciler = "prebuilds-reconciler"
ServiceTerraformProvisioner = "terraform-provisioner"
ServiceDBPurge = "db-purge"
ServiceNotifications = "notifications"
ServiceReplicaSync = "replica-sync"
// ServiceMetricCollector collects metrics from insights in the database and
// exports them in a prometheus collector format.
ServiceMetricCollector = "metrics-collector"
// ServiceAgentMetricAggregator merges agent metrics and exports them in a
// prometheus collector format.
ServiceAgentMetricAggregator = "agent-metrics-aggregator"

RequestTypeTag = "coder_request_type"
)
Expand Down
8 changes: 4 additions & 4 deletions coderd/prometheusmetrics/aggregator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ import (
"github.com/prometheus/common/model"
"golang.org/x/xerrors"

"github.com/coder/coder/v2/coderd/agentmetrics"

"cdr.dev/slog"

agentproto "github.com/coder/coder/v2/agent/proto"
"github.com/coder/coder/v2/coderd/agentmetrics"
"github.com/coder/coder/v2/coderd/pproflabel"
)

const (
Expand Down Expand Up @@ -298,7 +298,7 @@ func (ma *MetricsAggregator) Run(ctx context.Context) func() {
done := make(chan struct{})

cleanupTicker := time.NewTicker(ma.metricsCleanupInterval)
go func() {
pproflabel.Go(ctx, pproflabel.Service(pproflabel.ServiceAgentMetricAggregator), func(ctx context.Context) {
defer close(done)
defer cleanupTicker.Stop()

Expand Down Expand Up @@ -395,7 +395,7 @@ func (ma *MetricsAggregator) Run(ctx context.Context) func() {
return
}
}
}()
})
return func() {
cancelFunc()
<-done
Expand Down
3 changes: 2 additions & 1 deletion enterprise/replicasync/replicasync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"github.com/coder/coder/v2/coderd/database/dbauthz"
"github.com/coder/coder/v2/coderd/database/dbtime"
"github.com/coder/coder/v2/coderd/database/pubsub"
"github.com/coder/coder/v2/coderd/pproflabel"
)

var PubsubEvent = "replica"
Expand Down Expand Up @@ -104,7 +105,7 @@ func New(ctx context.Context, logger slog.Logger, db database.Store, ps pubsub.P
return nil, xerrors.Errorf("subscribe: %w", err)
}
manager.closeWait.Add(1)
go manager.loop(ctx)
pproflabel.Go(ctx, pproflabel.Service(pproflabel.ServiceReplicaSync), manager.loop)
return manager, nil
}

Expand Down
Loading