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

v3: fix logger benchmarks #2074

Merged
merged 4 commits into from
Sep 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions middleware/logger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ func main() {

log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr})

app.Use(logger.New(logger.Config{LoggerFunc: func(c fiber.Ctx, data logger.LoggerData, cfg logger.Config) error {
app.Use(logger.New(logger.Config{LoggerFunc: func(c fiber.Ctx, data *logger.LoggerData, cfg logger.Config) error {
log.Info().
Str("path", c.Path()).
Str("method", c.Method()).
Expand Down Expand Up @@ -158,7 +158,7 @@ type Config struct {
// If you don't define anything for this field, it'll use classical logger of Fiber.
//
// Optional. Default: defaultLogger
LoggerFunc func(c fiber.Ctx, data LoggerData, cfg Config) error
LoggerFunc func(c fiber.Ctx, data *LoggerData, cfg Config) error
}
```

Expand Down
2 changes: 1 addition & 1 deletion middleware/logger/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ type Config struct {
// If you don't define anything for this field, it'll use default logger of Fiber.
//
// Optional. Default: defaultLogger
LoggerFunc func(c fiber.Ctx, data LoggerData, cfg Config) error
LoggerFunc func(c fiber.Ctx, data *LoggerData, cfg Config) error

enableColors bool
enableLatency bool
Expand Down
9 changes: 4 additions & 5 deletions middleware/logger/default_logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (

// LoggerData is a struct to define some variables to use in custom logger function.
type LoggerData struct {
mu sync.Mutex
Pid string
ErrPaddingStr string
ChainErr error
Expand All @@ -30,9 +31,7 @@ type LoggerData struct {
var tmpl *fasttemplate.Template

// default logger for fiber
func defaultLogger(c fiber.Ctx, data LoggerData, cfg Config) error {
var mu sync.Mutex

func defaultLogger(c fiber.Ctx, data *LoggerData, cfg Config) error {
// Alias colors
colors := c.App().Config().ColorScheme

Expand Down Expand Up @@ -185,7 +184,7 @@ func defaultLogger(c fiber.Ctx, data LoggerData, cfg Config) error {
if err != nil {
_, _ = buf.WriteString(err.Error())
}
mu.Lock()
data.mu.Lock()
// Write buffer to output
if _, err := cfg.Output.Write(buf.Bytes()); err != nil {
// Write error to output
Expand All @@ -194,7 +193,7 @@ func defaultLogger(c fiber.Ctx, data LoggerData, cfg Config) error {
fmt.Fprintf(os.Stderr, "Failed to write to log, %v\n", err)
}
}
mu.Unlock()
data.mu.Unlock()
// Put buffer back to pool
bytebufferpool.Put(buf)

Expand Down
25 changes: 16 additions & 9 deletions middleware/logger/logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ func New(config ...Config) fiber.Handler {

// Set variables
var (
mu sync.Mutex
once sync.Once
errHandler fiber.ErrorHandler
)
Expand All @@ -99,6 +100,13 @@ func New(config ...Config) fiber.Handler {
// Before handling func
cfg.BeforeHandlerFunc(cfg)

// Logger data
data := &LoggerData{
Pid: pid,
ErrPaddingStr: errPaddingStr,
Timestamp: timestamp,
}

// Return new handler
return func(c fiber.Ctx) (err error) {
// Don't execute middleware if Next returns true
Expand Down Expand Up @@ -144,17 +152,16 @@ func New(config ...Config) fiber.Handler {
stop = time.Now()
}

// Logger instance
if err = cfg.LoggerFunc(c, LoggerData{
Pid: pid,
ErrPaddingStr: errPaddingStr,
ChainErr: chainErr,
Start: start,
Stop: stop,
Timestamp: timestamp,
}, cfg); err != nil {
// Logger instance & update some logger data fields
mu.Lock()
data.ChainErr = chainErr
data.Start = start
data.Stop = stop

if err = cfg.LoggerFunc(c, data, cfg); err != nil {
return err
}
mu.Unlock()

return nil
}
Expand Down