feat(cli): rotate file logs for coderd (coder#15438)

defelmnq · web-flow · commit d6442db25a8c · 2024-11-12T21:48:32.000+01:00
Related to coder#15309 As we already are doing for agent logs - this PR is enabling the logs rotation for coderd logs. Currently keeping the same logic than we had for agent - with 5MB as the file size for rotation.
diff --git a/cli/clilog/clilog.go b/cli/clilog/clilog.go
@@ -4,11 +4,11 @@ import (
 	"context"
 	"fmt"
 	"io"
-	"os"
 	"regexp"
 	"strings"
 
 	"golang.org/x/xerrors"
+	"gopkg.in/natefinch/lumberjack.v2"
 
 	"cdr.dev/slog"
 	"cdr.dev/slog/sloggers/sloghuman"
@@ -104,20 +104,21 @@ func (b *Builder) Build(inv *serpent.Invocation) (log slog.Logger, closeLog func
 	addSinkIfProvided := func(sinkFn func(io.Writer) slog.Sink, loc string) error {
 		switch loc {
 		case "":
-
 		case "/dev/stdout":
 			sinks = append(sinks, sinkFn(inv.Stdout))
 
 		case "/dev/stderr":
 			sinks = append(sinks, sinkFn(inv.Stderr))
 
 		default:
-			fi, err := os.OpenFile(loc, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0o644)
-			if err != nil {
-				return xerrors.Errorf("open log file %q: %w", loc, err)
+			logWriter := &lumberjack.Logger{
+				Filename: loc,
+				MaxSize:  5, // MB
+				// Without this, rotated logs will never be deleted.
+				MaxBackups: 1,
 			}
-			closers = append(closers, fi.Close)
-			sinks = append(sinks, sinkFn(fi))
+			closers = append(closers, logWriter.Close)
+			sinks = append(sinks, sinkFn(logWriter))
 		}
 		return nil
 	}
diff --git a/cli/clilog/clilog_test.go b/cli/clilog/clilog_test.go
@@ -2,7 +2,6 @@ package clilog_test
 
 import (
 	"encoding/json"
-	"io/fs"
 	"os"
 	"path/filepath"
 	"strings"
@@ -145,30 +144,6 @@ func TestBuilder(t *testing.T) {
 			assertLogsJSON(t, tempJSON, info, infoLog, warn, warnLog)
 		})
 	})
-
-	t.Run("NotFound", func(t *testing.T) {
-		t.Parallel()
-
-		tempFile := filepath.Join(t.TempDir(), "doesnotexist", "test.log")
-		cmd := &serpent.Command{
-			Use: "test",
-			Handler: func(inv *serpent.Invocation) error {
-				logger, closeLog, err := clilog.New(
-					clilog.WithFilter("foo", "baz"),
-					clilog.WithHuman(tempFile),
-					clilog.WithVerbose(),
-				).Build(inv)
-				if err != nil {
-					return err
-				}
-				defer closeLog()
-				logger.Error(inv.Context(), "you will never see this")
-				return nil
-			},
-		}
-		err := cmd.Invoke().Run()
-		require.ErrorIs(t, err, fs.ErrNotExist)
-	})
 }
 
 var (
