Add fundamental logger mechanism (#16)

Signed-off-by: Jiangnan Jia <[email protected]>

go.mod

@@ -3,7 +3,6 @@ module github.com/opensergo/opensergo-control-plane
 go 1.14
 
 require (
-	github.com/alibaba/sentinel-golang v1.0.3
 	github.com/envoyproxy/protoc-gen-validate v0.1.0
 	github.com/go-logr/logr v0.4.0
 	github.com/json-iterator/go v1.1.12 // indirect

pkg/common/logging/doc.go

@@ -0,0 +1,16 @@
+// Copyright 2022, OpenSergo Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Package logging.
+package logging

pkg/common/logging/logger.go

@@ -0,0 +1,194 @@
+// Copyright 2022, OpenSergo Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package logging
+
+import (
+	"github.com/pkg/errors"
+	"reflect"
+)
+
+type Logger interface {
+
+	// Print logs message no format as what the msg presents.
+	Print(msg string)
+
+	// DebugEnabled judge is the DebugLevel enabled
+	DebugEnabled() bool
+	// Debug logs a non-error message with the given key/value pairs as context.
+	//
+	// The msg argument should be used to add some constant description to
+	// the log line.  The key/value pairs can then be used to add additional
+	// variable information.  The key/value pairs should alternate string
+	// keys and arbitrary values.
+	Debug(msg string, keysAndValues ...interface{})
+
+	// InfoEnabled judge is the InfoLevel enabled
+	InfoEnabled() bool
+	// Info logs a non-error message with the given key/value pairs as context.
+	//
+	// The msg argument should be used to add some constant description to
+	// the log line.  The key/value pairs can then be used to add additional
+	// variable information.  The key/value pairs should alternate string
+	// keys and arbitrary values.
+	Info(msg string, keysAndValues ...interface{})
+
+	// WarnEnabled judge is the WarnLevel enabled
+	WarnEnabled() bool
+	// Warn logs a non-error message with the given key/value pairs as context.
+	//
+	// The msg argument should be used to add some constant description to
+	// the log line.  The key/value pairs can then be used to add additional
+	// variable information.  The key/value pairs should alternate string
+	// keys and arbitrary values.
+	Warn(msg string, keysAndValues ...interface{})
+
+	// ErrorEnabled judge is the ErrorLevel enabled
+	ErrorEnabled() bool
+	// Error logs an error message with error and the given key/value pairs as context.
+	//
+	// The msg argument should be used to add some constant description to
+	// the log line.  The key/value pairs can then be used to add additional
+	// variable information.  The key/value pairs should alternate string
+	// keys and arbitrary values.
+	Error(err error, msg string, keysAndValues ...interface{})
+}
+
+var (
+	loggerSlice = make([]Logger, 0)
+
+	consoleLogger Logger
+)
+
+func Print(msg string) {
+	doLog("Print", nil, msg)
+}
+
+func Debug(msg string, keysAndValues ...interface{}) {
+	doLog("Debug", nil, msg, keysAndValues...)
+}
+
+func DebugWithCallerDepth(logger Logger, logFormat LogFormat, logCallerDepth int, msg string, keysAndValues ...interface{}) {
+	if !logger.DebugEnabled() {
+		return
+	}
+	logger.Print(AssembleMsg(logFormat, logCallerDepth, "DEBUG", msg, nil, false, keysAndValues...))
+}
+
+func Info(msg string, keysAndValues ...interface{}) {
+	doLog("Info", nil, msg, keysAndValues...)
+}
+
+func InfoWithCallerDepth(logger Logger, logFormat LogFormat, logCallerDepth int, msg string, keysAndValues ...interface{}) {
+	if !logger.InfoEnabled() {
+		return
+	}
+	logger.Print(AssembleMsg(logFormat, logCallerDepth, "INFO", msg, nil, false, keysAndValues...))
+}
+
+func Warn(msg string, keysAndValues ...interface{}) {
+	doLog("Warn", nil, msg, keysAndValues...)
+}
+
+func WarnWithCallerDepth(logger Logger, logFormat LogFormat, logCallerDepth int, msg string, keysAndValues ...interface{}) {
+	if !logger.WarnEnabled() {
+		return
+	}
+
+	logger.Print(AssembleMsg(logFormat, logCallerDepth, "WARN", msg, nil, false, keysAndValues...))
+}
+
+func Error(err error, msg string, keysAndValues ...interface{}) {
+	doLog("Error", err, msg, keysAndValues...)
+}
+
+func ErrorWithCallerDepth(logger Logger, logFormat LogFormat, logCallerDepth int, err error, errorWithStack bool, msg string, keysAndValues ...interface{}) {
+	if !logger.ErrorEnabled() {
+		return
+	}
+	logger.Print(AssembleMsg(logFormat, logCallerDepth, "ERROR", msg, err, errorWithStack, keysAndValues...))
+}
+
+// AppendLoggerSlice add the Logger into loggerSlice
+func AppendLoggerSlice(loggerAppend Logger) {
+	loggerSlice = append(loggerSlice, loggerAppend)
+}
+
+// ClearLoggerSlice clear the Logger into loggerSlice
+func ClearLoggerSlice() {
+	loggerSlice = make([]Logger, 0)
+}
+
+// SetConsoleLogger set the consoleLogger to print int stdout
+func SetConsoleLogger(logger Logger) {
+	consoleLogger = logger
+}
+
+// doLog do log
+// funcNameFromInterface funcName in Logger
+// err
+// msg
+// keysAndValues
+func doLog(funcNameFromInterface string, err error, msg string, keysAndValues ...interface{}) {
+	if consoleLogger == nil && len(loggerSlice) == 0 {
+		NewDefaultConsoleLogger(InfoLevel)
+	}
+
+	if consoleLogger != nil {
+		invokeLogger(consoleLogger, funcNameFromInterface, err, msg, keysAndValues...)
+	}
+
+	if len(loggerSlice) > 0 {
+		for _, logger := range loggerSlice {
+			invokeLogger(logger, funcNameFromInterface, err, msg, keysAndValues...)
+		}
+	}
+}
+
+// invokeLogger do log actually by invoke function of Logger
+// logger Logger to print
+// funcNameFromInterface funcName in Logger
+// err
+// msg
+// keysAndValues
+func invokeLogger(logger Logger, funcNameFromInterface string, err error, msg string, keysAndValues ...interface{}) {
+	method, ok := reflect.TypeOf(logger).MethodByName(funcNameFromInterface)
+	if !ok {
+		assembleMsg := AssembleMsg(SeparateFormat, 4, "WARN", "no function named '"+funcNameFromInterface+"' was found in interface 'opensergo-go/pkg/logging/Logger'", nil, false)
+		logger.Print(assembleMsg)
+		return
+	}
+
+	keysAndValuesLen := len(keysAndValues)
+	params := make([]reflect.Value, 0)
+	params = append(params, reflect.ValueOf(logger))
+	if "Error" == funcNameFromInterface {
+		if err == nil {
+			err = errors.New("")
+		}
+		params = append(params, reflect.ValueOf(err))
+	}
+	params = append(params, reflect.ValueOf(msg))
+
+	if keysAndValuesLen != 0 {
+		if keysAndValuesLen == 1 && keysAndValues[0] == nil {
+
+		} else {
+			for _, keyOrValue := range keysAndValues {
+				params = append(params, reflect.ValueOf(keyOrValue))
+			}
+		}
+	}
+	method.Func.Call(params)
+}