feat : color logger

Signed-off-by: Archisman <[email protected]>

Author: Archisman-Mridha

README.md

@@ -91,3 +91,5 @@ If you want to delete the provisioned cluster, then execute : `make delete-provi
 - [How can you call a helm 'helper' template from a subchart with the correct context?](https://stackoverflow.com/questions/47791971/how-can-you-call-a-helm-helper-template-from-a-subchart-with-the-correct-conte)
 
 - [IRSA for non EKS Clusters | PlatformCon 2023](https://www.youtube.com/watch?v=otmLHWW3Tos)
+
+- [Logging in Go with Slog: The Ultimate Guide](https://betterstack.com/community/guides/logging/logging-in-go/)

flake.nix

@@ -85,7 +85,6 @@
               azure-cli
 
               k9s
-              go-task
             ];
         };
       }

go.mod

@@ -19,6 +19,7 @@ require (
 	github.com/aws/aws-sdk-go-v2/service/s3 v1.78.2
 	github.com/aws/aws-sdk-go-v2/service/sts v1.33.17
 	github.com/creasty/defaults v1.8.0
+	github.com/fatih/color v1.18.0
 	github.com/go-git/go-git/v5 v5.14.0
 	github.com/go-logr/logr v1.4.2
 	github.com/go-playground/validator/v10 v10.25.0
@@ -114,7 +115,6 @@ require (
 	github.com/evanphx/json-patch/v5 v5.9.11 // indirect
 	github.com/exponent-io/jsonpath v0.0.0-20210407135951-1de76d718b3f // indirect
 	github.com/fatih/camelcase v1.0.0 // indirect
-	github.com/fatih/color v1.18.0 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/fsnotify/fsnotify v1.8.0 // indirect
 	github.com/fvbommel/sortorder v1.1.0 // indirect

pkg/utils/kubernetes/helm.go

@@ -25,7 +25,9 @@ type HelmInstallArgs struct {
 // We clone the KubeAid repository locally and then use absolute path to one of it's Helm chart
 // (like argo-cd / sealed-secrets), to install that corresponding Helm chart.
 func HelmInstall(ctx context.Context, args *HelmInstallArgs) {
-	ctx = logger.AppendSlogAttributesToCtx(ctx, []slog.Attr{slog.String("release-name", args.ReleaseName)})
+	ctx = logger.AppendSlogAttributesToCtx(ctx, []slog.Attr{
+		slog.String("release-name", args.ReleaseName),
+	})
 
 	settings := cli.New()
 

pkg/utils/logger/logger.go

@@ -31,7 +31,13 @@ func InitLogger(isDebugModeEnabled bool) {
 		},
 	})
 
-	logger := slog.New(withContextualSlogAttributesHandler(textHandler))
+	logger := slog.New(
+		withContextualSlogAttributesHandler(withColorHandler(
+			os.Stderr,
+			textHandler,
+			isDebugModeEnabled,
+		)),
+	)
 	slog.SetDefault(logger)
 
 	// Initialize controller-runtime's (or kubebuilder's) base logger with the default slog logger.

pkg/utils/logger/with_color_handler.go

@@ -0,0 +1,66 @@
+package logger
+
+import (
+	"context"
+	"fmt"
+	"io"
+	"log"
+	"log/slog"
+
+	"github.com/fatih/color"
+)
+
+type ColorHandler struct {
+	slog.Handler
+	logLogger          *log.Logger
+	isDebugModeEnabled bool
+}
+
+func (c *ColorHandler) Handle(ctx context.Context, record slog.Record) error {
+	logParts := []any{}
+
+	// Time (only shown in debug mode).
+	if c.isDebugModeEnabled {
+		logParts = append(logParts,
+			fmt.Sprintf("(%s)", record.Time.Format("15:04")),
+		)
+	}
+
+	// Log level.
+	logLevel := record.Level.String() + " :"
+	switch record.Level {
+	case slog.LevelDebug:
+		logLevel = color.MagentaString(logLevel)
+	case slog.LevelInfo:
+		logLevel = color.GreenString(logLevel)
+	case slog.LevelWarn:
+		logLevel = color.YellowString(logLevel)
+	case slog.LevelError:
+		logLevel = color.RedString(logLevel)
+	}
+	logParts = append(logParts, logLevel)
+
+	// Message.
+	message := color.WhiteString(record.Message)
+	logParts = append(logParts, message)
+
+	// Attributes.
+	record.Attrs(func(attribute slog.Attr) bool {
+		logParts = append(logParts,
+			fmt.Sprintf("%s=%s", color.CyanString(attribute.Key), attribute.Value.String()),
+		)
+
+		return true
+	})
+
+	c.logLogger.Println(logParts...)
+	return nil
+}
+
+func withColorHandler(out io.Writer, handler slog.Handler, isDebugModeEnabled bool) *ColorHandler {
+	return &ColorHandler{
+		Handler:            handler,
+		logLogger:          log.New(out, "", 0),
+		isDebugModeEnabled: isDebugModeEnabled,
+	}
+}