feat(log): Add loglevel to default logger message (#60)

Author: YuanC

optimizely/logging/interface.go

@@ -2,8 +2,8 @@ package logging
 
 // OptimizelyLogConsumer consumes log messages produced by the log producers
 type OptimizelyLogConsumer interface {
-	Log(level int, message string)
-	SetLogLevel(logLevel int)
+	Log(level LogLevel, message string)
+	SetLogLevel(logLevel LogLevel)
 }
 
 // OptimizelyLogProducer produces log messages to be consumed by the log consumer

optimizely/logging/level_log_consumer.go

@@ -7,24 +7,24 @@ import (
 
 // FilteredLevelLogConsumer is an implementation of the OptimizelyLogConsumer that filters by log level
 type FilteredLevelLogConsumer struct {
-	level  int
+	level  LogLevel
 	logger *log.Logger
 }
 
 // Log logs the message if it's log level is higher than or equal to the logger's set level
-func (l *FilteredLevelLogConsumer) Log(level int, message string) {
+func (l *FilteredLevelLogConsumer) Log(level LogLevel, message string) {
 	if l.level <= level {
 		l.logger.Println(message)
 	}
 }
 
 // SetLogLevel changes the log level to the given level
-func (l *FilteredLevelLogConsumer) SetLogLevel(level int) {
+func (l *FilteredLevelLogConsumer) SetLogLevel(level LogLevel) {
 	l.level = level
 }
 
 // NewStdoutFilteredLevelLogConsumer returns a new logger that logs to stdout
-func NewStdoutFilteredLevelLogConsumer(level int) *FilteredLevelLogConsumer {
+func NewStdoutFilteredLevelLogConsumer(level LogLevel) *FilteredLevelLogConsumer {
 	return &FilteredLevelLogConsumer{
 		level:  level,
 		logger: log.New(os.Stdout, "[Optimizely]", log.LstdFlags),

optimizely/logging/logger.go

@@ -2,13 +2,18 @@ package logging
 
 import "fmt"
 
+// LogLevel represents the level of the log (i.e. Debug, Info, Warning, Error)
+type LogLevel int
+
+func (l LogLevel) String() string {
+	return [...]string{"", "Debug", "Info", "Warning", "Error"}[l]
+}
+
 var defaultLogConsumer OptimizelyLogConsumer
 
 const (
-	_ = iota
-
 	// LogLevelDebug log level
-	LogLevelDebug
+	LogLevelDebug LogLevel = iota + 1
 
 	// LogLevelInfo log level
 	LogLevelInfo
@@ -30,7 +35,7 @@ func SetLogger(logger OptimizelyLogConsumer) {
 }
 
 // SetLogLevel sets the log level to the given level
-func SetLogLevel(logLevel int) {
+func SetLogLevel(logLevel LogLevel) {
 	defaultLogConsumer.SetLogLevel(logLevel)
 }
 
@@ -69,8 +74,9 @@ func (p NamedLogProducer) Error(message string, err interface{}) {
 	p.log(LogLevelError, message)
 }
 
-func (p NamedLogProducer) log(logLevel int, message string) {
-	// prepends the name to the message
-	message = fmt.Sprintf("[%s] %s", p.name, message)
+func (p NamedLogProducer) log(logLevel LogLevel, message string) {
+
+	// prepends the name and log level to the message
+	message = fmt.Sprintf("[%s][%s] %s", p.name, logLevel, message)
 	defaultLogConsumer.Log(logLevel, message)
 }

optimizely/logging/logger_test.go

@@ -14,18 +14,18 @@ type MockOptimizelyLogger struct {
 	loggedMessages []string
 }
 
-func (m *MockOptimizelyLogger) Log(level int, message string) {
+func (m *MockOptimizelyLogger) Log(level LogLevel, message string) {
 	m.Called(level, message)
 	m.loggedMessages = append(m.loggedMessages, message)
 }
 
-func (m *MockOptimizelyLogger) SetLogLevel(level int) {
+func (m *MockOptimizelyLogger) SetLogLevel(level LogLevel) {
 	m.Called(level)
 }
 
 func TestNamedLoggerInfo(t *testing.T) {
 	testLogMessage := "Test info message"
-	expectedLogMessage := "[test-info] Test info message"
+	expectedLogMessage := "[test-info][Info] Test info message"
 	testLogger := new(MockOptimizelyLogger)
 	testLogger.On("Log", LogLevelInfo, expectedLogMessage)
 
@@ -39,7 +39,7 @@ func TestNamedLoggerInfo(t *testing.T) {
 
 func TestNamedLoggerError(t *testing.T) {
 	testLogMessage := "Test error message"
-	expectedLogMessage := "[test-error] Test error message I am an error object"
+	expectedLogMessage := "[test-error][Error] Test error message I am an error object"
 	testLogger := new(MockOptimizelyLogger)
 	testLogger.On("Log", LogLevelError, expectedLogMessage)
 	SetLogger(testLogger)