middleware/requestid: mention that the default UUID generator exposes…

… the number of requests made to the server (#2241)
gofiber · Dec 1, 2022 · 17dfcc7 · 17dfcc7 · ReneWerner87 · Dec 1, 2022
1 parent 6d798db
commit 17dfcc7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/middleware/requestid/README.md b/middleware/requestid/README.md
@@ -64,13 +64,15 @@ type Config struct {
 ```
 
 ### Default Config
+The default config uses a fast UUID generator which will expose the number of
+requests made to the server. To conceal this value for better privacy, use the
+`utils.UUIDv4` generator.
+
 ```go
 var ConfigDefault = Config{
 	Next:       nil,
 	Header:     fiber.HeaderXRequestID,
-	Generator:  func() string {
-		return utils.UUID()
-	},
-	ContextKey: "requestid"
+	Generator:  utils.UUID,
+	ContextKey: "requestid",
 }
 ```
diff --git a/middleware/requestid/config.go b/middleware/requestid/config.go
@@ -30,6 +30,9 @@ type Config struct {
 }
 
 // ConfigDefault is the default config
+// It uses a fast UUID generator which will expose the number of
+// requests made to the server. To conceal this value for better
+// privacy, use the "utils.UUIDv4" generator.
 var ConfigDefault = Config{
 	Next:       nil,
 	Header:     fiber.HeaderXRequestID,