Revise log messages along with the coding guideline #504

rinx · 2020-06-23T01:52:19Z

Signed-off-by: Rintaro Okamura rintaro.okamura@gmail.com

Description:

Revise log messages and levels along with the coding guideline.

log levels
add messages
remove useless stacktraces

index managers now ignore precondition error from agents. (just printing debug logs)

also fixed several anti-patterns pointed by deepsource.

Related Issue:

nothing.

How Has This Been Tested?:

nothing.

Environment:

Go Version: 1.14.3
Docker Version: 19.03.8
Kubernetes Version: 1.18.2
NGT Version: 1.11.5

Types of changes:

Bug fix [type/bug]
New feature [type/feature]
Add tests [type/test]
Security related changes [type/security]
Add documents [type/documentation]
Refactoring [type/refactoring]
Update dependencies [type/dependency]
Update benchmarks and performances [type/bench]
Update CI [type/ci]

Changes to Core Features:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your core changes, as applicable?
Have you successfully ran tests with your changes locally?

Checklist:

I have read the CONTRIBUTING document.
I have checked open Pull Requests for the similar feature or fixes?
I have added tests and benchmarks to cover my changes.
I have ensured all new and existing tests passed.
I have commented my code, particularly in hard-to-understand areas
I have updated the documentation accordingly.

pull-assistant · 2020-06-23T01:52:21Z

Best reviewed: commit by commit

Optimal code review plan (1 warning)

🔊 Revise log messages

...re/ngt/handler/grpc/handler.go 50% changes removed in 🥅 handling ...

...nager/index/service/indexer.go 62% changes removed in 🥅 handling ...

🚨 Fix the problems pointed by deepsource go

🥅 handling 'uncommitted index not found' error as failed prec...

🔇 remove useless stacktraces

Merge branch 'master' into refactor/internal-pkgs/revise-log-messages

Powered by Pull Assistant. Last update 8996242 ... 5cd8094. Read the comment docs.

pkg/agent/core/ngt/handler/grpc/handler.go

pkg/manager/index/service/indexer.go

codecov · 2020-06-23T02:00:35Z

Codecov Report

Merging #504 into master will increase coverage by 0.02%.
The diff coverage is 8.16%.

@@            Coverage Diff            @@
##           master    #504      +/-   ##
=========================================
+ Coverage    9.13%   9.15%   +0.02%     
=========================================
  Files         402     402              
  Lines       20852   20848       -4     
=========================================
+ Hits         1905    1909       +4     
+ Misses      18694   18686       -8     
  Partials      253     253

Impacted Files	Coverage Δ
internal/client/discoverer/discover.go	`0.00% <0.00%> (ø)`
internal/file/watch/watch.go	`0.00% <0.00%> (ø)`
internal/net/grpc/pool/pool.go	`0.00% <0.00%> (ø)`
internal/net/grpc/status/status.go	`0.00% <0.00%> (ø)`
internal/worker/worker.go	`0.00% <0.00%> (ø)`
pkg/agent/core/ngt/handler/grpc/handler.go	`0.00% <0.00%> (ø)`
pkg/agent/core/ngt/service/ngt.go	`0.00% <0.00%> (ø)`
pkg/agent/core/ngt/usecase/agentd.go	`0.00% <ø> (ø)`
pkg/agent/sidecar/service/observer/observer.go	`0.00% <0.00%> (ø)`
pkg/agent/sidecar/service/restorer/restorer.go	`0.00% <0.00%> (ø)`
... and 25 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 cc3c71b...5cd8094. Read the comment docs.

github-actions · 2020-06-30T07:39:28Z

internal/servers/server/option.go

@@ -187,7 +187,7 @@ func WithListenConfig(lc *net.ListenConfig) Option {
 	}
 }

-func WithServerMode(m mode) Option {
+func WithServerMode(m ServerMode) Option {


[golangci] _{reported by reviewdog 🐶}
exported function WithServerMode should have comment or be unexported (golint)

github-actions · 2020-06-30T07:39:29Z

internal/servers/server/server.go

@@ -44,15 +44,15 @@ type Server interface {
 	Shutdown(context.Context) error
 }

-type mode uint8
+type ServerMode uint8


[golangci] _{reported by reviewdog 🐶}
exported type ServerMode should have comment or be unexported (golint)

github-actions · 2020-06-30T07:39:29Z

internal/servers/server/server.go


 const (
-	REST mode = 1 + iota
+	REST ServerMode = 1 + iota


[golangci] _{reported by reviewdog 🐶}
exported const REST should have comment (or a comment on this block) or be unexported (golint)

rinx · 2020-07-01T08:08:14Z

/rebase
/format

vdaas-ci · 2020-07-01T08:08:51Z

[REBASE] Rebase triggered by rinx for branch: refactor/internal-pkgs/revise-log-messages

vdaas-ci · 2020-07-01T08:09:59Z

[FORMAT] Updating license headers and formatting go codes triggered by rinx.

kpango

LGTM

kpango · 2020-07-02T03:22:50Z

/rebase
/format

vdaas-ci · 2020-07-02T03:23:22Z

[REBASE] Rebase triggered by kpango for branch: refactor/internal-pkgs/revise-log-messages

Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>

… error Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>

Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>

vdaas-ci · 2020-07-02T03:24:16Z

[FORMAT] Updating license headers and formatting go codes triggered by kpango.

* 🔊 Revise log messages Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com> * 🚨 Fix the problems pointed by deepsource go Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com> * 🥅 handling 'uncommitted index not found' error as failed precondition error Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com> * 🔇 remove useless stacktraces Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com> Co-authored-by: Yusuke Kato <i.can.feel.gravity@gmail.com>

github-actions bot added area/agent/core area/agent/sidecar area/discoverer area/gateway area/internal area/manager/backup area/manager/index area/manager/replication area/meta area/tools/cli/loadtest size/L type/refactoring priority/low labels Jun 23, 2020

rinx commented Jun 23, 2020

View reviewed changes

pkg/agent/core/ngt/handler/grpc/handler.go Outdated Show resolved Hide resolved

rinx commented Jun 23, 2020

View reviewed changes

pkg/manager/index/service/indexer.go Outdated Show resolved Hide resolved

github-actions bot added the team/set SET team label Jun 23, 2020

rinx force-pushed the refactor/internal-pkgs/revise-log-messages branch 2 times, most recently from e3d6d06 to 406d981 Compare June 30, 2020 02:17

rinx marked this pull request as ready for review June 30, 2020 07:33

rinx force-pushed the refactor/internal-pkgs/revise-log-messages branch from b2f6306 to 07a85f5 Compare June 30, 2020 07:34

github-actions bot reviewed Jun 30, 2020

View reviewed changes

vdaas-ci force-pushed the refactor/internal-pkgs/revise-log-messages branch from 07a85f5 to 32b2024 Compare July 1, 2020 08:08

rinx requested a review from kpango July 1, 2020 08:09

kpango previously approved these changes Jul 2, 2020

View reviewed changes

rinx added 4 commits July 2, 2020 03:23

🔊 Revise log messages

8996242

Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>

🚨 Fix the problems pointed by deepsource go

b4fd7ba

Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>

🥅 handling 'uncommitted index not found' error as failed precondition…

4d12f21

… error Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>

🔇 remove useless stacktraces

4da515a

Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>

vdaas-ci dismissed kpango’s stale review via 4da515a July 2, 2020 03:23

vdaas-ci force-pushed the refactor/internal-pkgs/revise-log-messages branch from 32b2024 to 4da515a Compare July 2, 2020 03:23

Merge branch 'master' into refactor/internal-pkgs/revise-log-messages

5cd8094

kpango merged commit f38b72c into master Jul 2, 2020

kpango deleted the refactor/internal-pkgs/revise-log-messages branch July 2, 2020 03:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revise log messages along with the coding guideline #504

Revise log messages along with the coding guideline #504

rinx commented Jun 23, 2020 •

edited

Loading

pull-assistant bot commented Jun 23, 2020 •

edited

Loading

codecov bot commented Jun 23, 2020 •

edited

Loading

github-actions bot Jun 30, 2020

github-actions bot Jun 30, 2020

github-actions bot Jun 30, 2020

rinx commented Jul 1, 2020

vdaas-ci commented Jul 1, 2020

vdaas-ci commented Jul 1, 2020

kpango left a comment

kpango commented Jul 2, 2020

vdaas-ci commented Jul 2, 2020

vdaas-ci commented Jul 2, 2020

Revise log messages along with the coding guideline #504

Revise log messages along with the coding guideline #504

Conversation

rinx commented Jun 23, 2020 • edited Loading

Description:

Related Issue:

How Has This Been Tested?:

Environment:

Types of changes:

Changes to Core Features:

Checklist:

pull-assistant bot commented Jun 23, 2020 • edited Loading

codecov bot commented Jun 23, 2020 • edited Loading

Codecov Report

github-actions bot Jun 30, 2020

Choose a reason for hiding this comment

github-actions bot Jun 30, 2020

Choose a reason for hiding this comment

github-actions bot Jun 30, 2020

Choose a reason for hiding this comment

rinx commented Jul 1, 2020

vdaas-ci commented Jul 1, 2020

vdaas-ci commented Jul 1, 2020

kpango left a comment

Choose a reason for hiding this comment

kpango commented Jul 2, 2020

vdaas-ci commented Jul 2, 2020

vdaas-ci commented Jul 2, 2020

rinx commented Jun 23, 2020 •

edited

Loading

pull-assistant bot commented Jun 23, 2020 •

edited

Loading

codecov bot commented Jun 23, 2020 •

edited

Loading