Add new environment variable for logging spec

A new environment variable (FABRIC_LOGGING_SPEC) has been
added, and support for the CORE_LOGGING_LEVEL and log module
overrides has been removed.

FAB-12487 #done

Change-Id: Ia8d72b3b41dd5ac9e37747209fdc51c9014b2811
Signed-off-by: Saad Karim <skarim@us.ibm.com>
Signed-off-by: Will Lahti <wtlahti@us.ibm.com>

Author: Saad Karim

examples/cluster/compose/docker-compose.yaml.in

@@ -62,9 +62,9 @@ services:
       <<: *logging
     environment:
       - CORE_PEER_TLS_ENABLED=_TLS_ENABLED_
-      - CORE_LOGGING_LEVEL=WARNING
       - CORE_PEER_GOSSIP_BOOTSTRAP=peer1:7051
       - CORE_VM_DOCKER_HOSTCONFIG_NETWORKMODE=compose_default
+      - FABRIC_LOGGING_SPEC=WARNING
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
     command: peer node start
@@ -173,7 +173,7 @@ services:
     environment:
       - CORE_PEER_TLS_ENABLED=_TLS_ENABLED_
       - CORE_NEXT=true
-      - CORE_LOGGING_LEVEL=DEBUG
+      - FABRIC_LOGGING_SPEC=DEBUG
     volumes:
       - ./nodes/cli:/etc/hyperledger/fabric
       - .:/cli

examples/e2e_cli/base/peer-base.yaml

@@ -13,8 +13,8 @@ services:
       # bridge network as the peers
       # https://docs.docker.com/compose/networking/
       - CORE_VM_DOCKER_HOSTCONFIG_NETWORKMODE=e2e_default
-      #- CORE_LOGGING_LEVEL=ERROR
-      - CORE_LOGGING_LEVEL=DEBUG
+      #- FABRIC_LOGGING_SPEC=ERROR
+      - FABRIC_LOGGING_SPEC=DEBUG
       - CORE_PEER_TLS_ENABLED=true
       - CORE_PEER_GOSSIP_USELEADERELECTION=true
       - CORE_PEER_GOSSIP_ORGLEADER=false

examples/e2e_cli/docker-compose-cli.yaml

@@ -138,7 +138,7 @@ services:
     environment:
       - GOPATH=/opt/gopath
       - CORE_VM_ENDPOINT=unix:///host/var/run/docker.sock
-      - CORE_LOGGING_LEVEL=DEBUG
+      - FABRIC_LOGGING_SPEC=DEBUG
       - CORE_PEER_ID=cli
       - CORE_PEER_ADDRESS=peer0.org1.example.com:7051
       - CORE_PEER_LOCALMSPID=Org1MSP

integration/nwo/core_template.go

@@ -8,15 +8,6 @@ package nwo
 
 const DefaultCoreTemplate = `---
 logging:
-  level:      info
-  cauthdsl:   warning
-  gossip:     warning
-  grpc:       error
-  ledger:     info
-  msp:        warning
-  policies:   warning
-  peer:
-    gossip: warning
   format: '%{color}%{time:2006-01-02 15:04:05.000 MST} [%{module}] %{shortfunc} -> %{level:.4s} %{id:03x}%{color:reset} %{message}'
 
 peer:

integration/nwo/fabricconfig/core.go

@@ -22,7 +22,6 @@ type Core struct {
 }
 
 type Logging struct {
-	Level  string `yaml:"level,omitempty"`
 	Format string `yaml:"format,omitempty"`
 
 	ExtraProperties map[string]interface{} `yaml:",inline,omitempty"`

peer/common/common.go

@@ -222,26 +222,6 @@ func GetOrdererEndpointOfChain(chainID string, signer msp.SigningIdentity, endor
 	return bundle.ChannelConfig().OrdererAddresses(), nil
 }
 
-// SetLogLevelFromViper sets the log level for 'module' logger to the value in
-// core.yaml
-func SetLogLevelFromViper(module string) error {
-	var err error
-	if module == "" {
-		return errors.New("log level not set, no module name provided")
-	}
-	logLevelFromViper := viper.GetString("logging." + module)
-	err = CheckLogLevel(logLevelFromViper)
-	if err != nil {
-		return err
-	}
-	// replace period in module name with forward slash to allow override
-	// of logging submodules
-	module = strings.Replace(module, ".", "/", -1)
-	// only set logging modules that begin with the supplied module name here
-	err = flogging.SetModuleLevels("^"+module, logLevelFromViper)
-	return err
-}
-
 // CheckLogLevel checks that a given log level string is valid
 func CheckLogLevel(level string) error {
 	if !flogging.IsValidLevel(level) {
@@ -302,12 +282,17 @@ func InitCmd(cmd *cobra.Command, args []string) {
 	// log settings. if --logging-level is not set, use CORE_LOGGING_LEVEL
 	// (environment variable takes priority; otherwise, the value set in
 	// core.yaml)
-	var loggingSpec string
+	var loggingLevel string
 	if viper.GetString("logging_level") != "" {
-		loggingSpec = viper.GetString("logging_level")
+		loggingLevel = viper.GetString("logging_level")
 	} else {
-		loggingSpec = viper.GetString("logging.level")
+		loggingLevel = viper.GetString("logging.level")
 	}
+	loggingSpec := os.Getenv("FABRIC_LOGGING_SPEC")
+	if loggingLevel != "" {
+		mainLogger.Warning("CORE_LOGGING_LEVEL is no longer supported, please use FABRIC_LOGGING_SPEC environment variable.")
+	}
+
 	flogging.Init(flogging.Config{
 		Format:  viper.GetString("logging.format"),
 		Writer:  logOutput,

peer/common/common_test.go

@@ -107,80 +107,6 @@ func TestSetBCCSPKeystorePath(t *testing.T) {
 	os.Unsetenv("FABRIC_CFG_PATH")
 }
 
-func TestSetLogLevelFromViper(t *testing.T) {
-	viper.Reset()
-	cleanup := configtest.SetDevFabricConfigPath(t)
-	defer cleanup()
-
-	common.InitConfig("core")
-	type args struct {
-		module string
-	}
-	tests := []struct {
-		name    string
-		args    args
-		wantErr bool
-	}{
-		{
-			name:    "Empty module name",
-			args:    args{module: ""},
-			wantErr: true,
-		},
-		{
-			name:    "Invalid module name",
-			args:    args{module: "policy"},
-			wantErr: true,
-		},
-		{
-			name:    "Valid module name",
-			args:    args{module: "cauthdsl"},
-			wantErr: false,
-		},
-		{
-			name:    "Valid module name",
-			args:    args{module: "level"},
-			wantErr: false,
-		},
-		{
-			name:    "Valid module name",
-			args:    args{module: "gossip"},
-			wantErr: false,
-		},
-		{
-			name:    "Valid module name",
-			args:    args{module: "grpc"},
-			wantErr: false,
-		},
-		{
-			name:    "Valid module name",
-			args:    args{module: "msp"},
-			wantErr: false,
-		},
-		{
-			name:    "Valid module name",
-			args:    args{module: "ledger"},
-			wantErr: false,
-		},
-		{
-			name:    "Valid module name",
-			args:    args{module: "policies"},
-			wantErr: false,
-		},
-		{
-			name:    "Valid module name",
-			args:    args{module: "peer.gossip"},
-			wantErr: false,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if err := common.SetLogLevelFromViper(tt.args.module); (err != nil) != tt.wantErr {
-				t.Errorf("SetLogLevelFromViper() args = %v error = %v, wantErr %v", tt.args, err, tt.wantErr)
-			}
-		})
-	}
-}
-
 func TestCheckLogLevel(t *testing.T) {
 	type args struct {
 		level string
@@ -249,6 +175,8 @@ func TestGetDefaultSigner(t *testing.T) {
 }
 
 func TestInitCmd(t *testing.T) {
+	cleanup := configtest.SetDevFabricConfigPath(t)
+	defer cleanup()
 	defer viper.Reset()
 
 	// test that InitCmd doesn't remove existing loggers from the module levels map
@@ -257,9 +185,15 @@ func TestInitCmd(t *testing.T) {
 	assert.Equal(t, "error", flogging.Global.Level("test").String())
 	flogging.MustGetLogger("chaincode")
 	assert.Equal(t, flogging.Global.DefaultLevel().String(), flogging.Global.Level("chaincode").String())
+	flogging.MustGetLogger("test.test2")
+	flogging.SetModuleLevel("test.test2", "warn")
+	assert.Equal(t, "warn", flogging.Global.Level("test.test2").String())
 
-	viper.Set("logging_level", "chaincode=debug")
+	origEnvValue := os.Getenv("FABRIC_LOGGING_SPEC")
+	os.Setenv("FABRIC_LOGGING_SPEC", "chaincode=debug:test.test2=fatal")
 	common.InitCmd(nil, nil)
 	assert.Equal(t, "debug", flogging.Global.Level("chaincode").String())
 	assert.Equal(t, "error", flogging.Global.Level("test").String())
+	assert.Equal(t, "fatal", flogging.Global.Level("test.test2").String())
+	os.Setenv("FABRIC_LOGGING_SPEC", origEnvValue)
 }

peer/main.go

@@ -40,6 +40,7 @@ func main() {
 
 	mainFlags.String("logging-level", "", "Default logging level and overrides, see core.yaml for full syntax")
 	viper.BindPFlag("logging_level", mainFlags.Lookup("logging-level"))
+	mainFlags.MarkHidden("logging_level")
 
 	mainCmd.AddCommand(version.Cmd())
 	mainCmd.AddCommand(node.Cmd())

peer/node/start.go

@@ -67,7 +67,6 @@ import (
 	"github.com/hyperledger/fabric/gossip/service"
 	"github.com/hyperledger/fabric/msp"
 	"github.com/hyperledger/fabric/msp/mgmt"
-	"github.com/hyperledger/fabric/peer/common"
 	peergossip "github.com/hyperledger/fabric/peer/gossip"
 	"github.com/hyperledger/fabric/peer/version"
 	cb "github.com/hyperledger/fabric/protos/common"
@@ -127,16 +126,6 @@ func serve(args []string) error {
 		panic("Unsupported msp type " + msp.ProviderTypeToString(mspType))
 	}
 
-	// set the logging level for specific modules defined via environment
-	// variables or core.yaml
-	overrideLogModules := []string{"msp", "gossip", "ledger", "cauthdsl", "policies", "grpc", "peer.gossip"}
-	for _, module := range overrideLogModules {
-		err := common.SetLogLevelFromViper(module)
-		if err != nil {
-			logger.Warningf("Error setting log level for module '%s': %s", module, err.Error())
-		}
-	}
-
 	// Trace RPCs with the golang.org/x/net/trace package. This was moved out of
 	// the deliver service connection factory as it has process wide implications
 	// and was racy with respect to initialization of gRPC clients and servers.

sampleconfig/core.yaml

@@ -10,45 +10,6 @@
 ###############################################################################
 logging:
 
-    # Default logging levels are specified here.
-
-    # Valid logging levels are case-insensitive strings chosen from
-
-    #     FATAL | PANIC | ERROR | WARNING | INFO | DEBUG
-
-    # The overall default logging level can be specified in various ways,
-    # listed below from strongest to weakest:
-    #
-    # 1. The --logging-level=<level> command line option overrides all other
-    #    default specifications.
-    #
-    # 2. The environment variable CORE_LOGGING_LEVEL otherwise applies to
-    #    all peer commands if defined as a non-empty string.
-    #
-    # 3. The value of `level` that directly follows in this file.
-    #
-    # If no overall default level is provided via any of the above methods,
-    # the peer will default to INFO (the value of defaultLevel in
-    # common/flogging/logging.go)
-
-    # Default for all modules running within the scope of a peer.
-    # Note: this value is only used when --logging-level or CORE_LOGGING_LEVEL
-    #       are not set
-    level:       info
-
-    # The overall default values mentioned above can be overridden for the
-    # specific components listed in the override section below.
-
-    # Override log levels for various peer modules.
-    cauthdsl:   warning
-    gossip:     info
-    grpc:       error
-    ledger:     info
-    msp:        warning
-    policies:   warning
-    peer:
-        gossip: warning
-
     # Message format for the peer logs
     format: '%{color}%{time:2006-01-02 15:04:05.000 MST} [%{module}] %{shortfunc} -> %{level:.4s} %{id:03x}%{color:reset} %{message}'