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

feat(log): Helper implemented io.Writer #1927

Merged
merged 3 commits into from May 6, 2022
Merged

feat(log): Helper implemented io.Writer #1927

merged 3 commits into from May 6, 2022

Conversation

elricli
Copy link
Contributor

@elricli elricli commented Apr 11, 2022

Implemented io.Writer, easy to use in standard library, like log.New.

Description (what this PR does / why we need it):

Helper can set to http.Server{}.ErrorLog.

Example 1(transport/http):

// import stdlog "log"
// import log "github.com/go-kratos/kratos/v2/log"
// file: https://github.com/go-kratos/kratos/blob/main/transport/http/server.go#L153
srv.Server = &http.Server{
	Handler:   FilterChain(srv.filters...)(srv.router),
	// record http error log to helper.
	ErrorLog:  stdlog.New(srv.log.WithWriterLevel(log.LevelError), "", 0),
}

Example 2 (go-redis):

// import stdlog "log"
// import log "github.com/go-kratos/kratos/v2/log"
helper := log.NewHelper(logger, log.WithWriterLevel(log.LevelInfo))
redis.SetLogger(stdlog.New(helper, "", 0))

Other special notes for reviewer:

@codecov-commenter
Copy link

codecov-commenter commented Apr 11, 2022

Codecov Report

Merging #1927 (bca4e54) into main (d5a2fb5) will increase coverage by 0.11%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1927      +/-   ##
==========================================
+ Coverage   80.65%   80.77%   +0.11%     
==========================================
  Files          81       82       +1     
  Lines        3587     3635      +48     
==========================================
+ Hits         2893     2936      +43     
- Misses        487      492       +5     
  Partials      207      207              
Impacted Files Coverage Δ
log/helper_writer.go 100.00% <100.00%> (ø)
selector/default_node.go 91.66% <0.00%> (-8.34%) ⬇️
transport/grpc/resolver/discovery/builder.go 80.76% <0.00%> (-4.34%) ⬇️
errors/errors.go 94.44% <0.00%> (-1.79%) ⬇️
transport/http/client.go 78.88% <0.00%> (ø)
transport/http/status/status.go 100.00% <0.00%> (ø)
transport/grpc/resolver/discovery/resolver.go 76.78% <0.00%> (+0.42%) ⬆️
transport/http/codec.go 63.41% <0.00%> (+2.88%) ⬆️
transport/http/router.go 100.00% <0.00%> (+4.76%) ⬆️

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 d5a2fb5...bca4e54. Read the comment docs.

@tonybase
Copy link
Member

tonybase commented Apr 27, 2022

infoWriter := log.NewWriter(logger, log.LevelInfo, "log")
warnWriter := log.NewWriter(logger, log.LevelWarn, "log")
errorWriter := log.NewWriter(logger, log.LevelError, "log")

redis.SetLogger(log.New(infoWriter, "redis: ", log.LstdFlags|log.Lshortfile))
grpclog.SetLogger(grpclog.NewLoggerV2(infoWriter, warnWriter, errorWriter))

You can provide a log writer to output third-party logs

@elricli
Copy link
Contributor Author

elricli commented Apr 28, 2022

infoWriter := log.NewWriter(logger, log.LevelInfo, "log")

Create and use a new function: NewWriter(logger Logger, level Level, msgKey string) instead of use WithWriterLevel, is it?

@tonybase
Copy link
Member

Yes, you can create a Writer Helper to do this.

@elricli
Copy link
Contributor Author

elricli commented Apr 29, 2022

Updated.

@tonybase tonybase merged commit eb2dcae into go-kratos:main May 6, 2022
tonybase pushed a commit that referenced this pull request May 31, 2022
* feat(log): Add writerWrapper implementing io.Writer

* fix(kratos): fix format has wrong type

* fix(log): rename writerOption to WriterOptionFn.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants