unify logging content style #293

binbin0325 · 2020-10-15T12:45:41Z

Describe what this PR does / why we need it

unify logging content style

Does this pull request fix one issue?

Fixes:#280

Describe how you did it

对项目中的四种日志类型统一风格，统一的标准如下：

Error：

error 描述小写字母开头
message 大写字母开头
message 结尾声明错误在哪一个func()
输出参数使用keysAndValues(key不要用空格)
例如:logging.Error(errors.New("bucket data type error"), "Bucket data type error in errorCounterLeapArray.allCounter()","param","paramValue")

Info:

日志以[$module]开头
message 大写字母开头
输出参数使用keysAndValues(key不要用空格)
例如:logging.Info("[Config] Print effective global config", "globalConfig", *globalCfg)

Warn:

日志以[$module $func]开头
message 大写字母开头
输出参数使用keysAndValues(key不要用空格)
例如:logging.Warn("[HotSpot onRuleUpdate] Ignoring the frequent param flow rule due to unsupported control behavior", "rule", r)

Debug:

日志以[$module $func]开头
message 大写字母开头
输出参数使用keysAndValues(key不要用空格)
例如:logging.Debug("[HotSpot onRuleUpdate] Ignoring the frequent param flow rule due to bad generated traffic controller", "rule", r)

Describe how to verify it

Special notes for reviews

core/circuitbreaker/circuit_breaker.go

core/stat/base/sliding_window_metric.go

ext/datasource/file/refreshable_file.go

codecov-io · 2020-10-17T01:30:30Z

Codecov Report

Merging #293 into master will decrease coverage by 0.02%.
The diff coverage is 21.29%.

@@            Coverage Diff             @@
##           master     #293      +/-   ##
==========================================
- Coverage   51.52%   51.49%   -0.03%     
==========================================
  Files          81       81              
  Lines        4101     4107       +6     
==========================================
+ Hits         2113     2115       +2     
- Misses       1701     1706       +5     
+ Partials      287      286       -1

Impacted Files	Coverage Δ
api/tracer.go	`28.57% <0.00%> (ø)`
core/base/entry.go	`50.00% <0.00%> (ø)`
core/circuitbreaker/circuit_breaker.go	`68.15% <0.00%> (ø)`
core/flow/slot.go	`44.82% <0.00%> (ø)`
core/flow/standalone_stat_slot.go	`71.42% <0.00%> (ø)`
core/hotspot/cache/lru.go	`50.58% <0.00%> (ø)`
core/hotspot/concurrency_stat_slot.go	`3.70% <0.00%> (ø)`
core/hotspot/slot.go	`25.71% <0.00%> (ø)`
core/hotspot/traffic_shaping.go	`58.21% <0.00%> (ø)`
core/isolation/slot.go	`0.00% <0.00%> (ø)`
... and 22 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 89bc23b...b650dad. Read the comment docs.

louyuting · 2020-10-21T14:29:04Z

core/circuitbreaker/circuit_breaker.go

 		return nil
 	}
 	counter, ok := mb.(*slowRequestCounter)
 	if !ok {
-		logging.Error(errors.New("Bucket data type error"), "")
+		logging.Error(errors.New("bucket data type error"), "Bucket data type error in slowRequestLeapArray.currentCounter()")


You might need to indicate "type assert failed, expect *slowRequestCounter"

louyuting · 2020-10-21T14:29:29Z

core/circuitbreaker/circuit_breaker.go

 			continue
 		}
 		counter, ok := mb.(*slowRequestCounter)
 		if !ok {
-			logging.Error(errors.New("Bucket data type error"), "")
+			logging.Error(errors.New("bucket data type error"), "Bucket data type error in slowRequestLeapArray.allCounter()")


Same with upon

louyuting · 2020-10-21T14:29:55Z

core/circuitbreaker/circuit_breaker.go

 		return nil
 	}
 	counter, ok := mb.(*errorCounter)
 	if !ok {
-		logging.Error(errors.New("Bucket data type error"), "")
+		logging.Error(errors.New("bucket data type error"), "Bucket data type error in errorCounterLeapArray.currentCounter()")


Same with upon

louyuting · 2020-10-21T14:30:48Z

core/circuitbreaker/circuit_breaker.go

 			continue
 		}
 		counter, ok := mb.(*errorCounter)
 		if !ok {
-			logging.Error(errors.New("Bucket data type error"), "")
+			logging.Error(errors.New("bucket data type error"), "Bucket data type error in errorCounterLeapArray.allCounter()")


Same with upon

louyuting · 2020-10-21T14:32:13Z

core/config/config.go

@@ -90,7 +90,7 @@ func loadFromYamlFile(filePath string) error {
 	if err != nil {
 		return err
 	}
-	logging.Info("Resolving Sentinel config from file", "file", filePath)
+	logging.Info("[Config] Resolving sentinel config from file", "file", filePath)


keep "Sentinel", it's a brand.

louyuting · 2020-10-21T14:40:24Z

core/stat/base/bucket_leap_array.go

 			continue
 		}
 		b, ok := mb.(*MetricBucket)
 		if !ok {
-			logging.Error(errors.New("fail to type assert, expect MetricBucket"), "fail to get current MetricBucket")
+			logging.Error(errors.New("fail to type assert, expect MetricBucket"), "Fail to get current MetricBucket in BucketLeapArray.CountWithTime()")


typo: "expect *MetricBucket"

louyuting · 2020-10-21T14:40:38Z

core/stat/base/bucket_leap_array.go

 		return
 	}
 	b, ok := mb.(*MetricBucket)
 	if !ok {
-		logging.Error(errors.New("fail to type assert, expect MetricBucket"), "Failed to add count: bucket data type error")
+		logging.Error(errors.New("fail to type assert, expect MetricBucket"), "Bucket data type error in BucketLeapArray.addCountWithTime()")


typo "expect *MetricBucket"

louyuting · 2020-10-21T14:40:46Z

core/stat/base/bucket_leap_array.go

 			continue
 		}
 		b, ok := mb.(*MetricBucket)
 		if !ok {
-			logging.Error(errors.New("fail to type assert, expect MetricBucket"), "fail to get current MetricBucket")
+			logging.Error(errors.New("fail to type assert, expect MetricBucket"), "Fail to get current MetricBucket in BucketLeapArray.MinRt()")


typo "expect *MetricBucket"

louyuting · 2020-10-21T14:41:08Z

core/stat/base/sliding_window_metric.go

 			continue
 		}
 		counter, ok := mb.(*MetricBucket)
 		if !ok {
-			logging.Error(errors.New("type assert failed"), "Fail to do type assert, expect: MetricBucket", "type", reflect.TypeOf(mb).Name())
+			logging.Error(errors.New("type assert failed"), "Fail to do type assert, expect: MetricBucket in SlidingWindowMetric.GetMaxOfSingleBucket()", "type", reflect.TypeOf(mb).Name())


typo "expect *MetricBucket"

louyuting · 2020-10-21T14:41:19Z

core/stat/base/sliding_window_metric.go

 			continue
 		}
 		counter, ok := mb.(*MetricBucket)
 		if !ok {
-			logging.Error(errors.New("type assert failed"), "Fail to do type assert, expect: MetricBucket", "type", reflect.TypeOf(mb).Name())
+			logging.Error(errors.New("type assert failed"), "Fail to do type assert, expect: MetricBucket in SlidingWindowMetric.MinRT()", "type", reflect.TypeOf(mb).Name())


typo "expect *MetricBucket"

louyuting · 2020-10-21T14:41:25Z

core/stat/base/sliding_window_metric.go

 			return nil
 		}
 		mb, ok := mi.(*MetricBucket)
 		if !ok {
-			logging.Error(errors.New("type assert failed"), "Fail to do type assert, expect: MetricBucket", "bucketStartTime", w.BucketStart, "type", reflect.TypeOf(mb).Name())
+			logging.Error(errors.New("type assert failed"), "Fail to do type assert, expect: MetricBucket in SlidingWindowMetric.metricItemFromBuckets()", "bucketStartTime", w.BucketStart, "type", reflect.TypeOf(mb).Name())


typo "expect *MetricBucket"

louyuting · 2020-10-21T14:41:33Z

core/stat/base/sliding_window_metric.go

 		return nil
 	}
 	mb, ok := mi.(*MetricBucket)
 	if !ok {
-		logging.Error(errors.New("type assert failed"), "Fail to do type assert, expect: MetricBucket", "type", reflect.TypeOf(mb).Name())
+		logging.Error(errors.New("type assert failed"), "Fail to do type assert, expect: MetricBucket in SlidingWindowMetric.metricItemFromBucket()", "type", reflect.TypeOf(mb).Name())


typo "expect *MetricBucket"

louyuting · 2020-10-21T14:43:04Z

example/hotspot_param_flow/concurrency/hotspot_params_concurrency_example.go

@@ -41,12 +40,12 @@ func main() {
 	go func() {
 		node := stat.GetOrCreateResourceNode("abc", base.ResTypeCommon)
 		for {
-			logging.Info(fmt.Sprintf("current concurrency:%d", node.CurrentConcurrency()))
+			logging.Info("[HotSpot Concurrency] Current concurrency", "current concurrency", node.CurrentConcurrency())


key shouldn't contain blank, might: "currentConcurrency"？

louyuting

Nice work

liqiangz reviewed Oct 15, 2020

View reviewed changes

core/circuitbreaker/circuit_breaker.go Outdated Show resolved Hide resolved

louyuting requested review from louyuting and sczyh30 October 15, 2020 14:07

louyuting added the area/logging Issue related to logging of Sentinel label Oct 15, 2020

louyuting assigned sczyh30 Oct 15, 2020

louyuting added this to the 1.0.0 milestone Oct 15, 2020

louyuting linked an issue Oct 15, 2020 that may be closed by this pull request

Unify logging content style #280

Closed

liqiangz reviewed Oct 15, 2020

View reviewed changes

core/stat/base/sliding_window_metric.go Outdated Show resolved Hide resolved

liqiangz reviewed Oct 15, 2020

View reviewed changes

core/stat/base/sliding_window_metric.go Outdated Show resolved Hide resolved

liqiangz reviewed Oct 15, 2020

View reviewed changes

ext/datasource/file/refreshable_file.go Outdated Show resolved Hide resolved

sczyh30 added kind/enhancement Category issues or PRs related to enhancement to-review PRs to review labels Oct 15, 2020

binbin0325 force-pushed the logging_style branch 3 times, most recently from a8bd638 to f6a4123 Compare October 17, 2020 01:27

louyuting reviewed Oct 21, 2020

View reviewed changes

louyuting requested changes Oct 22, 2020

View reviewed changes

binbin0325 force-pushed the logging_style branch from f6a4123 to fce4d44 Compare October 22, 2020 14:00

unify logging content style

54fcf7b

binbin0325 force-pushed the logging_style branch from fce4d44 to 54fcf7b Compare October 23, 2020 15:08

louyuting previously approved these changes Oct 23, 2020

View reviewed changes

refine comments

b650dad

louyuting dismissed their stale review via b650dad October 23, 2020 15:28

louyuting approved these changes Oct 23, 2020

View reviewed changes

louyuting merged commit c40258e into alibaba:master Oct 23, 2020

sczyh30 removed the to-review PRs to review label Oct 23, 2020

binbin0325 mentioned this pull request Dec 4, 2020

Support stat sliding window bucket count config of circuit breaker #338

Merged

Mulavar mentioned this pull request Nov 10, 2021

关于统一日志规范的建议讨论与收集 apache/dubbo-go#1477

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

unify logging content style #293

unify logging content style #293

binbin0325 commented Oct 15, 2020 •

edited

Loading

codecov-io commented Oct 17, 2020 •

edited

Loading

louyuting Oct 21, 2020

louyuting Oct 21, 2020 •

edited

Loading

louyuting Oct 21, 2020 •

edited

Loading

louyuting Oct 21, 2020

louyuting Oct 21, 2020

louyuting Oct 21, 2020

louyuting Oct 21, 2020

louyuting Oct 21, 2020

louyuting Oct 21, 2020

louyuting Oct 21, 2020

louyuting Oct 21, 2020

louyuting Oct 21, 2020

louyuting Oct 21, 2020

louyuting left a comment

unify logging content style #293

unify logging content style #293

Conversation

binbin0325 commented Oct 15, 2020 • edited Loading

Describe what this PR does / why we need it

Does this pull request fix one issue?

Describe how you did it

Describe how to verify it

Special notes for reviews

codecov-io commented Oct 17, 2020 • edited Loading

Codecov Report

Choose a reason for hiding this comment

louyuting Oct 21, 2020 • edited Loading

Choose a reason for hiding this comment

louyuting Oct 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

louyuting left a comment

Choose a reason for hiding this comment

binbin0325 commented Oct 15, 2020 •

edited

Loading

codecov-io commented Oct 17, 2020 •

edited

Loading

louyuting Oct 21, 2020 •

edited

Loading

louyuting Oct 21, 2020 •

edited

Loading