changes from review changes

Author: aldas

middleware/request_logger.go

@@ -89,13 +89,14 @@ type RequestLoggerConfig struct {
 	LogURIPath bool
 	// LogRoutePath instructs logger to extract route path part to which request was matched to (i.e. `/user/:id`)
 	LogRoutePath bool
-	// LogID instructs logger to extract request ID from request `X-Request-ID` header or response if request did not have value.
-	LogID bool
-	// LogID instructs logger to extract request referer values.
+	// LogRequestID instructs logger to extract request ID from request `X-Request-ID` header or response if request did not have value.
+	LogRequestID bool
+	// LogReferer instructs logger to extract request referer values.
 	LogReferer bool
 	// LogUserAgent instructs logger to extract request user agent values.
 	LogUserAgent bool
-	// LogStatus instructs logger to extract response status code. Then handler returns an echo.HTTPError then code from there.
+	// LogStatus instructs logger to extract response status code. If handler chain returns an echo.HTTPError,
+	// the status code is extracted from the echo.HTTPError returned
 	LogStatus bool
 	// LogError instructs logger to extract error returned from executed handler chain.
 	LogError bool
@@ -107,12 +108,12 @@ type RequestLoggerConfig struct {
 	LogResponseSize bool
 	// LogHeaders instructs logger to extract given list of headers from request. Note: request can contain more than
 	// one header with same value so slice of values is been logger for each given header.
-	LogHeaders []string
-	// LogQueryParams instructs logger to extract given list of query parameters from request URI. Note: request can
-	// contain more than one query parameter with same name so slice of values is been logger for each given query param name.
 	//
 	// Note: header values are converted to canonical form with http.CanonicalHeaderKey as this how request parser converts header
 	// names to. For example, the canonical key for "accept-encoding" is "Accept-Encoding".
+	LogHeaders []string
+	// LogQueryParams instructs logger to extract given list of query parameters from request URI. Note: request can
+	// contain more than one query parameter with same name so slice of values is been logger for each given query param name.
 	LogQueryParams []string
 	// LogFormValues instructs logger to extract given list of form values from request body+URI. Note: request can
 	// contain more than one form value with same name so slice of values is been logger for each given form value name.
@@ -139,8 +140,8 @@ type RequestLoggerValues struct {
 	URIPath string
 	// RoutePath is route path part to which request was matched to (i.e. `/user/:id`)
 	RoutePath string
-	// ID is request ID from request `X-Request-ID` header or response if request did not have value.
-	ID string
+	// RequestID is request ID from request `X-Request-ID` header or response if request did not have value.
+	RequestID string
 	// Referer is request referer values.
 	Referer string
 	// UserAgent is request user agent values.
@@ -243,12 +244,12 @@ func (config RequestLoggerConfig) ToMiddleware() (echo.MiddlewareFunc, error) {
 			if config.LogRoutePath {
 				v.RoutePath = c.Path()
 			}
-			if config.LogID {
+			if config.LogRequestID {
 				id := req.Header.Get(echo.HeaderXRequestID)
 				if id == "" {
 					id = res.Header().Get(echo.HeaderXRequestID)
 				}
-				v.ID = id
+				v.RequestID = id
 			}
 			if config.LogReferer {
 				v.Referer = req.Referer()

middleware/request_logger_test.go

@@ -180,7 +180,7 @@ func TestRequestLogger_ID(t *testing.T) {
 
 			var expect RequestLoggerValues
 			e.Use(RequestLoggerWithConfig(RequestLoggerConfig{
-				LogID: true,
+				LogRequestID: true,
 				LogValuesFunc: func(c echo.Context, values RequestLoggerValues) error {
 					expect = values
 					return nil
@@ -201,7 +201,7 @@ func TestRequestLogger_ID(t *testing.T) {
 			e.ServeHTTP(rec, req)
 
 			assert.Equal(t, http.StatusTeapot, rec.Code)
-			assert.Equal(t, tc.expect, expect.ID)
+			assert.Equal(t, tc.expect, expect.RequestID)
 		})
 	}
 }
@@ -253,7 +253,7 @@ func TestRequestLogger_allFields(t *testing.T) {
 		LogURI:           true,
 		LogURIPath:       true,
 		LogRoutePath:     true,
-		LogID:            true,
+		LogRequestID:     true,
 		LogReferer:       true,
 		LogUserAgent:     true,
 		LogStatus:        true,
@@ -303,7 +303,7 @@ func TestRequestLogger_allFields(t *testing.T) {
 	assert.Equal(t, "/test?lang=en&checked=1&checked=2", expect.URI)
 	assert.Equal(t, "/test", expect.URIPath)
 	assert.Equal(t, "/test*", expect.RoutePath)
-	assert.Equal(t, "123", expect.ID)
+	assert.Equal(t, "123", expect.RequestID)
 	assert.Equal(t, "https://echo.labstack.com/", expect.Referer)
 	assert.Equal(t, "curl/7.68.0", expect.UserAgent)
 	assert.Equal(t, 418, expect.Status)
@@ -339,7 +339,7 @@ func BenchmarkRequestLogger_withoutMapFields(b *testing.B) {
 		LogURI:           true,
 		LogURIPath:       true,
 		LogRoutePath:     true,
-		LogID:            true,
+		LogRequestID:     true,
 		LogReferer:       true,
 		LogUserAgent:     true,
 		LogStatus:        true,
@@ -380,7 +380,7 @@ func BenchmarkRequestLogger_withMapFields(b *testing.B) {
 		LogURI:           true,
 		LogURIPath:       true,
 		LogRoutePath:     true,
-		LogID:            true,
+		LogRequestID:     true,
 		LogReferer:       true,
 		LogUserAgent:     true,
 		LogStatus:        true,