🚀 Add Logger interface and fiberlog by Skyenought · Pull Request #2499 · gofiber/fiber

Skyenought · 2023-06-08T07:41:54Z

Description

Adding an interface for extending the log library

// AllLogger is the combination of Logger, FormatLogger, CtxLogger and ControlLogger.
// Custom extensions can be made through AllLogger
type AllLogger interface {
	Logger
	FormatLogger
	CtxLogger
	ControlLogger
        WithLogger
}

Pre-set log levels in advance

// Logger is a logger interface that provides logging function with levels.
type Logger interface {
	Trace(v ...interface{})
	Debug(v ...interface{})
	Info(v ...interface{})
	Warn(v ...interface{})
	Error(v ...interface{})
	Fatal(v ...interface{})
	Panic(v ...interface{})
}

Provides a way to print logs, with default standard output on the console

fiberlog.Info("Hello World!")
fiberlog.Trace("Hello World!")
fiberlog.Debug("Hello World!")
fiberlog.Warn("Hello World!")
fiberlog.Error("Hello World!")
fiberlog.Infow("", "key", "value")

2023/06/08 15:16:35.692976 main.go:12: [Info] Hello World!
2023/06/08 15:16:35.694025 main.go:13: [Trace] Hello World!
2023/06/08 15:16:35.694034 main.go:14: [Debug] Hello World!
2023/06/08 15:16:35.694043 main.go:16: [Warn] Hello World!
2023/06/08 15:16:35.694047 main.go:17: [Error] Hello World!
2023/06/08 15:16:35.694047 main.go:17: [Info] key=value

Example

package main

import (
	"github.com/gofiber/fiber/v2"
	"github.com/gofiber/fiber/v2/log"
	
	"os"
)

func main() {
	app := fiber.New()
	// set the level of logs below which logs will not be output.
	// Levels:
	// 0 - Trace, 1 - Debug, 2 - Info,  3 - Warn, 4 - Error, 5 - Fatal, 6 - Panic
	log.SetLevel(fiberlog.LevelNotice)
        // If user customs a logger
	log.SetLogger(customLogger)
	f, err := os.OpenFile("./output.log", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
	if err != nil {
		panic(err)
	}
	defer f.Close()
	// set the output destination for the logger.
	fiberlog.SetOutput(f)
	
	app.Get("/hello/world", func(c *fiber.Ctx) error {
		fiberlog.Info("Hello World!")
		return c.SendString("Hello World 👋!")
	})
	app.Get("/:option/world", func(c *fiber.Ctx) error {
		fiberlog.Error(c.Params("option") + " World!")
		return c.SendString(c.Params("option") + " World 👋!")
	})
	log.Fatal(app.Listen(":3000"))
}

Fixes # (issue)
#2433

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)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Checklist:

For new functionalities I follow the inspiration of the express js framework and built them similar in usage
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation - /docs/ directory for https://docs.gofiber.io/
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
If new dependencies exist, I have checked that they are really necessary and agreed with the maintainers/community (we want to have as few dependencies as possible)
I tried to make my code as fast as possible with as few allocations as possible
For new code I have written benchmarks so that they can be analyzed and improved

Commit formatting:

Use emojis on commit messages so it provides an easy way of identifying the purpose or intention of a commit. Check out the emoji cheatsheet here: https://gitmoji.carloscuesta.me/

gaby · 2023-06-09T01:54:01Z

@Skyenought Can you check the issues in the CI

Skyenought · 2023-06-09T01:58:47Z

i don't know what's happening, How did ci go wrong when I just added extra code?
The error is not what I changed.

gaby · 2023-06-09T02:02:38Z

@Skyenought Let me check... It's related to go 1.20.5 so it's not this PR.

Skyenought · 2023-06-09T02:04:37Z

@gaby thx

gaby · 2023-06-09T02:19:08Z

@Skyenought The setup-go action hasnt updated their manifest to support 1.20.5, thus why it fails

https://github.com/actions/go-versions/blob/main/versions-manifest.json

Rel actions/go-versions#75

Skyenought · 2023-06-09T04:30:52Z

trace debug info warn error fatal panic Is this enough log level in total?

gaby · 2023-06-09T12:23:50Z

@Skyenought Can you merge main into your branch.

Skyenought · 2023-06-09T12:24:31Z

Unfortunately there still seems to be a problem with the ci settings 🤔

If fiberlog is written without problems, I will try to replace all the places in fiber that use log with fiberlog

gaby · 2023-06-09T12:25:33Z

@Skyenought Try again, the Pr was reverted. That part should pass now. Just merge main into your branch

Skyenought · 2023-06-09T12:28:15Z

@Skyenought Try again, the Pr was reverted. That part should pass now. Just merge main into your branch

I've updated the branch, but it doesn't seem to work. @gaby

gaby · 2023-06-09T12:30:26Z

@Skyenought Try again, the Pr was reverted. That part should pass now. Just merge main into your branch

I've updated the branch, but it doesn't seem to work. @gaby

Those are not the latest changes, pull again.

gaby · 2023-06-09T12:37:14Z

You are missing the last commit from here: https://github.com/gofiber/fiber/commits/master

Skyenought · 2023-06-09T12:48:43Z

sorry! @gaby

gaby · 2023-06-09T13:00:27Z

@Skyenought Have you tried running the tests locally with -race ? There's a race condition

Skyenought · 2023-06-09T13:01:55Z

 cd fiberlog/
❯ go test ./... -v -race
=== RUN   Test_DefaultLogger              
--- PASS: Test_DefaultLogger (0.00s)      
=== RUN   Test_DefaultFormatLogger        
--- PASS: Test_DefaultFormatLogger (0.00s)
=== RUN   Test_CtxLogger                  
--- PASS: Test_CtxLogger (0.00s)          
=== RUN   Test_SetLevel
--- PASS: Test_SetLevel (0.00s)
=== RUN   Test_DefaultSystemLogger
--- PASS: Test_DefaultSystemLogger (0.00s)
=== RUN   Test_SetLogger
--- PASS: Test_SetLogger (0.00s)
PASS
ok      github.com/gofiber/fiber/v2/fiberlog    (cached)

The code that appears as DATA RACE is not the code I wrote. @gaby

gaby · 2023-06-09T13:08:56Z

 cd fiberlog/
❯ go test ./... -v -race
=== RUN   Test_DefaultLogger              
--- PASS: Test_DefaultLogger (0.00s)      
=== RUN   Test_DefaultFormatLogger        
--- PASS: Test_DefaultFormatLogger (0.00s)
=== RUN   Test_CtxLogger                  
--- PASS: Test_CtxLogger (0.00s)          
=== RUN   Test_SetLevel
--- PASS: Test_SetLevel (0.00s)
=== RUN   Test_DefaultSystemLogger
--- PASS: Test_DefaultSystemLogger (0.00s)
=== RUN   Test_SetLogger
--- PASS: Test_SetLogger (0.00s)
PASS
ok      github.com/gofiber/fiber/v2/fiberlog    (cached)

The code that appears as DATA RACE is not the code I wrote. @gaby

Correct but app.go now uses fiberlog and that affects other parts of the code. The code in that folder is fine test wise. Now you have to test/fix the rest of the library since several parts import app.go

Skyenought · 2023-06-09T13:11:15Z

GET

Skyenought · 2023-06-18T16:28:53Z

Is this related to Fiber using an older golangci-lint version?

I've triggered too many errchecks (I've solved golangci-lint, it's too strict), and now I'm thinking why the benchmark didn't pass😥

gaby · 2023-06-18T16:30:11Z

Is this related to Fiber using an older golangci-lint version?

I've triggered too many errchecks (I've solved golangci-lint, it's too strict), and now I'm thinking why the benchmark didn't pass😥

The benchmark thing is a known issue, since the runners can be unpredictible sometimes.

Not checking errors is a real issue though

Skyenought · 2023-06-18T16:34:45Z

ok，I see that those errors can be ignored, otherwise I wouldn't have ruled them out

Co-authored-by: Tomás Warynyca <41587659+tomaswarynyca@users.noreply.github.com>

Skyenought · 2023-06-19T14:37:10Z

After this PR merge, I will make the zap and zerolog changes available as soon as possible, and add examples to recipes

ReneWerner87 · 2023-06-19T16:25:53Z

After this PR merge, I will make the zap and zerolog changes available as soon as possible, and add examples to recipes

What do you mean with "zap and zero log changes"?

Btw can you post the benchmark numbers here, for the history

Skyenought · 2023-06-19T16:30:09Z

After this PR merge, I will make the zap and zerolog changes available as soon as possible, and add examples to recipes

What do you mean with "zap and zero log changes"?

Btw can you post the benchmark numbers here, for the history

I mean it will be in fiberzap and fiberzerolog to add support for log packages

ReneWerner87 · 2023-06-19T16:32:36Z

Ok, so a wrapper for the interface

Don't forget the benchmark numbers

Skyenought · 2023-06-19T16:53:07Z

Ok, so a wrapper for the interface

Don't forget the benchmark numbers

It looks like the performance of fiber/log is similar to that of the native log package.

// BenchmarkDefaultLoggerInfo-2       88129             26447 ns/op
func BenchmarkDefaultLoggerInfo(b *testing.B) {
	for n := 0; n < b.N; n++ {
		DefaultLogger().Info("test")
	}
}

// BenchmarkLogPrintln-2              62989             26672 ns/op
func BenchmarkLogPrintln(b *testing.B) {
	l := log.New(os.Stderr, "", log.LstdFlags|log.Lshortfile|log.Lmicroseconds)
	for n := 0; n < b.N; n++ {
		l.Println("[Info] test")
	}
}

// BenchmarkDefaultLoggerInfof-2              56754             26381 ns/op
func BenchmarkDefaultLoggerInfof(b *testing.B) {
	for n := 0; n < b.N; n++ {
		DefaultLogger().Infof("test: %s", "log")
	}
}

// BenchmarkLogPrintf-2       49744             27731 ns/op
func BenchmarkLogPrintf(b *testing.B) {
	l := log.New(os.Stderr, "", log.LstdFlags|log.Lshortfile|log.Lmicroseconds)
	for n := 0; n < b.N; n++ {
		l.Printf("[Info] test %s", "log")
	}
}

ReneWerner87 · 2023-06-19T21:50:31Z

Can you add the info about the allocations

Skyenought · 2023-06-20T00:29:27Z

goos: linux                                   
goarch: amd64                                 
pkg: github.com/gofiber/fiber/v2/log          
cpu: Intel(R) Core(TM) i5-1035G1 CPU @ 1.00GHz
BenchmarkDefaultLoggerInfo-2              625828              1716 ns/op             561 B/op          4 allocs/op
BenchmarkDefaultLoggerInfof-2             668976              1929 ns/op             608 B/op          3 allocs/op
BenchmarkLogPrintln-2                     944955              1330 ns/op             564 B/op          3 allocs/op
BenchmarkLogPrintf-2                      846170              1303 ns/op             603 B/op          3 allocs/op

gaby · 2023-06-20T01:38:38Z

@Skyenought Can it be compared to this fiberzerolog? https://github.com/gofiber/contrib/tree/main/fiberzerolog

Skyenought · 2023-06-20T01:57:27Z

@Skyenought Can it be compared to this fiberzerolog? https://github.com/gofiber/contrib/tree/main/fiberzerolog

The defaultLogger is only used to build in a logging specification, I think it's just as good as the native log, the zerolog adaptation is not yet complete, I can provide the fiberzap

// 1581740              1119 ns/op               2 B/op          0 allocs/op
func BenchmarkNativeZap(b *testing.B) {
	log, _ := zap.NewProduction()
	for i := 0; i < b.N; i++ {
		log.Info("Hello, World!")
	}
}

// 1244044              1406 ns/op              18 B/op          1 allocs/op
func BenchmarkFiberZap(b *testing.B) {
	log, _ := zap.NewProduction()
	logger := NewLogger(LoggerConfig{
		SetLogger: log,
	})
	fiberlog.SetLogger(logger)
	for i := 0; i < b.N; i++ {
		fiberlog.Info("Hello, World!")
	}
}

gaby · 2023-06-22T11:34:31Z

@Skyenought Can it be compared to this fiberzerolog? https://github.com/gofiber/contrib/tree/main/fiberzerolog

The defaultLogger is only used to build in a logging specification, I think it's just as good as the native log, the zerolog adaptation is not yet complete, I can provide the fiberzap
// 1581740              1119 ns/op               2 B/op          0 allocs/op
func BenchmarkNativeZap(b *testing.B) {
	log, _ := zap.NewProduction()
	for i := 0; i < b.N; i++ {
		log.Info("Hello, World!")
	}
}

// 1244044              1406 ns/op              18 B/op          1 allocs/op
func BenchmarkFiberZap(b *testing.B) {
	log, _ := zap.NewProduction()
	logger := NewLogger(LoggerConfig{
		SetLogger: log,
	})
	fiberlog.SetLogger(logger)
	for i := 0; i < b.N; i++ {
		fiberlog.Info("Hello, World!")
	}
}

@Skyenought What is missing to support Zerolog?

Skyenought · 2023-06-23T00:48:35Z

i am busy now，i think adapter for zerolog need to wait 1 week

gaby · 2023-06-23T02:23:22Z

i am busy now，i think adapter for zerolog need to wait 1 week

No worries, thanks! 💪

Skyenought force-pushed the feat/log branch 8 times, most recently from e0eaa3b to 044bf4d Compare June 9, 2023 01:35

Skyenought requested review from ReneWerner87 and gaby June 9, 2023 01:41

Skyenought force-pushed the feat/log branch from cf778de to f35a37c Compare June 9, 2023 07:50

Skyenought force-pushed the feat/log branch from f35a37c to 5aa4567 Compare June 9, 2023 12:48

Skyenought force-pushed the feat/log branch from 8ed03ee to 34c1efc Compare June 9, 2023 13:51

ReneWerner87 approved these changes Jun 19, 2023

View reviewed changes

ReneWerner87 mentioned this pull request Jun 19, 2023

🚀 [Feature]: Add Logger interface #2433

Closed

3 tasks

Skyenought and others added 10 commits June 19, 2023 21:02

add log for fiber

336bc63

replace log in fiber

2bdbb37

add Log use to adapt for log libraries

c3171be

Update app.go

bd3da60

Co-authored-by: Tomás Warynyca <41587659+tomaswarynyca@users.noreply.github.com>

wip: add log docs

7c2af59

add WithLogger use to print key and value

086ef59

remove CtxLogger and add WithContext use to bind Context

8d26e83

fix errcheck

6d129be

fix errcheck

4039a7b

update log.md

4e5e237

Skyenought force-pushed the feat/log branch from caeacd6 to 4e5e237 Compare June 19, 2023 13:02

ReneWerner87 merged commit fefc533 into gofiber:master Jun 26, 2023

folliehiyuki mentioned this pull request Nov 21, 2023

🚀 [Feature]: middleware/logger: use Logger interface #2737

Closed

3 tasks

Uh oh!

Conversation

Skyenought commented Jun 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Example

Type of change

Checklist:

Commit formatting:

Uh oh!

gaby commented Jun 9, 2023

Uh oh!

Skyenought commented Jun 9, 2023

Uh oh!

gaby commented Jun 9, 2023

Uh oh!

Skyenought commented Jun 9, 2023

Uh oh!

gaby commented Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Skyenought commented Jun 9, 2023

Uh oh!

gaby commented Jun 9, 2023

Uh oh!

Skyenought commented Jun 9, 2023

Uh oh!

gaby commented Jun 9, 2023

Uh oh!

Skyenought commented Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gaby commented Jun 9, 2023

Uh oh!

gaby commented Jun 9, 2023

Uh oh!

Skyenought commented Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gaby commented Jun 9, 2023

Uh oh!

Skyenought commented Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gaby commented Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Skyenought commented Jun 9, 2023

Uh oh!

Skyenought commented Jun 18, 2023

Uh oh!

gaby commented Jun 18, 2023

Uh oh!

Skyenought commented Jun 18, 2023

Uh oh!

Skyenought commented Jun 19, 2023

Uh oh!

ReneWerner87 commented Jun 19, 2023

Uh oh!

Skyenought commented Jun 19, 2023

Uh oh!

ReneWerner87 commented Jun 19, 2023

Uh oh!

Skyenought commented Jun 19, 2023

Uh oh!

ReneWerner87 commented Jun 19, 2023

Uh oh!

Skyenought commented Jun 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gaby commented Jun 20, 2023

Uh oh!

Skyenought commented Jun 20, 2023

Uh oh!

gaby commented Jun 22, 2023

Uh oh!

Skyenought commented Jun 23, 2023

Uh oh!

gaby commented Jun 23, 2023

Uh oh!

Skyenought commented Jun 8, 2023 •

edited

Loading

gaby commented Jun 9, 2023 •

edited

Loading

Skyenought commented Jun 9, 2023 •

edited

Loading

Skyenought commented Jun 9, 2023 •

edited

Loading

Skyenought commented Jun 9, 2023 •

edited

Loading

gaby commented Jun 9, 2023 •

edited

Loading

Skyenought commented Jun 20, 2023 •

edited

Loading