Merge pull request #1 from lauren-rmtech/feature/add-user-agent

Add user agent to zlog

Author: richjyoung

zlog/zlog.go

@@ -39,14 +39,18 @@ func Logger(lvl zerolog.Level) gin.HandlerFunc {
 		c.Header("X-Request-ID", requestID)
 
 		// Create a sublogger at the specified level to carry through the request chain
-		logger := log.With().Str("id", requestID).Logger().Level(lvl)
+		logger := log.With().
+			Str("id", requestID).
+			Str("agent", c.GetHeader("User-Agent")).
+			Str("path", c.Request.URL.Path).
+			Logger().
+			Level(lvl)
 		setLogger(c, &logger)
 
 		// Log request start
 		logger.WithLevel(globalRequestLevel).
 			Str("method", c.Request.Method).
 			Str("origin", c.GetHeader("Origin")).
-			Str("path", c.Request.URL.Path).
 			Str("ip", c.ClientIP()).
 			Msg(fmt.Sprintf("REQ %s %s %s", c.Request.Method, c.Request.URL.Path, c.ClientIP()))
 
@@ -59,7 +63,6 @@ func Logger(lvl zerolog.Level) gin.HandlerFunc {
 		// Log response
 		GetLogger(c).WithLevel(globalResponseLevel).
 			Str("method", c.Request.Method).
-			Str("request", c.Request.URL.Path).
 			Str("ip", c.ClientIP()).
 			Int("response", c.Writer.Status()).
 			Int("bytes", c.Writer.Size()).

zlog/zlog_test.go

@@ -41,8 +41,10 @@ func TestLogRequest(t *testing.T) {
 	assert.Equal(t, 3, len(lines))
 	assert.Contains(t, lines[0], "TRC REQ GET /")
 	assert.Contains(t, lines[0], id)
+	assert.Contains(t, lines[0], "path=/")
 	assert.Contains(t, lines[1], "DBG RES GET /")
 	assert.Contains(t, lines[1], id)
+	assert.Contains(t, lines[0], "path=/")
 }
 
 func TestLogExtra(t *testing.T) {
@@ -72,6 +74,7 @@ func TestLogExtra(t *testing.T) {
 	assert.Equal(t, 2, len(lines))
 	assert.Contains(t, lines[0], "WRN TEST")
 	assert.Contains(t, lines[0], id)
+	assert.Contains(t, lines[0], "path=/")
 }
 
 func TestLogChangeRequestLevel(t *testing.T) {
@@ -104,3 +107,41 @@ func TestLogChangeRequestLevel(t *testing.T) {
 	assert.Contains(t, lines[1], "DBG RES GET /")
 	assert.Contains(t, lines[1], id)
 }
+
+func TestLogAgent(t *testing.T) {
+	gin.SetMode(gin.ReleaseMode)
+	zerolog.SetGlobalLevel(zerolog.TraceLevel)
+
+	buf := &bytes.Buffer{}
+	log.Logger = zerolog.New(buf).With().Timestamp().Logger().
+		Output(zerolog.ConsoleWriter{Out: buf, TimeFormat: time.RFC3339, NoColor: true})
+
+	w := httptest.NewRecorder()
+	e := gin.New()
+
+	e.GET("", Logger(zerolog.TraceLevel), func(ctx *gin.Context) {
+		GetLogger(ctx).Warn().Msg("TEST")
+	})
+
+	req, _ := http.NewRequest("GET", "/", nil)
+	req.Header.Set("Origin", "http://localhost:8080")
+	req.Header.Set("User-Agent", "test-agent")
+	e.ServeHTTP(w, req)
+
+	fmt.Println(buf)
+	lines := strings.Split(buf.String(), "\n")
+	id := w.Header().Get("X-Request-ID")
+
+	assert.NotEmpty(t, id)
+
+	assert.Equal(t, 4, len(lines))
+	assert.Contains(t, lines[0], "TRC REQ GET /")
+	assert.Contains(t, lines[0], id)
+	assert.Contains(t, lines[0], "agent=test-agent")
+	assert.Contains(t, lines[1], "WRN TEST")
+	assert.Contains(t, lines[1], id)
+	assert.Contains(t, lines[1], "agent=test-agent")
+	assert.Contains(t, lines[2], "DBG RES GET /")
+	assert.Contains(t, lines[2], id)
+	assert.Contains(t, lines[2], "agent=test-agent")
+}