🚀 Consistent way of logging and fix middleware log format (#2432)

* 🚀 Replace fmt.Print* with log.Print* (#2402) * 🚀 Fix middleware logging format (#2402)
gofiber · May 1, 2023 · a59d9ba · a59d9ba
1 parent 9d8eba5
commit a59d9ba
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 16 deletions.
diff --git a/internal/template/html/html.go b/internal/template/html/html.go
@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"html/template"
 	"io"
+	"log"
 	"net/http"
 	"os"
 	"path/filepath"
@@ -112,7 +113,7 @@ func (e *Engine) Debug(enabled bool) *Engine {
 
 // Parse is deprecated, please use Load() instead
 func (e *Engine) Parse() error {
-	fmt.Println("Parse() is deprecated, please use Load() instead.")
+	log.Println("[Warning] Parse() is deprecated, please use Load() instead.")
 	return e.Load()
 }
 
@@ -169,7 +170,7 @@ func (e *Engine) Load() error {
 		}
 		// Debugging
 		if e.debug {
-			fmt.Printf("views: parsed template: %s\n", name)
+			log.Printf("views: parsed template: %s\n", name)
 		}
 		return err
 	}

diff --git a/middleware/cache/config.go b/middleware/cache/config.go
@@ -102,11 +102,11 @@ func configDefault(config ...Config) Config {
 
 	// Set default values
 	if cfg.Store != nil {
-		log.Printf("[CACHE] Store is deprecated, please use Storage\n")
+		log.Printf("[CACHE] - [Warning] Store is deprecated, please use Storage\n")
 		cfg.Storage = cfg.Store
 	}
 	if cfg.Key != nil {
-		log.Printf("[CACHE] Key is deprecated, please use KeyGenerator\n")
+		log.Printf("[CACHE] - [Warning] Key is deprecated, please use KeyGenerator\n")
 		cfg.KeyGenerator = cfg.Key
 	}
 	if cfg.Next == nil {

diff --git a/middleware/csrf/config.go b/middleware/csrf/config.go
@@ -132,15 +132,15 @@ func configDefault(config ...Config) Config {
 
 	// Set default values
 	if cfg.TokenLookup != "" {
-		log.Printf("[CSRF] TokenLookup is deprecated, please use KeyLookup\n")
+		log.Printf("[CSRF] - [Warning] TokenLookup is deprecated, please use KeyLookup\n")
 		cfg.KeyLookup = cfg.TokenLookup
 	}
 	if int(cfg.CookieExpires.Seconds()) > 0 {
-		log.Printf("[CSRF] CookieExpires is deprecated, please use Expiration\n")
+		log.Printf("[CSRF] - [Warning] CookieExpires is deprecated, please use Expiration\n")
 		cfg.Expiration = cfg.CookieExpires
 	}
 	if cfg.Cookie != nil {
-		log.Printf("[CSRF] Cookie is deprecated, please use Cookie* related fields\n")
+		log.Printf("[CSRF] - [Warning] Cookie is deprecated, please use Cookie* related fields\n")
 		if cfg.Cookie.Name != "" {
 			cfg.CookieName = cfg.Cookie.Name
 		}

diff --git a/middleware/idempotency/idempotency.go b/middleware/idempotency/idempotency.go
@@ -92,7 +92,7 @@ func New(config ...Config) fiber.Handler {
 		}
 		defer func() {
 			if err := cfg.Lock.Unlock(key); err != nil {
-				log.Printf("middleware/idempotency: failed to unlock key %q: %v", key, err)
+				log.Printf("[IDEMPOTENCY] - [Error] failed to unlock key %q: %v", key, err)
 			}
 		}()
 

diff --git a/middleware/limiter/config.go b/middleware/limiter/config.go
@@ -95,15 +95,15 @@ func configDefault(config ...Config) Config {
 
 	// Set default values
 	if int(cfg.Duration.Seconds()) > 0 {
-		log.Printf("[LIMITER] Duration is deprecated, please use Expiration\n")
+		log.Printf("[LIMITER] - [Warning] Duration is deprecated, please use Expiration\n")
 		cfg.Expiration = cfg.Duration
 	}
 	if cfg.Key != nil {
-		log.Printf("[LIMITER] Key is deprecated, please us KeyGenerator\n")
+		log.Printf("[LIMITER] - [Warning] Key is deprecated, please us KeyGenerator\n")
 		cfg.KeyGenerator = cfg.Key
 	}
 	if cfg.Store != nil {
-		log.Printf("[LIMITER] Store is deprecated, please use Storage\n")
+		log.Printf("[LIMITER] - [Warning] Store is deprecated, please use Storage\n")
 		cfg.Storage = cfg.Store
 	}
 	if cfg.Next == nil {

diff --git a/middleware/proxy/proxy.go b/middleware/proxy/proxy.go
@@ -17,7 +17,7 @@ import (
 
 // New is deprecated
 func New(config Config) fiber.Handler {
-	log.Printf("proxy.New is deprecated, please use proxy.Balancer instead\n")
+	log.Printf("[PROXY] - [Warning] proxy.New is deprecated, please use proxy.Balancer instead\n")
 	return Balancer(config)
 }
 

diff --git a/middleware/session/config.go b/middleware/session/config.go
@@ -97,7 +97,7 @@ func configDefault(config ...Config) Config {
 		cfg.Expiration = ConfigDefault.Expiration
 	}
 	if cfg.CookieName != "" {
-		log.Printf("[session] CookieName is deprecated, please use KeyLookup\n")
+		log.Printf("[SESSION] - [Warning] CookieName is deprecated, please use KeyLookup\n")
 		cfg.KeyLookup = fmt.Sprintf("cookie:%s", cfg.CookieName)
 	}
 	if cfg.KeyLookup == "" {

diff --git a/middleware/timeout/timeout.go b/middleware/timeout/timeout.go
@@ -18,7 +18,7 @@ var once sync.Once
 // Find documentation and sample usage on https://docs.gofiber.io/api/middleware/timeout
 func New(handler fiber.Handler, timeout time.Duration) fiber.Handler {
 	once.Do(func() {
-		log.Printf("[Warning] timeout contains data race issues, not ready for production!")
+		log.Printf("[TIMEOUT] - [Warning] timeout contains data race issues, not ready for production!")
 	})
 
 	if timeout <= 0 {
@@ -32,11 +32,11 @@ func New(handler fiber.Handler, timeout time.Duration) fiber.Handler {
 		go func() {
 			defer func() {
 				if err := recover(); err != nil {
-					log.Printf("[Warning] recover error %v", err)
+					log.Printf("[TIMEOUT] - [Warning] recover error %v", err)
 				}
 			}()
 			if err := handler(ctx); err != nil {
-				log.Printf("[Warning] handler error %v", err)
+				log.Printf("[TIMEOUT] - [Warning] handler error %v", err)
 			}
 			ch <- struct{}{}
 		}()