chore: link logger with gin context. (#76)

Co-authored-by: Bo-Yi Wu <[email protected]>

Author: cedric-appdirect

logger.go

@@ -40,6 +40,8 @@ type config struct {
 	pathLevels map[string]zerolog.Level
 }
 
+const loggerKey = "_gin-contrib/logger_"
+
 var isTerm bool = isatty.IsTerminal(os.Stdout.Fd())
 
 // SetLogger initializes the logging middleware.
@@ -88,7 +90,6 @@ func SetLogger(opts ...Option) gin.HandlerFunc {
 			path = path + "?" + raw
 		}
 
-		c.Next()
 		track := true
 
 		if _, ok := skip[path]; ok || (cfg.skip != nil && cfg.skip(c)) {
@@ -106,6 +107,17 @@ func SetLogger(opts ...Option) gin.HandlerFunc {
 			}
 		}
 
+		if track {
+			l = l.With().
+				Str("method", c.Request.Method).
+				Str("path", path).
+				Str("ip", c.ClientIP()).
+				Str("user_agent", c.Request.UserAgent()).Logger()
+		}
+		c.Set(loggerKey, l)
+
+		c.Next()
+
 		if track {
 			end := time.Now()
 			if cfg.utc {
@@ -149,3 +161,8 @@ func SetLogger(opts ...Option) gin.HandlerFunc {
 func ParseLevel(levelStr string) (zerolog.Level, error) {
 	return zerolog.ParseLevel(levelStr)
 }
+
+// Get return the logger associated with a gin context
+func Get(c *gin.Context) zerolog.Logger {
+	return c.MustGet(loggerKey).(zerolog.Logger)
+}

logger_test.go

@@ -70,6 +70,17 @@ func TestLogger(t *testing.T) {
 	assert.Contains(t, buffer.String(), "/example")
 	assert.Contains(t, buffer.String(), "ERR")
 	assert.Contains(t, buffer.String(), "path=/example?a=100")
+
+	buffer.Reset()
+	r.GET("/example-with-additional-log", func(ctx *gin.Context) {
+		l := Get(ctx)
+		l.Info().Msg("additional log")
+	})
+	performRequest(r, "GET", "/example-with-additional-log")
+	assert.Contains(t, buffer.String(), "200")
+	assert.Contains(t, buffer.String(), "GET")
+	assert.Contains(t, buffer.String(), "/example-with-additional-log")
+	assert.Contains(t, buffer.String(), "additional log")
 }
 
 func TestLoggerWithLogger(t *testing.T) {