log: Do not export InitializeDefaultLogger function

[ upstream commit 00ab252 ]

[ Backporter's notes: ignoring changes from cilium#26327 ]

The DefaultLogger variable in the logging module serves as a parent logger
which all other loggers can be derived from. It is initialized using the
InitializeDefaultLogger function and then adjusted on startup based on
user configuration. Users should not call InitializeDefaultLogger to
create a parent logger for their logger, since the logger returned by
InitializeDefaultLogger will always use the hardcoded defaults. For
example, the logger returned will always be of level INFO, even if a user
has enabled debug logging. To make this clear, this commit renames
InitializeDefaultLogger to initializeDefaultLogger to signal that it should
not be used outside of the logging module.

Fixes: cilium#29215

Signed-off-by: Ryan Drew <[email protected]>

Author: learnitall

pkg/endpoint/log.go

@@ -91,22 +91,9 @@ func (e *Endpoint) UpdateLogger(fields map[string]interface{}) {
 		return
 	}
 
-	// default to a new default logger
-	baseLogger := logging.InitializeDefaultLogger()
-
-	// If this endpoint is set to debug ensure it will print debug by giving it
-	// an independent logger
-	if e.Options != nil && e.Options.IsEnabled(option.Debug) {
-		baseLogger.SetLevel(logrus.DebugLevel)
-	} else {
-		// Debug mode takes priority; if not in debug, check what log level user
-		// has set and set the endpoint's log to log at that level.
-		baseLogger.SetLevel(logging.DefaultLogger.Level)
-	}
-
 	// When adding new fields, make sure they are abstracted by a setter
 	// and update the logger when the value is set.
-	l := baseLogger.WithFields(logrus.Fields{
+	f := logrus.Fields{
 		logfields.LogSubsys:              subsystem,
 		logfields.EndpointID:             e.ID,
 		logfields.ContainerID:            e.getShortContainerIDLocked(),
@@ -115,13 +102,23 @@ func (e *Endpoint) UpdateLogger(fields map[string]interface{}) {
 		logfields.IPv4:                   e.GetIPv4Address(),
 		logfields.IPv6:                   e.GetIPv6Address(),
 		logfields.K8sPodName:             e.GetK8sNamespaceAndPodName(),
-	})
+	}
 
 	if e.SecurityIdentity != nil {
-		l = l.WithField(logfields.Identity, e.SecurityIdentity.ID.StringID())
+		f[logfields.Identity] = e.SecurityIdentity.ID.StringID()
+	}
+
+	// Inherit properties from default logger.
+	baseLogger := logging.DefaultLogger.WithFields(f)
+
+	// If this endpoint is set to debug ensure it will print debug by giving it
+	// an independent logger.
+	// If this endpoint is not set to debug, it will use the log level set by the user.
+	if e.Options != nil && e.Options.IsEnabled(option.Debug) {
+		baseLogger.Logger.SetLevel(logrus.DebugLevel)
 	}
 
-	e.logger.Store(l)
+	e.logger.Store(baseLogger)
 }
 
 // Only to be called from UpdateLogger() above

pkg/endpoint/log_test.go

@@ -11,12 +11,33 @@ import (
 	. "github.com/cilium/checkmate"
 	"github.com/sirupsen/logrus"
 
+	"github.com/cilium/cilium/pkg/logging"
 	"github.com/cilium/cilium/pkg/option"
 	"github.com/cilium/cilium/pkg/policy"
 	testidentity "github.com/cilium/cilium/pkg/testutils/identity"
 	testipcache "github.com/cilium/cilium/pkg/testutils/ipcache"
 )
 
+func (s *EndpointSuite) TestEndpointLogFormat(c *C) {
+	// Default log format is text
+	do := &DummyOwner{repo: policy.NewPolicyRepository(nil, nil, nil, nil)}
+	ep := NewEndpointWithState(do, do, testipcache.NewMockIPCache(), nil, testidentity.NewMockIdentityAllocator(nil), 12345, StateReady)
+
+	_, ok := ep.getLogger().Logger.Formatter.(*logrus.TextFormatter)
+	c.Assert(ok, Equals, true)
+
+	// Log format is JSON when configured
+	logging.SetLogFormat(logging.LogFormatJSON)
+	defer func() {
+		logging.SetLogFormat(logging.LogFormatText)
+	}()
+	do = &DummyOwner{repo: policy.NewPolicyRepository(nil, nil, nil, nil)}
+	ep = NewEndpointWithState(do, do, testipcache.NewMockIPCache(), nil, testidentity.NewMockIdentityAllocator(nil), 12345, StateReady)
+
+	_, ok = ep.getLogger().Logger.Formatter.(*logrus.JSONFormatter)
+	c.Assert(ok, Equals, true)
+}
+
 func (s *EndpointSuite) TestPolicyLog(c *C) {
 	do := &DummyOwner{repo: policy.NewPolicyRepository(nil, nil, nil, nil)}
 	ep := NewEndpointWithState(do, do, testipcache.NewMockIPCache(), nil, testidentity.NewMockIdentityAllocator(nil), 12345, StateReady)

pkg/logging/logging.go

@@ -41,7 +41,7 @@ const (
 
 // DefaultLogger is the base logrus logger. It is different from the logrus
 // default to avoid external dependencies from writing out unexpectedly
-var DefaultLogger = InitializeDefaultLogger()
+var DefaultLogger = initializeDefaultLogger()
 
 func initializeKLog() {
 	log := DefaultLogger.WithField(logfields.LogSubsys, "klog")
@@ -73,8 +73,8 @@ func initializeKLog() {
 // LogOptions maps configuration key-value pairs related to logging.
 type LogOptions map[string]string
 
-// InitializeDefaultLogger returns a logrus Logger with a custom text formatter.
-func InitializeDefaultLogger() (logger *logrus.Logger) {
+// initializeDefaultLogger returns a logrus Logger with a custom text formatter.
+func initializeDefaultLogger() (logger *logrus.Logger) {
 	logger = logrus.New()
 	logger.SetFormatter(GetFormatter(DefaultLogFormat))
 	logger.SetLevel(DefaultLogLevel)