Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

log: make sealer log printing unified, structured and more readable #1568

Merged
merged 1 commit into from
Jul 11, 2022

Conversation

allencloud
Copy link
Member

Signed-off-by: Allen Sun [email protected]

Describe what this PR does / why we need it

This pull request updated area of sealer's log.

Currently, end users bear a lot on sealer's log. There are lots of cases where end user could not recognize the log's meaning, even if he is a senior k8s or sealer engineer. We have to say sealer's log needs improvement.

First, just make the error message and log message readable, to satisfy normal user's English reading.
Second, provide helpful information as sufficient as possible.

And This pull request went through all log and error code of sealer project, and improved them within itself.

In the future, we still keep pace with user's input to improve log and error, such as: improving the accurate embedded message, shorten log information with continuous arch improving.

Does this pull request fix one issue?

none

Describe how you did it

none

Describe how to verify it

none

Special notes for reviews

none

@github-actions github-actions bot added ImageBuilding related to all staff with image building plugin labels Jul 9, 2022
@kakaZhou719
Copy link
Member

/test apply

@codecov-commenter
Copy link

Codecov Report

Merging #1568 (d1ebf9d) into main (4f515ac) will increase coverage by 0.00%.
The diff coverage is 0.57%.

@@           Coverage Diff           @@
##             main    #1568   +/-   ##
=======================================
  Coverage   11.10%   11.10%           
=======================================
  Files          88       88           
  Lines        8063     8062    -1     
=======================================
  Hits          895      895           
+ Misses       7057     7056    -1     
  Partials      111      111           
Impacted Files Coverage Δ
build/layerutils/charts/charts.go 0.00% <0.00%> (ø)
build/layerutils/charts/helm.go 0.00% <0.00%> (ø)
build/layerutils/manifests/manifests.go 0.00% <0.00%> (ø)
pkg/config/pre_process.go 0.00% <0.00%> (ø)
pkg/env/env.go 57.83% <0.00%> (ø)
pkg/filesystem/filesystem.go 0.00% <0.00%> (ø)
pkg/image/default_image.go 0.00% <0.00%> (ø)
pkg/image/default_image_file.go 0.00% <0.00%> (ø)
pkg/image/save/save.go 0.00% <0.00%> (ø)
pkg/image/store/filesystem.go 0.00% <0.00%> (ø)
... and 32 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 4f515ac...d1ebf9d. Read the comment docs.

@kakaZhou719 kakaZhou719 merged commit 9a7b886 into sealerio:main Jul 11, 2022
@allencloud allencloud deleted the polish-log branch July 11, 2022 04:15
starComingup pushed a commit to starComingup/sealer that referenced this pull request Jul 12, 2022
@allencloud allencloud restored the polish-log branch September 14, 2022 02:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ImageBuilding related to all staff with image building plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants