Skip to content

馃尡 Use contextual logger in base controller #165

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-bot merged 1 commit into from
Nov 10, 2025
Merged

馃尡 Use contextual logger in base controller #165

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
31 changes: 19 additions & 12 deletions pkg/basecontroller/factory/base_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,16 @@ func (c baseController) Name() string {
return c.name
}

func waitForNamedCacheSync(controllerName string, stopCh <-chan struct{}, cacheSyncs ...cache.InformerSynced) error {
klog.Infof("Waiting for caches to sync for %s", controllerName)
func waitForNamedCacheSync(ctx context.Context, controllerName string, stopCh <-chan struct{}, cacheSyncs ...cache.InformerSynced) error {
logger := klog.FromContext(ctx)

logger.Info("Waiting for caches to sync")

if !cache.WaitForCacheSync(stopCh, cacheSyncs...) {
return fmt.Errorf("unable to sync caches for %s", controllerName)
}

klog.Infof("Caches are synced for %s ", controllerName)
logger.Info("Caches are synced")

return nil
}
Expand All @@ -47,10 +49,13 @@ func (c *baseController) SyncContext() SyncContext {
}

func (c *baseController) Run(ctx context.Context, workers int) {
logger := klog.FromContext(ctx).WithName(c.name)
ctx = klog.NewContext(ctx, logger)

// give caches 10 minutes to sync
cacheSyncCtx, cacheSyncCancel := context.WithTimeout(ctx, c.cacheSyncTimeout)
defer cacheSyncCancel()
err := waitForNamedCacheSync(c.name, cacheSyncCtx.Done(), c.cachesToSync...)
err := waitForNamedCacheSync(ctx, c.name, cacheSyncCtx.Done(), c.cachesToSync...)
if err != nil {
select {
case <-ctx.Done():
Expand All @@ -67,19 +72,19 @@ func (c *baseController) Run(ctx context.Context, workers int) {

var workerWg sync.WaitGroup
defer func() {
defer klog.Infof("All %s workers have been terminated", c.name)
defer logger.Info("All workers have been terminated")
workerWg.Wait()
}()

// queueContext is used to track and initiate queue shutdown
queueContext, queueContextCancel := context.WithCancel(context.TODO())
queueContext, queueContextCancel := context.WithCancel(ctx)

for i := 1; i <= workers; i++ {
klog.Infof("Starting #%d worker of %s controller ...", i, c.name)
logger.Info("Starting worker of controller ...", "numberOfWorkers", i)
workerWg.Add(1)
go func() {
defer func() {
klog.Infof("Shutting down worker of %s controller ...", c.name)
logger.Info("Shutting down worker of controller ...")
workerWg.Done()
}()
c.runWorker(queueContext)
Expand All @@ -104,7 +109,7 @@ func (c *baseController) Run(ctx context.Context, workers int) {
// Wait for all workers to finish their job.
// at this point the Run() can hang and caller have to implement the logic that will kill
// this controller (SIGKILL).
klog.Infof("Shutting down %s ...", c.name)
logger.Info("Shutting down ...")
}

func (c *baseController) Sync(ctx context.Context, syncCtx SyncContext, key string) error {
Expand Down Expand Up @@ -140,6 +145,8 @@ func (c *baseController) runWorker(queueCtx context.Context) {
}

func (c *baseController) processNextWorkItem(queueCtx context.Context) {
logger := klog.FromContext(queueCtx)

key, quit := c.syncContext.Queue().Get()
if quit {
return
Expand All @@ -150,10 +157,10 @@ func (c *baseController) processNextWorkItem(queueCtx context.Context) {
queueKey := key

if err := c.sync(queueCtx, syncCtx, queueKey); err != nil {
if klog.V(4).Enabled() || key != "key" {
utilruntime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", c.name, key, err))
if logger.V(4).Enabled() || key != "key" {
utilruntime.HandleErrorWithContext(queueCtx, err, "controller failed to sync", "key", key, "error", err)
} else {
utilruntime.HandleError(fmt.Errorf("%s reconciliation failed: %w", c.name, err))
utilruntime.HandleErrorWithContext(queueCtx, err, "reconciliation failed", "error", err)
}
c.syncContext.Queue().AddRateLimited(key)
return
Expand Down