feat: Add invocation-id to all log statements (#17087)

bbernays · web-flow · commit 7154f9eb9fcc · 2024-03-11T17:03:37.000Z
#### Summary


This change will retain the same uuid for all source/destinations in the same sync rather than a unique sync id per source

example:
```
{"level":"info","module":"cli","log-id":"7871e9f8-c747-4f44-98e0-a32d216e503c","args":["config.yml"],"time":"2024-03-06T23:47:49Z","message":"Loading spec(s)"}
```
diff --git a/cli/cmd/logging.go b/cli/cmd/logging.go
@@ -48,6 +48,6 @@ func initLogging(noLogFile bool, logLevel *enum.Enum, logFormat *enum.Enum, logC
 		}
 	}
 	mw := io.MultiWriter(writers...)
-	log.Logger = zerolog.New(mw).Level(zerologLevel).With().Str("module", "cli").Timestamp().Logger()
+	log.Logger = zerolog.New(mw).Level(zerologLevel).With().Str("module", "cli").Str("invocation-id", invocationUUID.String()).Timestamp().Logger()
 	return logFile, nil
 }
diff --git a/cli/cmd/root.go b/cli/cmd/root.go
@@ -5,6 +5,7 @@ import (
 	"os"
 	"time"
 
+	"github.com/google/uuid"
 	"github.com/rs/zerolog"
 
 	"github.com/cloudquery/cloudquery/cli/internal/enum"
@@ -29,6 +30,7 @@ Find more information at:
 	disableSentry   = false
 	analyticsClient *AnalyticsClient
 	logFile         *os.File
+	invocationUUID  uuid.UUID
 )
 
 func NewCmdRoot() *cobra.Command {
@@ -67,6 +69,12 @@ func NewCmdRoot() *cobra.Command {
 			// PersistentPreRunE runs after argument parsing, so errors during parsing will result in printing the help
 			cmd.SilenceUsage = true
 			var err error
+
+			invocationUUID, err = uuid.NewRandom()
+			if err != nil {
+				return fmt.Errorf("failed to generate invocation uuid: %w", err)
+			}
+
 			if logFile, err = initLogging(noLogFile, logLevel, logFormat, logConsole, logFileName); err != nil {
 				return err
 			}
diff --git a/cli/cmd/sync.go b/cli/cmd/sync.go
@@ -7,8 +7,6 @@ import (
 	"slices"
 	"strings"
 
-	"github.com/google/uuid"
-
 	apiAuth "github.com/cloudquery/cloudquery-api-go/auth"
 	"github.com/cloudquery/cloudquery/cli/internal/auth"
 	"github.com/cloudquery/cloudquery/cli/internal/specs/v0"
@@ -105,10 +103,6 @@ func sync(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("failed to load spec(s) from %s. Error: %w", strings.Join(args, ", "), err)
 	}
 
-	invocationUUID, err := uuid.NewRandom()
-	if err != nil {
-		return fmt.Errorf("failed to generate invocation uuid: %w", err)
-	}
 	sources := specReader.Sources
 	destinations := specReader.Destinations
 	sourcePluginClients := make(managedplugin.Clients, 0)

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,6 @@ func initLogging(noLogFile bool, logLevel enum.Enum, logFormat enum.Enum, logC`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`	`mw := io.MultiWriter(writers...)`
`51`		`- log.Logger = zerolog.New(mw).Level(zerologLevel).With().Str("module", "cli").Timestamp().Logger()`
	`51`	`+ log.Logger = zerolog.New(mw).Level(zerologLevel).With().Str("module", "cli").Str("invocation-id", invocationUUID.String()).Timestamp().Logger()`
`52`	`52`	`return logFile, nil`
`53`	`53`	`}`