🩹 middleware/logger/: log client IP address by default (#2755)

* middleware/logger: Log client IP address by default. * Update doc.
gofiber · Dec 8, 2023 · c441bdf · c441bdf
1 parent 8aa8868
commit c441bdf
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/api/middleware/logger.md b/docs/api/middleware/logger.md
@@ -97,7 +97,7 @@ app.Use(logger.New(logger.Config{
 | Next             | `func(*fiber.Ctx) bool`    | Next defines a function to skip this middleware when returned true.                                                              | `nil`                                                  |
 | Done             | `func(*fiber.Ctx, []byte)` | Done is a function that is called after the log string for a request is written to Output, and pass the log string as parameter. | `nil`                                                  |
 | CustomTags       | `map[string]LogFunc`       | tagFunctions defines the custom tag action.                                                                                      | `map[string]LogFunc`                                   |
-| Format           | `string`                   | Format defines the logging tags.                                                                                                 | `[${time}] ${status} - ${latency} ${method} ${path}\n` |
+| Format           | `string`                   | Format defines the logging tags.                                                                                                 | `[${time}] ${ip} ${status} - ${latency} ${method} ${path}\n` |
 | TimeFormat       | `string`                   | TimeFormat defines the time format for log timestamps.                                                                           | `15:04:05`                                             |
 | TimeZone         | `string`                   | TimeZone can be specified, such as "UTC" and "America/New_York" and "Asia/Chongqing", etc                                        | `"Local"`                                              |
 | TimeInterval     | `time.Duration`            | TimeInterval is the delay before the timestamp is updated.                                                                       | `500 * time.Millisecond`                               |
@@ -112,7 +112,7 @@ app.Use(logger.New(logger.Config{
 var ConfigDefault = Config{
     Next:          nil,
     Done:          nil,
-    Format:        "[${time}] ${status} - ${latency} ${method} ${path}\n",
+    Format:        "[${time}] ${ip} ${status} - ${latency} ${method} ${path}\n",
     TimeFormat:    "15:04:05",
     TimeZone:      "Local",
     TimeInterval:  500 * time.Millisecond,

diff --git a/middleware/logger/config.go b/middleware/logger/config.go
@@ -28,7 +28,7 @@ type Config struct {
 
 	// Format defines the logging tags
 	//
-	// Optional. Default: [${time}] ${status} - ${latency} ${method} ${path}\n
+	// Optional. Default: [${time}] ${ip} ${status} - ${latency} ${method} ${path}\n
 	Format string
 
 	// TimeFormat https://programming.guide/go/format-parse-string-time-date-example.html
@@ -86,7 +86,7 @@ type LogFunc func(output Buffer, c *fiber.Ctx, data *Data, extraParam string) (i
 var ConfigDefault = Config{
 	Next:          nil,
 	Done:          nil,
-	Format:        "[${time}] ${status} - ${latency} ${method} ${path}\n",
+	Format:        "[${time}] ${ip} ${status} - ${latency} ${method} ${path}\n",
 	TimeFormat:    "15:04:05",
 	TimeZone:      "Local",
 	TimeInterval:  500 * time.Millisecond,