Feature Request: Add a Pre-Write Callback to Logger Middleware

[bantawa04]

Currently, the logger.New middleware in Fiber writes logs to the specified Output file automatically. While the Done callback allows for post-processing of the log string, there's no way to control whether a log entry is written to the file at all before it's written. This makes it difficult to implement fine-grained logging logic, such as selectively logging certain responses based on their content or other criteria.

Problem:

I have a use case where I want to log only specific errors (e.g., 4xx/5xx status codes) to an error log file, and potentially other requests (e.g., 2xx) to a separate debug or access log file. The current Done callback is called after the log has already been written to the Output file. This results in either:

1. Double Logging: If I use Done to filter logs and write to my error log file, the middleware also writes all logs to the Output file, leading to duplication.
2. Inability to Selectively Log: If I don't use Done, I can't filter which log entries are written to which file.

Code from my use case

app.Use(logger.New())
app.Use(logger.New(logger.Config{
	TimeFormat: "2006-01-02 15:04:05",
	TimeZone:   "Local",
	Format:     "\n" + `{"timestamp":"${time}", "status":${status}, "latency":"${latency}", "method":"${method}", "path":"${path}", "error":"${error}", "response":[${resBody}]}`,
	Output:     errorLogFile,
	Done: func(c *fiber.Ctx, logString []byte) {
		if c.Response().StatusCode() >= 400 {
			fmt.Println("printing to error.log")
			errorLogFile.Write(logString)
			defer errorLogFile.Close()
		}
	},
}))

Proposed Solution/Feature request:

I propose adding a new callback function to the logger.Config called something like BeforeWrite or ShouldLog. This callback would be executed before the middleware writes the log entry to the Output file. The callback would receive the fiber.Ctx and the log string as arguments and would return a boolean value: true if the log should be written, and false if it should be skipped.

Example Usage:

app.Use(logger.New(logger.Config{
    TimeFormat: "2006-01-02 15:04:05",
    TimeZone:   "Local",
    Format:     `{"timestamp":"${time}", "status":${status}, ...}`, //Log format
    Output:     logFile, // General log file (optional)
    BeforeWrite: func(c *fiber.Ctx, logString []byte) bool {
        if c.Response().StatusCode() >= 400 {
            // Log errors to the error log file
            errorLogFile.Write(logString) // Example, we can write to different files here.
            return true // Write to the main log file as well (optional). We can return false if we only want to write to the error log.
        } else if c.Response().StatusCode() == 200 {
            // Log 200 OK requests to a separate access log
            accessLogFile.Write(logString)
            return true // Write to the main log file as well (optional). We can return false if we only want to write to the access log.
        }
        return false // Don't write other requests to the main log file.
    },
    Done: func(c *fiber.Ctx, logString []byte) {
        // Any post-processing 
    },
}))

[welcome]

Thanks for opening your first issue here! 🎉 Be sure to follow the issue template! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

[gaby]

I agree on adding this, got to check other logging framework to see how they name this kind of feature.

[liaohongxing]

I agree with adding this, but BeforeWrite should be renamed, according to other middlewares in gofiber, similar names are "Next" or "Filter"

[gaby]

Agree with @liaohongxing this should be named Filter.

[KernelDeimos]

If I can throw my own two cents in here, this feels like a job for the decorator pattern

[gaby]

@bantawa04 Does #3333 cover your use-case?

I don't think we need the "logstring" param, since the middleware will write to output after calling "filter()".

[gaby]

@bantawa04 This feature will be available in Fiber v3 as Skip().

Example Usage:

app := fiber.New()

app.Use(logger.New(logger.Config{
    Skip: func(c fiber.Ctx) bool {
        // Skip any code below 400
        return c.Response().StatusCode() < 400
    },
    Stream: ErrorLogStream
}))

app.Use(logger.New(logger.Config{
    Skip: func(c fiber.Ctx) bool {
        // Skip any code other than HTTP 200
        return c.Response().StatusCode() != fiber.StatusOK
    },
    Stream: AccessLogStream
}))