Merge pull request #597 from onflow/janez/add-engine-name-to-starup

janezpodhostnik · web-flow · commit 870b11c5c702 · 2024-09-30T19:08:29.000+02:00
Add engine type to startup logs
diff --git a/bootstrap/bootstrap.go b/bootstrap/bootstrap.go
@@ -136,7 +136,7 @@ func (b *Bootstrap) StartEventIngestion(ctx context.Context) error {
 		b.collector,
 	)
 
-	startEngine(ctx, b.events, l)
+	StartEngine(ctx, b.events, l)
 	return nil
 }
 
@@ -160,7 +160,7 @@ func (b *Bootstrap) StartTraceDownloader(ctx context.Context) error {
 		b.collector,
 	)
 
-	startEngine(ctx, b.traces, l)
+	StartEngine(ctx, b.traces, l)
 	return nil
 }
 
@@ -373,23 +373,27 @@ func (b *Bootstrap) StopProfilerServer() {
 	}
 }
 
-// startEngine starts provided engine and panics if there are startup errors.
-func startEngine(
+// StartEngine starts provided engine and panics if there are startup errors.
+func StartEngine(
 	ctx context.Context,
 	engine models.Engine,
 	logger zerolog.Logger,
 ) {
-	logger.Info().Msg("starting engine")
+	l := logger.With().Type("engine", engine).Logger()
+
+	l.Info().Msg("starting engine")
+	start := time.Now()
 	go func() {
 		err := engine.Run(ctx)
 		if err != nil {
-			logger.Error().Err(err).Msg("engine failed to run")
-			panic(err)
+			l.Fatal().Err(err).Msg("engine failed to run")
 		}
 	}()
 
 	<-engine.Ready()
-	logger.Info().Msg("engine started successfully")
+	l.Info().
+		Dur("duration", time.Since(start)).
+		Msg("engine started successfully")
 }
 
 // setupCrossSporkClient sets up a cross-spork AN client.
diff --git a/go.mod b/go.mod
@@ -16,7 +16,7 @@ require (
 	github.com/onflow/go-ethereum v1.14.7
 	github.com/prometheus/client_golang v1.18.0
 	github.com/rs/cors v1.8.0
-	github.com/rs/zerolog v1.31.0
+	github.com/rs/zerolog v1.33.0
 	github.com/samber/slog-zerolog v1.0.0
 	github.com/sethvargo/go-limiter v1.0.0
 	github.com/sethvargo/go-retry v0.2.3
diff --git a/go.sum b/go.sum
@@ -1988,8 +1988,8 @@ github.com/rs/cors v1.7.0/go.mod h1:gFx+x8UowdsKA9AchylcLynDq+nNFfI8FkUZdN/jGCU=
 github.com/rs/cors v1.8.0 h1:P2KMzcFwrPoSjkF1WLRPsp3UMLyql8L4v9hQpVeK5so=
 github.com/rs/cors v1.8.0/go.mod h1:EBwu+T5AvHOcXwvZIkQFjUN6s8Czyqw12GL/Y0tUyRM=
 github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
-github.com/rs/zerolog v1.31.0 h1:FcTR3NnLWW+NnTwwhFWiJSZr4ECLpqCm6QsEnyvbV4A=
-github.com/rs/zerolog v1.31.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
+github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8=
+github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
 github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo=
 github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
diff --git a/tests/go.mod b/tests/go.mod
@@ -11,7 +11,7 @@ require (
 	github.com/onflow/flow-go v0.37.10
 	github.com/onflow/flow-go-sdk v1.0.0-preview.56
 	github.com/onflow/go-ethereum v1.14.7
-	github.com/rs/zerolog v1.31.0
+	github.com/rs/zerolog v1.33.0
 	github.com/stretchr/testify v1.9.0
 )
 
diff --git a/tests/go.sum b/tests/go.sum
@@ -2264,8 +2264,8 @@ github.com/rs/cors v1.7.0/go.mod h1:gFx+x8UowdsKA9AchylcLynDq+nNFfI8FkUZdN/jGCU=
 github.com/rs/cors v1.8.0 h1:P2KMzcFwrPoSjkF1WLRPsp3UMLyql8L4v9hQpVeK5so=
 github.com/rs/cors v1.8.0/go.mod h1:EBwu+T5AvHOcXwvZIkQFjUN6s8Czyqw12GL/Y0tUyRM=
 github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
-github.com/rs/zerolog v1.31.0 h1:FcTR3NnLWW+NnTwwhFWiJSZr4ECLpqCm6QsEnyvbV4A=
-github.com/rs/zerolog v1.31.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
+github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8=
+github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
 github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo=
 github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=

Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@ func (b *Bootstrap) StartEventIngestion(ctx context.Context) error {`
`136`	`136`	`b.collector,`
`137`	`137`	`)`
`138`	`138`
`139`		`- startEngine(ctx, b.events, l)`
	`139`	`+ StartEngine(ctx, b.events, l)`
`140`	`140`	`return nil`
`141`	`141`	`}`
`142`	`142`
`@@ -160,7 +160,7 @@ func (b *Bootstrap) StartTraceDownloader(ctx context.Context) error {`
`160`	`160`	`b.collector,`
`161`	`161`	`)`
`162`	`162`
`163`		`- startEngine(ctx, b.traces, l)`
	`163`	`+ StartEngine(ctx, b.traces, l)`
`164`	`164`	`return nil`
`165`	`165`	`}`
`166`	`166`
`@@ -373,23 +373,27 @@ func (b *Bootstrap) StopProfilerServer() {`
`373`	`373`	`}`
`374`	`374`	`}`
`375`	`375`
`376`		`-// startEngine starts provided engine and panics if there are startup errors.`
`377`		`-func startEngine(`
	`376`	`+// StartEngine starts provided engine and panics if there are startup errors.`
	`377`	`+func StartEngine(`
`378`	`378`	`ctx context.Context,`
`379`	`379`	`engine models.Engine,`
`380`	`380`	`logger zerolog.Logger,`
`381`	`381`	`) {`
`382`		`- logger.Info().Msg("starting engine")`
	`382`	`+ l := logger.With().Type("engine", engine).Logger()`
	`383`	`+`
	`384`	`+ l.Info().Msg("starting engine")`
	`385`	`+ start := time.Now()`
`383`	`386`	`go func() {`
`384`	`387`	`err := engine.Run(ctx)`
`385`	`388`	`if err != nil {`
`386`		`- logger.Error().Err(err).Msg("engine failed to run")`
`387`		`- panic(err)`
	`389`	`+ l.Fatal().Err(err).Msg("engine failed to run")`
`388`	`390`	`}`
`389`	`391`	`}()`
`390`	`392`
`391`	`393`	`<-engine.Ready()`
`392`		`- logger.Info().Msg("engine started successfully")`
	`394`	`+ l.Info().`
	`395`	`+ Dur("duration", time.Since(start)).`
	`396`	`+ Msg("engine started successfully")`
`393`	`397`	`}`
`394`	`398`
`395`	`399`	`// setupCrossSporkClient sets up a cross-spork AN client.`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ require (`
`11`	`11`	`github.com/onflow/flow-go v0.37.10`
`12`	`12`	`github.com/onflow/flow-go-sdk v1.0.0-preview.56`
`13`	`13`	`github.com/onflow/go-ethereum v1.14.7`
`14`		`- github.com/rs/zerolog v1.31.0`
	`14`	`+ github.com/rs/zerolog v1.33.0`
`15`	`15`	`github.com/stretchr/testify v1.9.0`
`16`	`16`	`)`
`17`	`17`