change formatter

Author: Inspector-Butters

beacon-chain/light-client/log.go

@@ -0,0 +1,6 @@
+### Changed
+
+- Added a log.go file for every important package with a logger variable containing a `package` field set to the package
+  path.
+- Added a CI check to ensure every important package has a log.go file with the correct `package` field.
+- Changed the log formatter to use this `package` field instead of the previous `prefix` field.

changelog/bastin_switch-logging-to-packaga-path.md

@@ -134,7 +134,7 @@ package $pkg_name
 import "github.com/sirupsen/logrus"
 
 // The prefix for logs from this package will be the text after the last slash in the package path.
-// If you wish to change this, you should add your desired name in the X/X/X/log.go file.
+// If you wish to change this, you should add your desired name in the runtime/logging/logrus-prefixed-formatter/prefix-replacement.go file.
 var log = logrus.WithField("package", "$rel_path")
 EOF
 

hack/gen-logs.sh

@@ -2,7 +2,10 @@ load("@prysm//tools/go:def.bzl", "go_library", "go_test")
 
 go_library(
     name = "go_default_library",
-    srcs = ["formatter.go"],
+    srcs = [
+        "formatter.go",
+        "prefix-replacements.go",
+    ],
     importpath = "github.com/OffchainLabs/prysm/v7/runtime/logging/logrus-prefixed-formatter",
     visibility = ["//visibility:public"],
     deps = [

runtime/logging/logrus-prefixed-formatter/BUILD.bazel

@@ -19,6 +19,8 @@ import (
 
 const defaultTimestampFormat = time.RFC3339
 
+var regex = regexp.MustCompile(`^\\[(.*?)\\]`)
+
 var (
 	baseTimestamp      time.Time    = time.Now()
 	defaultColorScheme *ColorScheme = &ColorScheme{
@@ -263,17 +265,11 @@ func (f *TextFormatter) printColored(b *bytes.Buffer, entry *logrus.Entry, keys
 	}
 
 	level := levelColor(fmt.Sprintf("%5s", levelText))
-	prefix := ""
-	message := entry.Message
 
-	if prefixValue, ok := entry.Data["prefix"]; ok {
-		prefix = colorScheme.PrefixColor(" " + prefixValue.(string) + ":")
-	} else {
-		prefixValue, trimmedMsg := extractPrefix(entry.Message)
-		if len(prefixValue) > 0 {
-			prefix = colorScheme.PrefixColor(" " + prefixValue + ":")
-			message = trimmedMsg
-		}
+	prefix := ""
+	prefixValue, message := getPrefixAndMessage(entry)
+	if len(prefixValue) > 0 {
+		prefix = colorScheme.PrefixColor(" " + prefixValue + ":")
 	}
 
 	messageFormat := "%s"
@@ -293,7 +289,7 @@ func (f *TextFormatter) printColored(b *bytes.Buffer, entry *logrus.Entry, keys
 		_, err = fmt.Fprintf(b, "%s %s%s "+messageFormat, colorScheme.TimestampColor(timestamp), level, prefix, message)
 	}
 	for _, k := range keys {
-		if k != "prefix" {
+		if k != "package" {
 			v := entry.Data[k]
 
 			format := "%+v"
@@ -333,9 +329,39 @@ func (f *TextFormatter) needsQuoting(text string) bool {
 	return false
 }
 
+// getPrefixAndMessage extracts the prefix and the message from the entry by the following order:
+//  1. If the "prefix" field is set in entry.Data, use that as prefix.
+//  2. If the "package" field is set in entry.Data, use that to determine the prefix.
+//     If a replacement is found in prefixReplacements, use that. Otherwise, use the package name.
+//  3. Try to extract the prefix from the message itself by looking for a pattern like "[prefix] message".
+//  4. If none of the above methods yield a prefix, return an empty prefix and the original message.
+func getPrefixAndMessage(entry *logrus.Entry) (string, string) {
+	prefix := ""
+	msg := entry.Message
+
+	if prefixOldMethod, ok := entry.Data["prefix"]; ok {
+		return prefixOldMethod.(string), msg
+	}
+
+	if packagePath, ok := entry.Data["package"]; ok {
+		if prefixReplacement, ok := prefixReplacements[packagePath.(string)]; ok {
+			return prefixReplacement, msg
+		}
+		pathSplit := strings.Split(packagePath.(string), "/")
+		prefix = pathSplit[len(pathSplit)-1]
+		return prefix, msg
+	}
+
+	if prefixExtracted, trimmedMsg := extractPrefix(msg); len(prefixExtracted) > 0 {
+		return prefixExtracted, trimmedMsg
+	}
+
+	return "", msg
+}
+
 func extractPrefix(msg string) (string, string) {
 	prefix := ""
-	regex := regexp.MustCompile(`^\\[(.*?)\\]`)
+
 	if regex.MatchString(msg) {
 		match := regex.FindString(msg)
 		prefix, msg = match[1:len(match)-1], strings.TrimSpace(msg[len(match):])

runtime/logging/logrus-prefixed-formatter/formatter.go

@@ -0,0 +1,24 @@
+package prefixed
+
+var prefixReplacements = map[string]string{
+	"beacon-chain/cache/depositsnapshot":              "cache",
+	"beacon-chain/core/transition":                    "state",
+	"beacon-chain/db/kv":                              "db",
+	"beacon-chain/db/slasherkv":                       "slasherdb",
+	"beacon-chain/db/pruner":                          "db-pruner",
+	"beacon-chain/rpc/core":                           "rpc/core",
+	"beacon-chain/rpc/eth/beacon":                     "rpc/beacon",
+	"beacon-chain/rpc/eth/validator":                  "beacon-api",
+	"beacon-chain/rpc/prysm/v1alpha1/beacon":          "rpc",
+	"beacon-chain/rpc/prysm/v1alpha1/validator":       "rpc/validator",
+	"beacon-chain/sync/checkpoint":                    "checkpoint-sync",
+	"config/features":                                 "flags",
+	"proto/prysm/v1alpha1":                            "protobuf",
+	"validator/db/kv":                                 "db",
+	"validator/db/filesystem":                         "db",
+	"validator/keymanager/derived":                    "derived-keymanager",
+	"validator/keymanager/local":                      "local-keymanager",
+	"validator/keymanager/remote-web3signer":          "remote-keymanager",
+	"validator/keymanager/remote-web3signer/internal": "remote-keymanager-internal",
+	"beacon-chain/forkchoice/doubly-linked-tree":      "forkchoice-doublylinkedtree",
+}