[FAB-3009] Clean up core.yaml logging section

This CR handles a number of core.yaml cleanup operations for the
logging section. It removes unused parameters, adds new parameters for
the 'gossip' and 'ledger' modules (that will be utilized in a future
CR), and updates the comments (which were outdated). It also ensures
that 'logging.peer' is used to set the default log level when the
CORE_LOGGING_LEVEL environment variable is not set.

Change-Id: Ib94d4b991570536b4fb195b472f381c565fd13ba
Signed-off-by: Will Lahti <[email protected]>

Author: wlahti

peer/clilogging/common.go

@@ -18,8 +18,8 @@ package clilogging
 
 import (
 	"github.com/hyperledger/fabric/core/errors"
+	"github.com/hyperledger/fabric/peer/common"
 
-	"github.com/op/go-logging"
 	"github.com/spf13/cobra"
 )
 
@@ -44,10 +44,7 @@ func checkLoggingCmdParams(cmd *cobra.Command, args []string) error {
 			err = errors.ErrorWithCallstack("LOG", "400", "No log level provided.")
 		} else {
 			// check that log level is valid. if not, err is set
-			_, err = logging.LogLevel(args[1])
-			if err != nil {
-				err = errors.ErrorWithCallstack("LOG", "400", "Invalid log level provided - %s", args[1])
-			}
+			err = common.CheckLogLevel(args[1])
 		}
 	}
 

peer/clilogging/logging.go

@@ -26,7 +26,7 @@ import (
 
 const loggingFuncName = "logging"
 
-var logger = logging.MustGetLogger("loggingCmd")
+var logger = logging.MustGetLogger("cli/logging")
 
 // Cmd returns the cobra command for Logging
 func Cmd() *cobra.Command {

peer/common/common.go

@@ -28,6 +28,7 @@ import (
 	"github.com/hyperledger/fabric/msp"
 	mspmgmt "github.com/hyperledger/fabric/msp/mgmt"
 	pb "github.com/hyperledger/fabric/protos/peer"
+	logging "github.com/op/go-logging"
 	"github.com/spf13/viper"
 )
 
@@ -105,11 +106,31 @@ func SetLogLevelFromViper(module string) error {
 	var err error
 	if module != "" {
 		logLevelFromViper := viper.GetString("logging." + module)
+		err = CheckLogLevel(logLevelFromViper)
+		if err != nil {
+			if module == "error" {
+				// if 'logging.error' not found in core.yaml or an invalid level has
+				// been entered, set default to debug to ensure the callstack is
+				// appended to all CallStackErrors
+				logLevelFromViper = "debug"
+			} else {
+				return err
+			}
+		}
 		_, err = flogging.SetModuleLevel(module, logLevelFromViper)
 	}
 	return err
 }
 
+// CheckLogLevel checks that a given log level string is valid
+func CheckLogLevel(level string) error {
+	_, err := logging.LogLevel(level)
+	if err != nil {
+		err = errors.ErrorWithCallstack("LOG", "400", "Invalid log level provided - %s", level)
+	}
+	return err
+}
+
 // GetDefaultSigner return a default Signer(Default/PERR) for cli
 func GetDefaultSigner() (msp.SigningIdentity, error) {
 	signer, err := mspmgmt.GetLocalMSP().GetDefaultSigningIdentity()

peer/core.yaml

@@ -5,9 +5,8 @@
 ###############################################################################
 logging:
 
-    # Default logging levels are specified here for each of the three peer
-    # commands 'node', 'network' and 'chaincode'. For commands that have
-    # subcommands, the defaults also apply to all subcommands of the command.
+    # Default logging levels are specified here.
+
     # Valid logging levels are case-insensitive strings chosen from
 
     #     CRITICAL | ERROR | WARNING | NOTICE | INFO | DEBUG
@@ -21,22 +20,20 @@ logging:
     # 2. The environment variable CORE_LOGGING_LEVEL otherwise applies to
     #    all peer commands if defined as a non-empty string.
     #
-    # 3. The environment variables CORE_LOGGING_[NODE|NETWORK|CHAINCODE]
-    #    otherwise apply to the respective peer commands if defined as non-empty
-    #    strings.
-    #
-    # 4. Otherwise, the specifications below apply.
-    #
-    # Developers: Please see fabric/docs/Setup/logging-control.md for more
-    # options.
-    peer:       warning
-    node:       info
-    network:    warning
-    version:    warning
-    protoutils: debug
-    error:      warning
+    # 3. Otherwise, the specifications below apply.
+
+    # Default for all modules running within the scope of a peer
+    peer:       info
+
+    # Override levels for various 'peer' modules
+    gossip:     info
+    ledger:     info
     msp:        warning
 
+    # Error handling framework log level - when set to DEBUG, a callstack will
+    # be appended to all errors generated using the fabric/core/errors package
+    error:      debug
+
     format: '%{color}%{time:2006-01-02 15:04:05.000 MST} [%{module}] %{shortfunc} -> %{level:.4s} %{id:03x}%{color:reset} %{message}'
 
 ###############################################################################

peer/main.go

@@ -49,7 +49,15 @@ const cmdRoot = "core"
 var mainCmd = &cobra.Command{
 	Use: "peer",
 	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
-		flogging.InitFromSpec(viper.GetString("logging_level"))
+		// check for CORE_LOGGING_LEVEL environment variable, which should override
+		// all other log settings
+		loggingSpec := viper.GetString("logging_level")
+
+		if loggingSpec == "" {
+			// if CORE_LOGGING_LEVEL not set, use the value for 'peer' from core.yaml
+			loggingSpec = viper.GetString("logging.peer")
+		}
+		flogging.InitFromSpec(loggingSpec)
 
 		return core.CacheConfiguration()
 	},

peer/node/start.go

@@ -80,6 +80,10 @@ var nodeStartCmd = &cobra.Command{
 	Short: "Starts the node.",
 	Long:  `Starts a node that interacts with the network.`,
 	RunE: func(cmd *cobra.Command, args []string) error {
+		// initialize the log level for the "error" module to the value of
+		// `logging.error` in core.yaml. this is necessary to ensure that the stack
+		// is automatically appended to error messages (if set to debug)
+		common.SetLogLevelFromViper("error")
 		return serve(args)
 	},
 }
@@ -259,11 +263,18 @@ func serve(args []string) error {
 	logger.Infof("Started peer with ID=[%s], network ID=[%s], address=[%s]",
 		peerEndpoint.Id, viper.GetString("peer.networkId"), peerEndpoint.Address)
 
-	// sets the logging level for the 'error' and 'msp' modules to the
-	// values from core.yaml. they can also be updated dynamically using
-	// "peer logging setlevel <module-name> <log-level>"
-	common.SetLogLevelFromViper("error")
-	common.SetLogLevelFromViper("msp")
+	// if CORE_LOGGING_LEVEL environment variable is not set, set the logging
+	// level for specific modules defined in core.yaml.
+	// TODO Add calls to set 'gossip' and 'ledger' once all other packages
+	// switch to `flogging.MustGetLogger` (from `logging.MustGetLogger`) as those
+	// modules need the regular expression capabilities enabled by the `flogging`
+	// package
+	if viper.GetString("logging_level") == "" {
+		err = common.SetLogLevelFromViper("msp")
+		if err != nil {
+			logger.Warningf("Error setting log level for module 'msp': %s", err.Error())
+		}
+	}
 
 	// TODO This check is here to preserve the old functionality until all
 	// other packages switch to `flogging.MustGetLogger` (from