Enhance naming of logging api and refine comments (#296)

Author: louyuting

core/circuitbreaker/rule_manager.go

@@ -301,6 +301,7 @@ func logRuleUpdate(m map[string][]*Rule) {
 	}
 }
 
+// RegisterStateChangeListeners registers the global state change listener for all circuit breakers
 // Note: this function is not thread-safe.
 func RegisterStateChangeListeners(listeners ...StateChangeListener) {
 	if len(listeners) == 0 {
@@ -310,7 +311,7 @@ func RegisterStateChangeListeners(listeners ...StateChangeListener) {
 	stateChangeListeners = append(stateChangeListeners, listeners...)
 }
 
-// ClearStateChangeListeners will clear the all StateChangeListener
+// ClearStateChangeListeners clears the all StateChangeListener
 // Note: this function is not thread-safe.
 func ClearStateChangeListeners() {
 	stateChangeListeners = make([]StateChangeListener, 0)

core/isolation/rule_manager_test.go

@@ -9,7 +9,7 @@ import (
 
 func TestLoadRules(t *testing.T) {
 	t.Run("TestLoadRules_1", func(t *testing.T) {
-		logging.SetGlobalLoggerLevel(logging.DebugLevel)
+		logging.ResetGlobalLoggerLevel(logging.DebugLevel)
 		r1 := &Rule{
 			Resource:   "abc1",
 			MetricType: Concurrency,

example/isolation/concurrency_limitation_example.go

@@ -20,7 +20,7 @@ func main() {
 		logging.Error(err, "fail")
 		os.Exit(1)
 	}
-	logging.SetGlobalLoggerLevel(logging.DebugLevel)
+	logging.ResetGlobalLoggerLevel(logging.DebugLevel)
 	ch := make(chan struct{})
 
 	r1 := &isolation.Rule{

logging/logging.go

@@ -42,15 +42,24 @@ var (
 	FrequentErrorOnce = &sync.Once{}
 )
 
+// GetGlobalLoggerLevel gets the Sentinel log level
 func GetGlobalLoggerLevel() Level {
 	return globalLogLevel
 }
 
-func SetGlobalLoggerLevel(l Level) {
+// ResetGlobalLoggerLevel sets the Sentinel log level
+// Note: this function is not thread-safe.
+func ResetGlobalLoggerLevel(l Level) {
 	globalLogLevel = l
 }
 
-// Note: Not thread-safe
+// GetGlobalLogger gets the Sentinel global logger
+func GetGlobalLogger() Logger {
+	return globalLogger
+}
+
+// ResetGlobalLogger sets the Sentinel global logger
+// Note: this function is not thread-safe.
 func ResetGlobalLogger(log Logger) error {
 	if log == nil {
 		return errors.New("nil logger")

logging/logging_test.go

@@ -65,25 +65,25 @@ func Test_caller(t *testing.T) {
 }
 
 func TestLogLevelEnabled(t *testing.T) {
-	SetGlobalLoggerLevel(DebugLevel)
+	ResetGlobalLoggerLevel(DebugLevel)
 	assert.True(t, DebugEnabled(), "Debug should be enabled when log level is DebugLevel")
 	assert.True(t, InfoEnabled(), "Info should be enabled when log level is DebugLevel")
 	assert.True(t, WarnEnabled(), "Warn should be enabled when log level is DebugLevel")
 	assert.True(t, ErrorEnabled(), "Error should be enabled when log level is DebugLevel")
 
-	SetGlobalLoggerLevel(InfoLevel)
+	ResetGlobalLoggerLevel(InfoLevel)
 	assert.False(t, DebugEnabled(), "Debug should be disabled when log level is InfoLevel")
 	assert.True(t, InfoEnabled(), "Info should be enabled when log level is InfoLevel")
 	assert.True(t, WarnEnabled(), "Warn should be enabled when log level is InfoLevel")
 	assert.True(t, ErrorEnabled(), "Error should be enabled when log level is InfoLevel")
 
-	SetGlobalLoggerLevel(WarnLevel)
+	ResetGlobalLoggerLevel(WarnLevel)
 	assert.False(t, DebugEnabled(), "Debug should be disabled when log level is WarnLevel")
 	assert.False(t, InfoEnabled(), "Info should be disabled when log level is WarnLevel")
 	assert.True(t, WarnEnabled(), "Warn should be enabled when log level is WarnLevel")
 	assert.True(t, ErrorEnabled(), "Error should be enabled when log level is WarnLevel")
 
-	SetGlobalLoggerLevel(ErrorLevel)
+	ResetGlobalLoggerLevel(ErrorLevel)
 	assert.False(t, DebugEnabled(), "Debug should be disabled when log level is ErrorLevel")
 	assert.False(t, InfoEnabled(), "Info should be disabled when log level is ErrorLevel")
 	assert.False(t, WarnEnabled(), "Warn should be disabled when log level is ErrorLevel")
@@ -93,7 +93,7 @@ func TestLogLevelEnabled(t *testing.T) {
 func Benchmark_LoggingDebug_Without_Precheck(b *testing.B) {
 	b.ReportAllocs()
 	b.ResetTimer()
-	SetGlobalLoggerLevel(InfoLevel)
+	ResetGlobalLoggerLevel(InfoLevel)
 	for i := 0; i < b.N; i++ {
 		Debug("log test", "k1", "v1", "k2", "v2")
 	}
@@ -102,7 +102,7 @@ func Benchmark_LoggingDebug_Without_Precheck(b *testing.B) {
 func Benchmark_LoggingDebug_With_Precheck(b *testing.B) {
 	b.ReportAllocs()
 	b.ResetTimer()
-	SetGlobalLoggerLevel(InfoLevel)
+	ResetGlobalLoggerLevel(InfoLevel)
 	for i := 0; i < b.N; i++ {
 		if DebugEnabled() {
 			Debug("log test", "k1", "v1", "k2", "v2")

tests/core/circuitbreaker/circuitbreaker_slot_integration_test.go

@@ -211,7 +211,7 @@ func TestCircuitBreakerSlotIntegration_Probe_Succeed(t *testing.T) {
 }
 
 func TestCircuitBreakerSlotIntegration_Concurrency(t *testing.T) {
-	logging.SetGlobalLoggerLevel(logging.InfoLevel)
+	logging.ResetGlobalLoggerLevel(logging.InfoLevel)
 	circuitbreaker.ClearStateChangeListeners()
 	if clearErr := circuitbreaker.ClearRules(); clearErr != nil {
 		t.Fatal(clearErr)

tests/maxsize_rule_list_benchmark_test.go

@@ -11,7 +11,7 @@ import (
 )
 
 func Test_Size_1000_Circuit_Breaker_Rules_Update(t *testing.T) {
-	logging.SetGlobalLoggerLevel(logging.ErrorLevel)
+	logging.ResetGlobalLoggerLevel(logging.ErrorLevel)
 	rs := make([]*cb.Rule, 0, 1000)
 	rand.Seed(int64(util.CurrentTimeMillis()))
 	intervals := []uint32{10000, 15000, 20000, 25000, 30000}
@@ -32,7 +32,7 @@ func Test_Size_1000_Circuit_Breaker_Rules_Update(t *testing.T) {
 	if err != nil {
 		t.Errorf("error")
 	}
-	logging.SetGlobalLoggerLevel(logging.InfoLevel)
+	logging.ResetGlobalLoggerLevel(logging.InfoLevel)
 }
 
 func Benchmark_Size_1000_Circuit_Breaker_Rules_Update(b *testing.B) {
@@ -64,7 +64,7 @@ func Benchmark_Size_1000_Circuit_Breaker_Rules_Update(b *testing.B) {
 }
 
 func Test_Size_10000_Circuit_Breaker_Rules_Update(t *testing.T) {
-	logging.SetGlobalLoggerLevel(logging.ErrorLevel)
+	logging.ResetGlobalLoggerLevel(logging.ErrorLevel)
 	rs := make([]*cb.Rule, 0, 10000)
 	intervals := []uint32{10000, 15000, 20000, 25000, 30000}
 	for i := 0; i < 10000; i++ {
@@ -84,7 +84,7 @@ func Test_Size_10000_Circuit_Breaker_Rules_Update(t *testing.T) {
 	if err != nil {
 		t.Errorf("error")
 	}
-	logging.SetGlobalLoggerLevel(logging.InfoLevel)
+	logging.ResetGlobalLoggerLevel(logging.InfoLevel)
 }
 
 func Benchmark_Size_10000_Circuit_Breaker_Rules_Update(b *testing.B) {