Skip to content
This repository was archived by the owner on Apr 25, 2025. It is now read-only.

Commit 9d194d5

Browse files
committed
[FAB-8667] Remove GetLogger method / Rename InitLogger
Change-Id: Id259c4574869e4529cc029db8362ce57926da3c6 Signed-off-by: Troy Ronda <troy@troyronda.com>
1 parent 9606a4c commit 9d194d5

File tree

4 files changed

+13
-31
lines changed

4 files changed

+13
-31
lines changed

pkg/fabsdk/fabsdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ func initSDK(sdk *FabricSDK, config core.Config, opts []Option) error {
134134
if sdk.opts.Logger == nil {
135135
return errors.New("Missing logger from pkg suite")
136136
}
137-
logging.InitLogger(sdk.opts.Logger)
137+
logging.Initialize(sdk.opts.Logger)
138138

139139
// Initialize crypto provider
140140
cryptoSuite, err := sdk.opts.Core.CreateCryptoSuiteProvider(config)

pkg/fabsdk/singleton_test.go

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,17 @@ func TestDefLoggerFactory(t *testing.T) {
2727
}
2828

2929
const moduleName = "mymodule"
30-
l1, err := logging.GetLogger(moduleName)
31-
if err != nil {
32-
t.Fatal("Unexpected error getting logger")
33-
}
30+
l1 := logging.NewLogger(moduleName)
3431

3532
// output a log message to force initializatin
3633
l1.Info("message")
3734

3835
// ensure that the logger cannot be overridden
3936
// (initializing a new logger should have no effect)
4037
lf := NewMockLoggerFactory()
41-
logging.InitLogger(lf)
38+
logging.Initialize(lf)
4239

43-
l2, err := logging.GetLogger(moduleName)
44-
if err != nil {
45-
t.Fatal("Unexpected error getting logger")
46-
}
40+
l2 := logging.NewLogger(moduleName)
4741

4842
// output a log message to force initializatin
4943
l2.Info("message")
@@ -66,10 +60,7 @@ func TestOptLoggerFactory(t *testing.T) {
6660
}
6761

6862
const moduleName = "mymodule"
69-
l, err := logging.GetLogger(moduleName)
70-
if err != nil {
71-
t.Fatal("Unexpected error getting logger")
72-
}
63+
l := logging.NewLogger(moduleName)
7364

7465
// output a log message to force initializatin
7566
l.Info("message")

pkg/logging/logger.go

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,10 @@ const (
4646
loggerModule = "fabsdk/core"
4747
)
4848

49-
// GetLogger creates and returns a Logger object based on the module name.
50-
func GetLogger(module string) (*Logger, error) {
51-
// note: the underlying logger instance is lazy initialized on first use
52-
return &Logger{module: module}, nil
53-
}
54-
55-
// NewLogger is like GetLogger but panics if the logger can't be created.
49+
// NewLogger creates and returns a Logger object based on the module name.
5650
func NewLogger(module string) *Logger {
57-
logger, err := GetLogger(module)
58-
if err != nil {
59-
panic("logger: " + module + ": " + err.Error())
60-
}
61-
return logger
51+
// note: the underlying logger instance is lazy initialized on first use
52+
return &Logger{module: module}
6253
}
6354

6455
func loggerProvider() api.LoggerProvider {
@@ -72,9 +63,9 @@ func loggerProvider() api.LoggerProvider {
7263
return loggerProviderInstance
7364
}
7465

75-
//InitLogger sets new logger which takes over logging operations.
66+
//Initialize sets new logger which takes over logging operations.
7667
//It is required to call this function before making any loggings.
77-
func InitLogger(l api.LoggerProvider) {
68+
func Initialize(l api.LoggerProvider) {
7869
loggerProviderOnce.Do(func() {
7970
loggerProviderInstance = l
8071
logger := loggerProviderInstance.GetLogger(loggerModule)

pkg/logging/logger_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ func TestLoggingForCustomLogger(t *testing.T) {
2525

2626
//Now add sample logger
2727
resetLoggerInstance()
28-
InitLogger(testdata.GetSampleLoggingProvider(&buf))
28+
Initialize(testdata.GetSampleLoggingProvider(&buf))
2929
//Create new logger
3030
logger := NewLogger(moduleName)
3131

@@ -73,7 +73,7 @@ func TestDefaultModulledLoggingBehavior(t *testing.T) {
7373

7474
//Init logger with default logger
7575
resetLoggerInstance()
76-
InitLogger(modlog.LoggerProvider())
76+
Initialize(modlog.LoggerProvider())
7777
//Get new logger
7878
dlogger := NewLogger(moduleName)
7979
// force initialization
@@ -137,7 +137,7 @@ func TestLoggerSetting(t *testing.T) {
137137
logger.Info("brown fox jumps over the lazy dog")
138138
assert.True(t, loggerProviderInstance != nil, "Logger is supposed to be initialized now")
139139
resetLoggerInstance()
140-
InitLogger(modlog.LoggerProvider())
140+
Initialize(modlog.LoggerProvider())
141141
assert.True(t, loggerProviderInstance != nil, "Logger is supposed to be initialized now")
142142
}
143143

0 commit comments

Comments
 (0)