Unify the pattern of using a package-level logger (#8245)

Co-authored-by: Preston Van Loon <preston@prysmaticlabs.com>

beacon-chain/BUILD.bazel

@@ -8,6 +8,7 @@ load("@io_bazel_rules_docker//contrib:push-all.bzl", "docker_push")
 go_library(
     name = "go_default_library",
     srcs = [
+        "log.go",
         "main.go",
         "usage.go",
     ],

beacon-chain/cache/depositcache/BUILD.bazel

@@ -5,6 +5,7 @@ go_library(
     name = "go_default_library",
     srcs = [
         "deposits_cache.go",
+        "log.go",
         "pending_deposits.go",
     ],
     importpath = "github.com/prysmaticlabs/prysm/beacon-chain/cache/depositcache",

beacon-chain/cache/depositcache/deposits_cache.go

@@ -19,7 +19,7 @@ import (
 	"github.com/prysmaticlabs/prysm/shared/bytesutil"
 	"github.com/prysmaticlabs/prysm/shared/params"
 	"github.com/prysmaticlabs/prysm/shared/trieutil"
-	log "github.com/sirupsen/logrus"
+	"github.com/sirupsen/logrus"
 	"go.opencensus.io/trace"
 )
 
@@ -78,7 +78,7 @@ func (dc *DepositCache) InsertDeposit(ctx context.Context, d *ethpb.Deposit, blo
 	ctx, span := trace.StartSpan(ctx, "DepositsCache.InsertDeposit")
 	defer span.End()
 	if d == nil {
-		log.WithFields(log.Fields{
+		log.WithFields(logrus.Fields{
 			"block":        blockNum,
 			"deposit":      d,
 			"index":        index,

beacon-chain/cache/depositcache/log.go

@@ -0,0 +1,5 @@
+package depositcache
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.WithField("prefix", "depositcache")

beacon-chain/cache/depositcache/pending_deposits.go

@@ -10,7 +10,7 @@ import (
 	ethpb "github.com/prysmaticlabs/ethereumapis/eth/v1alpha1"
 	dbpb "github.com/prysmaticlabs/prysm/proto/beacon/db"
 	"github.com/prysmaticlabs/prysm/shared/hashutil"
-	log "github.com/sirupsen/logrus"
+	"github.com/sirupsen/logrus"
 	"go.opencensus.io/trace"
 )
 
@@ -33,7 +33,7 @@ func (dc *DepositCache) InsertPendingDeposit(ctx context.Context, d *ethpb.Depos
 	ctx, span := trace.StartSpan(ctx, "DepositsCache.InsertPendingDeposit")
 	defer span.End()
 	if d == nil {
-		log.WithFields(log.Fields{
+		log.WithFields(logrus.Fields{
 			"block":   blockNum,
 			"deposit": d,
 		}).Debug("Ignoring nil deposit insertion")

beacon-chain/core/state/BUILD.bazel

@@ -6,6 +6,7 @@ load("@io_bazel_rules_go//go:def.bzl", "go_test")
 go_library(
     name = "go_default_library",
     srcs = [
+        "log.go",
         "skip_slot_cache.go",
         "state.go",
         "transition.go",

beacon-chain/core/state/log.go

@@ -0,0 +1,5 @@
+package state
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.WithField("prefix", "state")

beacon-chain/core/state/transition.go

@@ -21,7 +21,6 @@ import (
 	"github.com/prysmaticlabs/prysm/shared/mathutil"
 	"github.com/prysmaticlabs/prysm/shared/params"
 	"github.com/prysmaticlabs/prysm/shared/traceutil"
-	"github.com/sirupsen/logrus"
 	"go.opencensus.io/trace"
 )
 
@@ -312,7 +311,7 @@ func ProcessSlots(ctx context.Context, state *stateTrie.BeaconState, slot uint64
 	defer func() {
 		if err := SkipSlotCache.MarkNotInProgress(key); err != nil {
 			traceutil.AnnotateError(span, err)
-			logrus.WithError(err).Error("Failed to mark skip slot no longer in progress")
+			log.WithError(err).Error("Failed to mark skip slot no longer in progress")
 		}
 	}()
 
@@ -322,7 +321,7 @@ func ProcessSlots(ctx context.Context, state *stateTrie.BeaconState, slot uint64
 			// Cache last best value.
 			if highestSlot < state.Slot() {
 				if err := SkipSlotCache.Put(ctx, key, state); err != nil {
-					logrus.WithError(err).Error("Failed to put skip slot cache value")
+					log.WithError(err).Error("Failed to put skip slot cache value")
 				}
 			}
 			return nil, ctx.Err()
@@ -347,7 +346,7 @@ func ProcessSlots(ctx context.Context, state *stateTrie.BeaconState, slot uint64
 
 	if highestSlot < state.Slot() {
 		if err := SkipSlotCache.Put(ctx, key, state); err != nil {
-			logrus.WithError(err).Error("Failed to put skip slot cache value")
+			log.WithError(err).Error("Failed to put skip slot cache value")
 			traceutil.AnnotateError(span, err)
 		}
 	}

beacon-chain/db/BUILD.bazel

@@ -12,6 +12,7 @@ go_library(
     srcs = [
         "alias.go",
         "cmd.go",
+        "log.go",
         "restore.go",
     ] + select({
         ":kafka_disabled": [

beacon-chain/db/cmd.go

@@ -3,7 +3,6 @@ package db
 import (
 	"github.com/prysmaticlabs/prysm/shared/cmd"
 	"github.com/prysmaticlabs/prysm/shared/tos"
-	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v2"
 )
 
@@ -23,7 +22,7 @@ var DatabaseCommands = &cli.Command{
 			Before: tos.VerifyTosAcceptedOrPrompt,
 			Action: func(cliCtx *cli.Context) error {
 				if err := restore(cliCtx); err != nil {
-					logrus.Fatalf("Could not restore database: %v", err)
+					log.Fatalf("Could not restore database: %v", err)
 				}
 				return nil
 			},

beacon-chain/db/kafka/BUILD.bazel

@@ -4,6 +4,7 @@ go_library(
     name = "go_default_library",
     srcs = [
         "export_wrapper.go",
+        "log.go",
         "passthrough.go",
     ],
     importpath = "github.com/prysmaticlabs/prysm/beacon-chain/db/kafka",

beacon-chain/db/kafka/export_wrapper.go

@@ -14,14 +14,12 @@ import (
 	"github.com/prysmaticlabs/prysm/beacon-chain/db/iface"
 	"github.com/prysmaticlabs/prysm/shared/featureconfig"
 	"github.com/prysmaticlabs/prysm/shared/traceutil"
-	"github.com/sirupsen/logrus"
 	"go.opencensus.io/trace"
 	"gopkg.in/confluentinc/confluent-kafka-go.v1/kafka"
 	_ "gopkg.in/confluentinc/confluent-kafka-go.v1/kafka/librdkafka" // Required for c++ kafka library.
 )
 
 var _ iface.Database = (*Exporter)(nil)
-var log = logrus.WithField("prefix", "exporter")
 var marshaler = &jsonpb.Marshaler{}
 
 // Exporter wraps a database interface and exports certain objects to kafka topics.

beacon-chain/db/kafka/log.go

@@ -0,0 +1,5 @@
+package kafka
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.WithField("prefix", "exporter")

beacon-chain/db/kv/BUILD.bazel

@@ -12,6 +12,7 @@ go_library(
         "encoding.go",
         "finalized_block_roots.go",
         "kv.go",
+        "log.go",
         "migration.go",
         "migration_archived_index.go",
         "migration_block_slot_index.go",

beacon-chain/db/kv/backup.go

@@ -8,7 +8,6 @@ import (
 	"github.com/pkg/errors"
 	"github.com/prysmaticlabs/prysm/shared/fileutil"
 	"github.com/prysmaticlabs/prysm/shared/params"
-	"github.com/sirupsen/logrus"
 	bolt "go.etcd.io/bbolt"
 	"go.opencensus.io/trace"
 )
@@ -43,7 +42,7 @@ func (s *Store) Backup(ctx context.Context, outputDir string) error {
 		return err
 	}
 	backupPath := path.Join(backupsDir, fmt.Sprintf("prysm_beacondb_at_slot_%07d.backup", head.Block.Slot))
-	logrus.WithField("prefix", "db").WithField("backup", backupPath).Info("Writing backup database.")
+	log.WithField("backup", backupPath).Info("Writing backup database.")
 
 	copyDB, err := bolt.Open(
 		backupPath,
@@ -55,13 +54,13 @@ func (s *Store) Backup(ctx context.Context, outputDir string) error {
 	}
 	defer func() {
 		if err := copyDB.Close(); err != nil {
-			logrus.WithError(err).Error("Failed to close backup database")
+			log.WithError(err).Error("Failed to close backup database")
 		}
 	}()
 
 	return s.db.View(func(tx *bolt.Tx) error {
 		return tx.ForEach(func(name []byte, b *bolt.Bucket) error {
-			logrus.Debugf("Copying bucket %s\n", name)
+			log.Debugf("Copying bucket %s\n", name)
 			return copyDB.Update(func(tx2 *bolt.Tx) error {
 				b2, err := tx2.CreateBucketIfNotExists(name)
 				if err != nil {

beacon-chain/db/kv/log.go

@@ -0,0 +1,5 @@
+package kv
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.WithField("prefix", "db")

beacon-chain/db/kv/state.go

@@ -10,7 +10,6 @@ import (
 	"github.com/prysmaticlabs/prysm/beacon-chain/state"
 	pb "github.com/prysmaticlabs/prysm/proto/beacon/p2p/v1"
 	"github.com/prysmaticlabs/prysm/shared/bytesutil"
-	log "github.com/sirupsen/logrus"
 	bolt "go.etcd.io/bbolt"
 	"go.opencensus.io/trace"
 )

beacon-chain/db/log.go

@@ -0,0 +1,5 @@
+package db
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.WithField("prefix", "db")

beacon-chain/db/restore.go

@@ -10,7 +10,6 @@ import (
 	"github.com/prysmaticlabs/prysm/shared/cmd"
 	"github.com/prysmaticlabs/prysm/shared/fileutil"
 	"github.com/prysmaticlabs/prysm/shared/promptutil"
-	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v2"
 )
 
@@ -30,7 +29,7 @@ func restore(cliCtx *cli.Context) error {
 			return errors.Wrap(err, "could not validate choice")
 		}
 		if strings.EqualFold(resp, "n") {
-			logrus.Info("Restore aborted")
+			log.Info("Restore aborted")
 			return nil
 		}
 	}
@@ -41,6 +40,6 @@ func restore(cliCtx *cli.Context) error {
 		return err
 	}
 
-	logrus.Info("Restore completed successfully")
+	log.Info("Restore completed successfully")
 	return nil
 }

beacon-chain/flags/BUILD.bazel

@@ -6,6 +6,7 @@ go_library(
         "base.go",
         "config.go",
         "interop.go",
+        "log.go",
     ],
     importpath = "github.com/prysmaticlabs/prysm/beacon-chain/flags",
     visibility = ["//beacon-chain:__subpackages__"],

beacon-chain/flags/config.go

@@ -2,7 +2,6 @@ package flags
 
 import (
 	"github.com/prysmaticlabs/prysm/shared/cmd"
-	log "github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v2"
 )
 

beacon-chain/flags/log.go

@@ -0,0 +1,5 @@
+package flags
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.WithField("prefix", "flags")

beacon-chain/gateway/server/BUILD.bazel

@@ -6,7 +6,10 @@ load("@io_bazel_rules_docker//contrib:push-all.bzl", "docker_push")
 
 go_library(
     name = "go_default_library",
-    srcs = ["main.go"],
+    srcs = [
+        "log.go",
+        "main.go",
+    ],
     importpath = "github.com/prysmaticlabs/prysm/beacon-chain/gateway/server",
     visibility = ["//visibility:private"],
     deps = [

beacon-chain/gateway/server/log.go

@@ -0,0 +1,5 @@
+package main
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.New()

beacon-chain/gateway/server/main.go

@@ -29,8 +29,6 @@ func init() {
 	logrus.SetFormatter(joonix.NewFormatter())
 }
 
-var log = logrus.New()
-
 func main() {
 	flag.Parse()
 	if *debug {

beacon-chain/log.go

@@ -0,0 +1,5 @@
+package main
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.WithField("prefix", "main")

beacon-chain/main.go

@@ -113,7 +113,6 @@ func init() {
 }
 
 func main() {
-	log := logrus.WithField("prefix", "main")
 	app := cli.App{}
 	app.Name = "beacon-chain"
 	app.Usage = "this is a beacon chain implementation for Ethereum 2.0"

beacon-chain/node/BUILD.bazel

@@ -5,6 +5,7 @@ go_library(
     name = "go_default_library",
     srcs = [
         "helper.go",
+        "log.go",
         "node.go",
     ],
     importpath = "github.com/prysmaticlabs/prysm/beacon-chain/node",

beacon-chain/node/log.go

@@ -0,0 +1,5 @@
+package node
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.WithField("prefix", "node")

beacon-chain/node/node.go

@@ -52,8 +52,6 @@ import (
 	"gopkg.in/yaml.v2"
 )
 
-var log = logrus.WithField("prefix", "node")
-
 const testSkipPowFlag = "test-skip-pow"
 
 // BeaconNode defines a struct that handles the services running a random beacon chain

beacon-chain/p2p/info.go

@@ -9,7 +9,6 @@ import (
 	"github.com/libp2p/go-libp2p-core/host"
 	"github.com/libp2p/go-libp2p-core/peer"
 	ma "github.com/multiformats/go-multiaddr"
-	"github.com/sirupsen/logrus"
 )
 
 // InfoHandler is a handler to serve /p2p page in metrics.
@@ -26,7 +25,7 @@ self=%s
 		len(s.host.Network().Peers()),
 		formatPeers(s.host), // Must be last. Writes one entry per row.
 	); err != nil {
-		logrus.WithError(err).Error("Failed to render p2p info page")
+		log.WithError(err).Error("Failed to render p2p info page")
 		return
 	}
 

beacon-chain/powchain/BUILD.bazel

@@ -7,6 +7,7 @@ go_library(
         "block_cache.go",
         "block_reader.go",
         "deposit.go",
+        "log.go",
         "log_processing.go",
         "service.go",
     ],

beacon-chain/powchain/log.go

@@ -0,0 +1,5 @@
+package powchain
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.WithField("prefix", "powchain")