Skip to content

Add LoggerWithFormatter method#1677

Merged
thinkerou merged 7 commits into
gin-gonic:masterfrom
sairoutine:add_logger_with_config
Dec 12, 2018
Merged

Add LoggerWithFormatter method#1677
thinkerou merged 7 commits into
gin-gonic:masterfrom
sairoutine:add_logger_with_config

Conversation

@sairoutine

@sairoutine sairoutine commented Dec 1, 2018 •
edited
Loading

Copy link
Copy Markdown
Contributor

Problems

I want to define gin's log format.
Currently, instead of using the default Logger, I can define the log format by defining my own Logger function.

However, my own Logger function must include redundant codes similar to the default Logger.

ref. #1581

Proposal

This PR solves the problem by adding new methods, LoggerWithFormatter and LoggerWithConfig.

example code

r := gin.New()
r.Use(Recovery())
r.Use(LoggerWithFormatter(func(param gin.LogFormatterParams) string {
	// my own format
	return fmt.Sprintf("[GIN] %v | %3d | %13v | %15s | %-7s  %s | %s\n%s",
		param.TimeStamp.Format("2006/01/02 - 15:04:05"),
		param.StatusCode,
		param.Latency,
		param.ClientIP,
		param.Method,
		param.Path,
		SomeMyOwnParam(param.Request), // username or payload information
		param.ErrorMessage,
	)
}))

refs.
gorilla's LogFormatter
http://www.gorillatoolkit.org/pkg/handlers#LogFormatter

echo's LoggerWithConfig
https://echo.labstack.com/middleware/logger

At end

If you prefers to this proposal, I will add unit tests and documents.

Thanks.

@sairoutine sairoutine force-pushed the add_logger_with_config branch from 1eacad4 to 58da85a Compare December 1, 2018 13:51
@codecov

codecov Bot commented Dec 1, 2018 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Merging #1677 into master will increase coverage by 0.2%.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff            @@
##           master   #1677     +/-   ##
========================================
+ Coverage   99.19%   99.4%   +0.2%     
========================================
  Files          41      41             
  Lines        1995    2017     +22     
========================================
+ Hits         1979    2005     +26     
+ Misses         12       9      -3     
+ Partials        4       3      -1
Impacted Files Coverage Δ
logger.go 100% <100%> (+5.06%) ⬆️

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 cce4958...10b5f41. Read the comment docs.

@thinkerou

thinkerou commented Dec 6, 2018

Copy link
Copy Markdown
Member

@sairoutine Hi, can you see the log middleware https://github.com/gin-contrib/logger ? thanks!

@sairoutine

sairoutine commented Dec 6, 2018

Copy link
Copy Markdown
Contributor Author

@thinkerou
Yes, I've seen it but it is specialiced in rs/zerolog. this pull request provides a more general logging that the web application framework should have.

Also, by this pull request, Your suggested middleware will be the simpler code and it's redundant code will be eliminated.

Thanks.

@thinkerou

thinkerou commented Dec 7, 2018

Copy link
Copy Markdown
Member

@sairoutine please commit the whole code which includes unit test and example code, thanks, and then we review.

@sairoutine sairoutine force-pushed the add_logger_with_config branch from ad7235d to d7946ec Compare December 7, 2018 08:17
@sairoutine sairoutine force-pushed the add_logger_with_config branch from d7946ec to bae4c3a Compare December 7, 2018 08:18
@sairoutine sairoutine force-pushed the add_logger_with_config branch from 2f1ee78 to e6bbd22 Compare December 7, 2018 09:45
@sairoutine

sairoutine commented Dec 7, 2018

Copy link
Copy Markdown
Contributor Author

@thinkerou
Added unit test and README 👍
Please review. Thanks.

thinkerou
thinkerou reviewed Dec 8, 2018
View reviewed changes
Comment thread logger.go
thinkerou
thinkerou reviewed Dec 9, 2018
View reviewed changes
Comment thread logger.go Outdated
@thinkerou thinkerou added this to the 1.4 milestone Dec 9, 2018
@sairoutine sairoutine changed the title [Proposal] Add LoggerWithFormatter method Add LoggerWithFormatter method Dec 9, 2018
@thinkerou thinkerou merged commit f76ccb2 into gin-gonic:master Dec 12, 2018
@thinkerou thinkerou mentioned this pull request Dec 12, 2018
Closed
@sairoutine sairoutine deleted the add_logger_with_config branch December 12, 2018 03:56
@sairoutine

sairoutine commented Dec 12, 2018

Copy link
Copy Markdown
Contributor Author

Thank you for review and merge!

@thinkerou thinkerou mentioned this pull request Dec 19, 2018
Closed
@sairoutine sairoutine mentioned this pull request Dec 20, 2018
Merged
@sairoutine sairoutine mentioned this pull request Jan 19, 2019
Merged
@forestsource forestsource mentioned this pull request Mar 26, 2019
Closed
@thinkerou thinkerou mentioned this pull request Feb 26, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@appleboy appleboy appleboy approved these changes

@thinkerou thinkerou thinkerou approved these changes

Assignees

No one assigned

Labels

enhancement

Projects

None yet

Milestone

1.4

Development

Successfully merging this pull request may close these issues.

3 participants

@sairoutine @thinkerou @appleboy