Logging improvements: write to console and file

.gitignore

@@ -39,3 +39,6 @@ temp/
 # example: *tfplan*
 
 # Ignore CLI configuration files!/temp/
+
+
+dorkly.log

cmd/dorkly/main.go

@@ -24,7 +24,7 @@ func main() {
 	ctx := context.Background()
 	dorklyYamlInputPath := os.Getenv(dorklyYamlEnvVar)
 	if dorklyYamlInputPath == "" {
-		logger.Infof("Env var [%s] not set. Using default: %s", dorklyYamlEnvVar, defaultDorklyYamlInputPath)
+		logger.Debugf("Env var [%s] not set. Using default: %s", dorklyYamlEnvVar, defaultDorklyYamlInputPath)
 		dorklyYamlInputPath = defaultDorklyYamlInputPath
 	}
 
@@ -68,5 +68,5 @@ func logAwsCallerIdentity(awsConfig aws.Config, ctx context.Context) {
 	if err != nil {
 		logger.Fatal(err)
 	}
-	logger.Infof("AWS Identity: %v", string(jsonBytes))
+	logger.Debugf("AWS Identity: %v", string(jsonBytes))
 }

internal/dorkly/logger.go

@@ -3,19 +3,41 @@ package dorkly
 import (
 	"fmt"
 	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+	"os"
 )
 
 var (
 	logger = newLogger()
 )
 
 func newLogger() *zap.SugaredLogger {
-	logger, err := zap.NewDevelopment()
+	fileLoggerConfig := zap.NewDevelopmentConfig()
+	fileLoggerConfig.OutputPaths = []string{"dorkly.log"}
+	fileLogger, err := fileLoggerConfig.Build()
 	if err != nil {
 		fmt.Println("failed to create logger: ", err)
 		panic(err)
 	}
-	return logger.Sugar()
+
+	consoleLoggerEncoderConfig := zapcore.EncoderConfig{
+		TimeKey:        "",
+		LevelKey:       "",
+		NameKey:        "",
+		CallerKey:      "",
+		FunctionKey:    zapcore.OmitKey,
+		MessageKey:     "msg",
+		StacktraceKey:  "",
+		LineEnding:     zapcore.DefaultLineEnding,
+		EncodeLevel:    zapcore.LowercaseLevelEncoder,
+		EncodeTime:     zapcore.EpochTimeEncoder,
+		EncodeDuration: zapcore.SecondsDurationEncoder,
+		EncodeCaller:   zapcore.ShortCallerEncoder,
+	}
+	consoleLogger := zapcore.NewCore(zapcore.NewConsoleEncoder(consoleLoggerEncoderConfig), zapcore.AddSync(os.Stdout), zapcore.InfoLevel)
+
+	tee := zapcore.NewTee(fileLogger.Core(), consoleLogger)
+	return zap.New(tee).Sugar()
 }
 
 func GetLogger() *zap.SugaredLogger {

internal/dorkly/reconcile.go

@@ -62,7 +62,7 @@ func (r *Reconciler) Reconcile(ctx context.Context) error {
 	}
 
 	var reconciledArchive RelayArchive
-	err = runStep("Reconcile existing archive and local yaml project files into reconciled archive", func() error {
+	err = runStep("Merge existing archive and local yaml project files into reconciled archive", func() error {
 		var err error
 		reconciledArchive, err = reconcile(*existingArchive, *newArchive)
 		return err
@@ -155,8 +155,12 @@ func reconcile(old, new RelayArchive) (RelayArchive, error) {
 
 // runStep utilizes GitHub Actions' log grouping feature:
 // https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines
+// Ideally these would be collapsed by default, but that's not possible with the current implementation:
+// https://www.google.com/search?q=github+grouping+log+lines+collapse+by+default
 func runStep(step string, f func() error) error {
 	//fmt.Printf("\n[%s] BEGIN\n", step)
+	// For now we use the logger because it is the only way to guarantee that the log lines are grouped:
+	// fmt.Printf() produces out of order log lines causing malformed groups.
 	logger.Infof("\n::group::%s", step)
 	logger.Infof("Starting step: %s", step)
 	err := f()