[log] optimize console log format

[huof6829]

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #3476

Type of change

Please delete options that are not relevant.

• [] Bug fix (non-breaking change which fixes an issue)
• [] New feature (non-breaking change which adds functionality)
• [] Code refactor or improvement
• [] Breaking change (fix or feature that would cause a new or changed behavior of existing functionality)
• [] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• [] make test
• [] fullsync
• [] Other test (please specify)

Test Configuration:

• Firmware version:
• Hardware:
• Toolchain:
• SDK:

Checklist:

• [] My code follows the style guidelines of this project
• [] I have performed a self-review of my code
• [] I have commented my code, particularly in hard-to-understand areas
• [] I have made corresponding changes to the documentation
• [] My changes generate no new warnings
• [] I have added tests that prove my fix is effective or that my feature works
• [] New and existing unit tests pass locally with my changes
• [] Any dependent changes have been merged and published in downstream modules

[huof6829]

Just modify the starting log format for viewing. Leave the zap log because most codes use zap function. After zerolog merged, we can replace zap with zerolog.

output in cmdline:

/var/log/s.log is json formatter:

[huof6829]

One note: "github.com/iotexproject/go-p2p" use zap.Logger now. If change to zerolog, this project should also change together.

iotex-core/p2p/agent.go

Line 195 in c75411c

p2p.SetLogger(log.L())

[Liuhaai]

Could this format of logs be indexed?

[dustinxie]

see comment in #3476, we need to achieve:

1. the output to log file is still same json format, for ELK log collection/analysis purpose
2. on top of that, if it's possible to make the output to commandline window better

replace with zerolog does not seem a good solution to achieve both

[millken]

zap Encoder supportted customize log format，you can implement an encoder to replace default console encoder.

[codecov]

Codecov Report

Merging #3499 (ce2faee) into master (a20e489) will decrease coverage by 1.07%.
The diff coverage is 70.03%.

@@            Coverage Diff             @@
##           master    #3499      +/-   ##
==========================================
- Coverage   75.43%   74.35%   -1.08%     
==========================================
  Files         247      259      +12     
  Lines       22845    23536     +691     
==========================================
+ Hits        17233    17501     +268     
- Misses       4685     5107     +422     
- Partials      927      928       +1     

Impacted Files	Coverage Δ
action/action_deserializer.go	57.14% <ø> (ø)
action/protocol/poll/nativestaking.go	41.08% <0.00%> (-0.65%)	⬇️
action/protocol/poll/staking_command.go	10.71% <0.00%> (ø)
action/protocol/staking/read_state.go	15.38% <0.00%> (ø)
action/protocol/vote/probationlist.go	87.50% <ø> (ø)
api/blocklistener.go	70.73% <0.00%> (ø)
api/websocket.go	5.17% <0.00%> (-0.19%)	⬇️
blockchain/block/block_deserializer.go	71.15% <ø> (ø)
blockchain/blockchain.go	0.89% <0.00%> (ø)
blockchain/filedao/filedao_legacy.go	85.80% <ø> (ø)
... and 105 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[huof6829]

see comment in #3476, we need to achieve:

1. the output to log file is still same json format, for ELK log collection/analysis purpose
2. on top of that, if it's possible to make the output to commandline window better

replace with zerolog does not seem a good solution to achieve both

the log file is json format. colored printing in cmmandline. see the picture above

[huof6829]

see comment in #3476, we need to achieve:

1. the output to log file is still same json format, for ELK log collection/analysis purpose
2. on top of that, if it's possible to make the output to commandline window better

replace with zerolog does not seem a good solution to achieve both

Because of ELK, the log file format can't change. I'll try to find the humanly-printed setting by zap console encoder.

[huof6829]

add zap console encoder

s.log keeps the same.

[raullenchai]

ping @dustinxie @CoderZhi @Liuhaai - pls take another look

[Liuhaai]

cfg.Zap.Build(coreOpt, opts)?

[huof6829]

no. build error because type of opt is []zap.Option,

[dustinxie]

so looks like add a new console encoder to process the output in human-friendly format?

i assume you already run locally to verify the log format in the file has remained the same?

[huof6829]

yes, add console encoder. I run in test-net, log format is the same with older

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[raullenchai]

Thanks for making this one @huof6829 @dustinxie