op-service: make global log handler override explicit

endpoint-monitor/endpoint_monitor.go

@@ -34,6 +34,7 @@ func Main(version string) func(cliCtx *cli.Context) error {
 		}
 
 		l := oplog.NewLogger(oplog.AppOut(cliCtx), cfg.LogConfig)
+		oplog.SetGlobalLogHandler(l.GetHandler())
 
 		endpointMonitor := NewEndpointMonitor(cfg, l)
 		l.Info(fmt.Sprintf("starting endpoint monitor with checkInterval=%s checkDuration=%s", cfg.CheckInterval, cfg.CheckDuration))

indexer/cmd/indexer/cli.go

@@ -5,7 +5,7 @@ import (
 	"github.com/ethereum-optimism/optimism/indexer/api"
 	"github.com/ethereum-optimism/optimism/indexer/config"
 	"github.com/ethereum-optimism/optimism/indexer/database"
-	"github.com/ethereum-optimism/optimism/op-service/log"
+	oplog "github.com/ethereum-optimism/optimism/op-service/log"
 	"github.com/ethereum/go-ethereum/params"
 
 	"github.com/urfave/cli/v2"
@@ -28,7 +28,8 @@ var (
 )
 
 func runIndexer(ctx *cli.Context) error {
-	log := log.NewLogger(log.AppOut(ctx), log.ReadCLIConfig(ctx)).New("role", "indexer")
+	log := oplog.NewLogger(oplog.AppOut(ctx), oplog.ReadCLIConfig(ctx)).New("role", "indexer")
+	oplog.SetGlobalLogHandler(log.GetHandler())
 	cfg, err := config.LoadConfig(log, ctx.String(ConfigFlag.Name))
 	if err != nil {
 		log.Error("failed to load config", "err", err)
@@ -52,7 +53,8 @@ func runIndexer(ctx *cli.Context) error {
 }
 
 func runApi(ctx *cli.Context) error {
-	log := log.NewLogger(log.AppOut(ctx), log.ReadCLIConfig(ctx)).New("role", "api")
+	log := oplog.NewLogger(oplog.AppOut(ctx), oplog.ReadCLIConfig(ctx)).New("role", "api")
+	oplog.SetGlobalLogHandler(log.GetHandler())
 	cfg, err := config.LoadConfig(log, ctx.String(ConfigFlag.Name))
 	if err != nil {
 		log.Error("failed to load config", "err", err)
@@ -71,7 +73,8 @@ func runApi(ctx *cli.Context) error {
 }
 
 func runMigrations(ctx *cli.Context) error {
-	log := log.NewLogger(log.AppOut(ctx), log.ReadCLIConfig(ctx)).New("role", "api")
+	log := oplog.NewLogger(oplog.AppOut(ctx), oplog.ReadCLIConfig(ctx)).New("role", "api")
+	oplog.SetGlobalLogHandler(log.GetHandler())
 	cfg, err := config.LoadConfig(log, ctx.String(ConfigFlag.Name))
 	migrationsDir := ctx.String(MigrationsFlag.Name)
 	if err != nil {
@@ -91,9 +94,9 @@ func runMigrations(ctx *cli.Context) error {
 
 func newCli(GitCommit string, GitDate string) *cli.App {
 	flags := []cli.Flag{ConfigFlag}
-	flags = append(flags, log.CLIFlags("INDEXER")...)
+	flags = append(flags, oplog.CLIFlags("INDEXER")...)
 	migrationFlags := []cli.Flag{MigrationsFlag, ConfigFlag}
-	migrationFlags = append(migrationFlags, log.CLIFlags("INDEXER")...)
+	migrationFlags = append(migrationFlags, oplog.CLIFlags("INDEXER")...)
 	return &cli.App{
 		Version:              params.VersionWithCommit(GitCommit, GitDate),
 		Description:          "An indexer of all optimism events with a serving api layer",

op-batcher/batcher/batch_submitter.go

@@ -29,6 +29,7 @@ func Main(version string, cliCtx *cli.Context) error {
 	cfg := NewConfig(cliCtx)
 
 	l := oplog.NewLogger(oplog.AppOut(cliCtx), cfg.LogConfig)
+	oplog.SetGlobalLogHandler(l.GetHandler())
 	opservice.ValidateEnvVars(flags.EnvVarPrefix, flags.Flags, l)
 	m := metrics.NewMetrics("default")
 	l.Info("Initializing Batch Submitter")

op-bootnode/bootnode/entrypoint.go

@@ -44,6 +44,7 @@ func Main(cliCtx *cli.Context) error {
 	log.Info("Initializing bootnode")
 	logCfg := oplog.ReadCLIConfig(cliCtx)
 	logger := oplog.NewLogger(oplog.AppOut(cliCtx), logCfg)
+	oplog.SetGlobalLogHandler(logger.GetHandler())
 	m := metrics.NewMetrics("default")
 	ctx := context.Background()
 

op-challenger/cmd/main.go

@@ -71,5 +71,6 @@ func run(args []string, action ConfigAction) error {
 func setupLogging(ctx *cli.Context) (log.Logger, error) {
 	logCfg := oplog.ReadCLIConfig(ctx)
 	logger := oplog.NewLogger(oplog.AppOut(ctx), logCfg)
+	oplog.SetGlobalLogHandler(logger.GetHandler())
 	return logger, nil
 }

op-heartbeat/service.go

@@ -38,6 +38,7 @@ func Main(version string) func(ctx *cli.Context) error {
 		}
 
 		l := oplog.NewLogger(oplog.AppOut(cliCtx), cfg.Log)
+		oplog.SetGlobalLogHandler(l.GetHandler())
 		l.Info("starting heartbeat monitor", "version", version)
 
 		ctx, cancel := context.WithCancel(context.Background())

op-node/cmd/main.go

@@ -84,6 +84,7 @@ func RollupNodeMain(ctx *cli.Context) error {
 	log.Info("Initializing Rollup Node")
 	logCfg := oplog.ReadCLIConfig(ctx)
 	log := oplog.NewLogger(oplog.AppOut(ctx), logCfg)
+	oplog.SetGlobalLogHandler(log.GetHandler())
 	opservice.ValidateEnvVars(flags.EnvVarPrefix, flags.Flags, log)
 	m := metrics.NewMetrics("default")
 

op-program/client/cmd/main.go

@@ -17,5 +17,6 @@ func main() {
 		Format: oplog.FormatLogFmt,
 		Color:  false,
 	})
+	oplog.SetGlobalLogHandler(logger.GetHandler())
 	client.Main(logger)
 }

op-program/host/cmd/main.go

@@ -75,5 +75,6 @@ func run(args []string, action ConfigAction) error {
 func setupLogging(ctx *cli.Context) (log.Logger, error) {
 	logCfg := oplog.ReadCLIConfig(ctx)
 	logger := oplog.NewLogger(oplog.AppOut(ctx), logCfg)
+	oplog.SetGlobalLogHandler(logger.GetHandler())
 	return logger, nil
 }

op-proposer/proposer/l2_output_submitter.go

@@ -44,6 +44,7 @@ func Main(version string, cliCtx *cli.Context) error {
 	}
 
 	l := oplog.NewLogger(oplog.AppOut(cliCtx), cfg.LogConfig)
+	oplog.SetGlobalLogHandler(l.GetHandler())
 	opservice.ValidateEnvVars(flags.EnvVarPrefix, flags.Flags, l)
 	m := metrics.NewMetrics("default")
 	l.Info("Initializing L2 Output Submitter")

op-service/log/cli.go

@@ -159,6 +159,15 @@ func NewLogger(wr io.Writer, cfg CLIConfig) log.Logger {
 	return logger
 }
 
+// SetGlobalLogHandler sets the log handles as the handler of the global default logger.
+// The usage of this logger is strongly discouraged,
+// as it does makes it difficult to distinguish different services in the same process, e.g. during tests.
+// Geth and other components may use the global logger however,
+// and it is thus recommended to set the global log handler to catch these logs.
+func SetGlobalLogHandler(h log.Handler) {
+	log.Root().SetHandler(h)
+}
+
 // DefaultCLIConfig creates a default log configuration.
 // Color defaults to true if terminal is detected.
 func DefaultCLIConfig() CLIConfig {

op-wheel/commands.go

@@ -399,6 +399,7 @@ var (
 		Action: EngineAction(func(ctx *cli.Context, client client.RPC) error {
 			logCfg := oplog.ReadCLIConfig(ctx)
 			l := oplog.NewLogger(oplog.AppOut(ctx), logCfg)
+			oplog.SetGlobalLogHandler(l.GetHandler())
 
 			settings := ParseBuildingArgs(ctx)
 			// TODO: finalize/safe flag