feat(logging): enhance logging functionality with structured log entries and improved error handling

Author: tobimadehin

internal/deploy/deploy.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/dployr-io/dployr/internal/version_resolver"
 	"github.com/dployr-io/dployr/pkg/core/deploy"
+	coreutils "github.com/dployr-io/dployr/pkg/core/utils"
 	"github.com/dployr-io/dployr/pkg/shared"
 	"github.com/dployr-io/dployr/pkg/store"
 
@@ -132,12 +133,20 @@ func (d *Deployer) Deploy(ctx context.Context, req *deploy.DeployRequest) (*depl
 }
 
 func (d *Deployer) Build(ctx context.Context, req *deploy.BuildRequest) (*deploy.BuildResponse, error) {
+	logDir := filepath.Join(coreutils.GetDataDir(), ".dployr", "logs")
+	svcName := coreutils.FormatName(req.Name)
+
+	shared.LogInfoF(svcName, logDir, "starting build")
+
 	workDir, err := SetupDir(req.Name)
 	if err != nil {
+		shared.LogErrF(svcName, logDir, err)
 		return nil, fmt.Errorf("failed to setup working directory: %w", err)
 	}
 
+	shared.LogInfoF(svcName, logDir, "cloning repository")
 	if err := CloneRepo(req.Remote, workDir, d.cfg); err != nil {
+		shared.LogErrF(svcName, logDir, fmt.Errorf("clone failed: %w", err))
 		return nil, fmt.Errorf("failed to clone repository: %w", err)
 	}
 
@@ -166,6 +175,8 @@ func (d *Deployer) Build(ctx context.Context, req *deploy.BuildRequest) (*deploy
 			env[k] = s
 		}
 	}
+
+	shared.LogInfoF(svcName, logDir, "building image")
 	image, err := BuildImage(req.Name, buildDir, d.cfg, BuildOpts{
 		Runtime:      req.Runtime,
 		Version:      resolution.Version,
@@ -176,11 +187,13 @@ func (d *Deployer) Build(ctx context.Context, req *deploy.BuildRequest) (*deploy
 		Port:         req.Port,
 		IsNextJS:     req.Runtime == "nodejs" && detectNextJS(buildDir),
 		Env:          env,
-	}, d.dockerCli)
+	}, d.dockerCli, svcName, logDir)
 	if err != nil {
+		shared.LogErrF(svcName, logDir, fmt.Errorf("build failed: %w", err))
 		return nil, fmt.Errorf("build failed: %w", err)
 	}
 
+	shared.LogInfoF(svcName, logDir, "image pushed, build complete")
 	return &deploy.BuildResponse{Image: image}, nil
 }
 

internal/deploy/utils.go

@@ -90,7 +90,7 @@ func detectNextJS(dir string) bool {
 	return inDeps || inDev
 }
 
-func BuildImage(name, srcDir string, cfg *shared.Config, opts BuildOpts, dockerCli deployDockerAPI) (string, error) {
+func BuildImage(name, srcDir string, cfg *shared.Config, opts BuildOpts, dockerCli deployDockerAPI, svcName, logDir string) (string, error) {
 	if cfg.RegistryURL == "" {
 		return "", fmt.Errorf("REGISTRY_URL is not configured on this build node")
 	}
@@ -155,16 +155,45 @@ func BuildImage(name, srcDir string, cfg *shared.Config, opts BuildOpts, dockerC
 	}
 	defer buildResp.Body.Close()
 
-	// Drain and check for build errors in the JSON stream.
+	// Drain docker build output, writing to the log file and surfacing errors.
+	// Open the log file once for the entire build stream rather than per-line.
+	var logWriter *bufio.Writer
+	var logFile *os.File
+	if logDir != "" {
+		if err := os.MkdirAll(logDir, 0755); err == nil {
+			logFile, _ = os.OpenFile(filepath.Join(logDir, strings.ToLower(svcName)+".log"), os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
+			if logFile != nil {
+				logWriter = bufio.NewWriter(logFile)
+			}
+		}
+	}
+
 	scanner := bufio.NewScanner(buildResp.Body)
 	for scanner.Scan() {
 		var msg struct {
 			Error  string `json:"error"`
 			Stream string `json:"stream"`
 		}
-		if json.Unmarshal(scanner.Bytes(), &msg) == nil && msg.Error != "" {
+		if json.Unmarshal(scanner.Bytes(), &msg) != nil {
+			continue
+		}
+		if msg.Error != "" {
+			if logWriter != nil {
+				logWriter.Flush()
+				logFile.Close()
+			}
 			return "", fmt.Errorf("docker build: %s", strings.TrimSpace(msg.Error))
 		}
+		if line := strings.TrimSpace(msg.Stream); line != "" && logWriter != nil {
+			entry := fmt.Sprintf(`{"time":%q,"level":"INFO","msg":%q}`+"\n",
+				time.Now().UTC().Format(time.RFC3339Nano), line)
+			logWriter.WriteString(entry)
+		}
+	}
+
+	if logWriter != nil {
+		logWriter.Flush()
+		logFile.Close()
 	}
 
 	var authStr string

internal/logs/handler.go

@@ -83,7 +83,22 @@ func (h *Handler) StreamLogs(ctx context.Context, opts logs.StreamOptions, sendC
 // streamTail reads from current position and follows new log entries with file rotation detection.
 // Handles both historical reads (with time-based cutoff) and live tailing.
 func (h *Handler) streamTail(ctx context.Context, logPath string, opts logs.StreamOptions, cutoffTime time.Time, sendChunk func(chunk logs.LogChunk) error) error {
-	file, err := os.Open(logPath)
+	var file *os.File
+	var err error
+	for range 30 {
+		file, err = os.Open(logPath)
+		if err == nil {
+			break
+		}
+		if !os.IsNotExist(err) {
+			break
+		}
+		select {
+		case <-ctx.Done():
+			return ctx.Err()
+		case <-time.After(500 * time.Millisecond):
+		}
+	}
 	if err != nil {
 		h.logger.Error("failed to open log file", "error", err, "path", logPath)
 		return fmt.Errorf("failed to open log file: %w", err)

pkg/shared/logger.go

@@ -284,7 +284,8 @@ func writeDeploymentLog(name, dir, level, message string) error {
 	}
 	defer f.Close()
 
-	entry := fmt.Sprintf("%s\n", message)
+	entry := fmt.Sprintf(`{"time":%q,"level":%q,"msg":%q}`+"\n",
+		time.Now().UTC().Format(time.RFC3339Nano), level, message)
 
 	_, err = f.WriteString(entry)
 	return err