log provisionerd connection info conditionally

hugodutka · hugodutka · commit 9a14ad045a3e · 2025-02-20T10:43:35.000Z
diff --git a/enterprise/cli/provisionerdaemonstart.go b/enterprise/cli/provisionerdaemonstart.go
@@ -236,10 +236,11 @@ func (r *RootCmd) provisionerDaemonStart() *serpent.Command {
 					ProvisionerKey: provisionerKey,
 				})
 			}, &provisionerd.Options{
-				Logger:         logger,
-				UpdateInterval: 500 * time.Millisecond,
-				Connector:      connector,
-				Metrics:        metrics,
+				Logger:                logger,
+				UpdateInterval:        500 * time.Millisecond,
+				Connector:             connector,
+				Metrics:               metrics,
+				IsExternalProvisioner: true,
 			})
 
 			waitForProvisionerJobs := false
diff --git a/provisionerd/provisionerd.go b/provisionerd/provisionerd.go
@@ -56,11 +56,12 @@ type Options struct {
 	TracerProvider trace.TracerProvider
 	Metrics        *Metrics
 
-	ForceCancelInterval time.Duration
-	UpdateInterval      time.Duration
-	LogBufferInterval   time.Duration
-	Connector           Connector
-	InitConnectionCh    chan struct{} // only to be used in tests
+	IsExternalProvisioner bool
+	ForceCancelInterval   time.Duration
+	UpdateInterval        time.Duration
+	LogBufferInterval     time.Duration
+	Connector             Connector
+	InitConnectionCh      chan struct{} // only to be used in tests
 }
 
 // New creates and starts a provisioner daemon.
@@ -97,12 +98,13 @@ func New(clientDialer Dialer, opts *Options) *Server {
 		clientDialer: clientDialer,
 		clientCh:     make(chan proto.DRPCProvisionerDaemonClient),
 
-		closeContext:     ctx,
-		closeCancel:      ctxCancel,
-		closedCh:         make(chan struct{}),
-		shuttingDownCh:   make(chan struct{}),
-		acquireDoneCh:    make(chan struct{}),
-		initConnectionCh: opts.InitConnectionCh,
+		closeContext:          ctx,
+		closeCancel:           ctxCancel,
+		closedCh:              make(chan struct{}),
+		shuttingDownCh:        make(chan struct{}),
+		acquireDoneCh:         make(chan struct{}),
+		initConnectionCh:      opts.InitConnectionCh,
+		isExternalProvisioner: opts.IsExternalProvisioner,
 	}
 
 	daemon.wg.Add(2)
@@ -141,8 +143,9 @@ type Server struct {
 	// shuttingDownCh will receive when we start graceful shutdown
 	shuttingDownCh chan struct{}
 	// acquireDoneCh will receive when the acquireLoop exits
-	acquireDoneCh chan struct{}
-	activeJob     *runner.Runner
+	acquireDoneCh         chan struct{}
+	activeJob             *runner.Runner
+	isExternalProvisioner bool
 }
 
 type Metrics struct {
@@ -239,7 +242,16 @@ connectLoop:
 			p.opts.Logger.Warn(p.closeContext, "coderd client failed to dial", slog.Error(err))
 			continue
 		}
-		p.opts.Logger.Info(p.closeContext, "successfully connected to coderd")
+		// This log is useful to verify that an external provisioner daemon is
+		// successfully connecting to coderd. It doesn't add much value if the
+		// daemon is built-in, so we only log it on the info level if isExternalProvisioner
+		// is true. This log message is mentioned in the docs:
+		// https://github.com/coder/coder/blob/5bd86cb1c06561d1d3e90ce689da220467e525c0/docs/admin/provisioners.md#L346
+		if p.isExternalProvisioner {
+			p.opts.Logger.Info(p.closeContext, "successfully connected to coderd")
+		} else {
+			p.opts.Logger.Debug(p.closeContext, "successfully connected to coderd")
+		}
 		retrier.Reset()
 		p.initConnectionOnce.Do(func() {
 			close(p.initConnectionCh)
@@ -252,7 +264,11 @@ connectLoop:
 				client.DRPCConn().Close()
 				return
 			case <-client.DRPCConn().Closed():
-				p.opts.Logger.Info(p.closeContext, "connection to coderd closed")
+				if p.isExternalProvisioner {
+					p.opts.Logger.Info(p.closeContext, "connection to coderd closed")
+				} else {
+					p.opts.Logger.Debug(p.closeContext, "connection to coderd closed")
+				}
 				continue connectLoop
 			case p.clientCh <- client:
 				continue
