log: define G() as a function instead of a variable

thaJeztah · thaJeztah · commit dbbe28b7d1cc · 2023-08-24T00:28:58.000+02:00
The `G` variable is exported, and not expected to be overwritten externally. Defining it as a function also documents it as a function on https://pkg.go.dev, instead of a variable; https://pkg.go.dev/github.com/containerd/containerd@v1.6.22/log#pkg-variables Note that (while the godoc suggests otherwise) I made `GetLogger` an alias for `G`, as `G` is the most commonly used function (not the other way round), although I don't think there's a performance gain in doing so. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 778ac30) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
diff --git a/log/context.go b/log/context.go
@@ -23,16 +23,8 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-var (
-	// G is an alias for GetLogger.
-	//
-	// We may want to define this locally to a package to get package tagged log
-	// messages.
-	G = GetLogger
-
-	// L is an alias for the standard logger.
-	L = logrus.NewEntry(logrus.StandardLogger())
-)
+// L is an alias for the standard logger.
+var L = logrus.NewEntry(logrus.StandardLogger())
 
 type loggerKey struct{}
 
@@ -141,11 +133,13 @@ func WithLogger(ctx context.Context, logger *logrus.Entry) context.Context {
 // GetLogger retrieves the current logger from the context. If no logger is
 // available, the default logger is returned.
 func GetLogger(ctx context.Context) *logrus.Entry {
-	logger := ctx.Value(loggerKey{})
+	return G(ctx)
+}
 
-	if logger == nil {
-		return L.WithContext(ctx)
+// G is a shorthand for [GetLogger].
+func G(ctx context.Context) *logrus.Entry {
+	if logger := ctx.Value(loggerKey{}); logger != nil {
+		return logger.(*logrus.Entry)
 	}
-
-	return logger.(*logrus.Entry)
+	return L.WithContext(ctx)
 }
