chore: Improve agent logging (#3483)

kylecarbs · web-flow · commit 16c12e976ea1 · 2022-08-12T07:01:00.000-05:00
diff --git a/agent/agent.go b/agent/agent.go
@@ -129,6 +129,7 @@ func (a *agent) run(ctx context.Context) {
 	// An exponential back-off occurs when the connection is failing to dial.
 	// This is to prevent server spam in case of a coderd outage.
 	for retrier := retry.New(50*time.Millisecond, 10*time.Second); retrier.Wait(ctx); {
+		a.logger.Info(ctx, "connecting")
 		metadata, peerListener, err = a.dialer(ctx, a.logger)
 		if err != nil {
 			if errors.Is(err, context.Canceled) {
@@ -255,6 +256,7 @@ func (a *agent) handlePeerConn(ctx context.Context, conn *peer.Conn) {
 }
 
 func (a *agent) init(ctx context.Context) {
+	a.logger.Info(ctx, "generating host key")
 	// Clients' should ignore the host key when connecting.
 	// The agent needs to authenticate with coderd to SSH,
 	// so SSH authentication doesn't improve security.
diff --git a/cli/agent.go b/cli/agent.go
@@ -73,6 +73,7 @@ func workspaceAgent() *cobra.Command {
 				return nil
 			}
 
+			logger.Info(cmd.Context(), "starting agent", slog.F("url", coderURL), slog.F("auth", auth))
 			client := codersdk.New(coderURL)
 
 			if pprofEnabled {
@@ -138,6 +139,7 @@ func workspaceAgent() *cobra.Command {
 			}
 
 			if exchangeToken != nil {
+				logger.Info(cmd.Context(), "exchanging identity token")
 				// Agent's can start before resources are returned from the provisioner
 				// daemon. If there are many resources being provisioned, this time
 				// could be significant. This is arbitrarily set at an hour to prevent

Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ func workspaceAgent() *cobra.Command {`
`73`	`73`	`return nil`
`74`	`74`	`}`
`75`	`75`
	`76`	`+ logger.Info(cmd.Context(), "starting agent", slog.F("url", coderURL), slog.F("auth", auth))`
`76`	`77`	`client := codersdk.New(coderURL)`
`77`	`78`
`78`	`79`	`if pprofEnabled {`
`@@ -138,6 +139,7 @@ func workspaceAgent() *cobra.Command {`
`138`	`139`	`}`
`139`	`140`
`140`	`141`	`if exchangeToken != nil {`
	`142`	`+ logger.Info(cmd.Context(), "exchanging identity token")`
`141`	`143`	`// Agent's can start before resources are returned from the provisioner`
`142`	`144`	`// daemon. If there are many resources being provisioned, this time`
`143`	`145`	`// could be significant. This is arbitrarily set at an hour to prevent`