logger: allow routes to do not be logged by RequestLogger middleware (#4

)
blacklane · Jun 11, 2020 · c655b4f · c655b4f
1 parent 2091dc7
commit c655b4f
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 3 deletions.
diff --git a/logger/middleware/http.go b/logger/middleware/http.go
@@ -22,7 +22,7 @@ func Logger(log logger.Logger) func(http.Handler) http.Handler {
 	}
 }
 
-func RequestLogger() func(http.Handler) http.Handler {
+func RequestLogger(skipRoutes []string) func(http.Handler) http.Handler {
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			startTime := logger.Now()
@@ -51,6 +51,12 @@ func RequestLogger() func(http.Handler) http.Handler {
 			ww := responseWriter{w: w, body: &bytes.Buffer{}}
 
 			defer func() {
+				for _, skipRoute := range skipRoutes {
+					if strings.HasPrefix(urlPath, skipRoute) {
+						// do not log this route
+						return
+					}
+				}
 				l.Info().
 					Str(internal.FieldEvent, internal.EventRequestFinished).
 					Int(internal.FieldStatus, ww.statusCode).

diff --git a/logger/middleware/http_example_test.go b/logger/middleware/http_example_test.go
@@ -52,7 +52,7 @@ func ExampleNewHttpHandlerLogger_simple() {
 	log := logger.New(os.Stdout, "")
 	ctx := log.WithContext(r.Context())
 
-	loggerMiddleware := RequestLogger()
+	loggerMiddleware := RequestLogger([]string{})
 
 	h := loggerMiddleware(
 		http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@@ -82,7 +82,7 @@ func ExampleNewHttpHandlerLogger_complete() {
 	ctx = log.WithContext(ctx)
 
 	rr := r.WithContext(ctx)
-	loggerMiddleware := RequestLogger()
+	loggerMiddleware := RequestLogger([]string{})
 
 	h := loggerMiddleware(http.HandlerFunc(
 		func(w http.ResponseWriter, req *http.Request) { _, _ = w.Write(nil) }))
@@ -92,3 +92,34 @@ func ExampleNewHttpHandlerLogger_complete() {
 	// Output:
 	// {"level":"info","application":"","entry_point":true,"host":"example.com","ip":"42.42.42.42","params":"bar=foo","path":"/foo","request_depth":0,"request_id":"42","route":"","tree_path":"","user_agent":"","verb":"GET","event":"request_finished","status":200,"request_duration":1000,"timestamp":"2009-11-10T23:00:02Z","message":"GET /foo"}
 }
+
+func ExampleNewHttpHandlerLogger_skipRoutes() {
+	livePath := "/live"
+	// Set current time function so we can control the request duration
+	logger.SetNowFunc(func() time.Time {
+		return time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC)
+	})
+
+	w := httptest.NewRecorder()
+	rBar := httptest.NewRequest(http.MethodGet, "http://example.com/foo?bar=foo", nil)
+	rBar.Header.Set(internal.HeaderForwardedFor, "localhost")
+
+	rLive := httptest.NewRequest(http.MethodGet, "http://example.com"+livePath, nil)
+	rLive.Header.Set(internal.HeaderForwardedFor, "localhost")
+
+	log := logger.New(os.Stdout, "")
+	ctx := log.WithContext(rBar.Context())
+
+	loggerMiddleware := RequestLogger([]string{livePath})
+
+	h := loggerMiddleware(
+		http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			_, _ = fmt.Fprint(w, "Hello, world")
+		}))
+
+	h.ServeHTTP(w, rBar.WithContext(ctx))
+	h.ServeHTTP(w, rLive.WithContext(ctx))
+
+	// Output:
+	// {"level":"info","application":"","entry_point":true,"host":"example.com","ip":"localhost","params":"bar=foo","path":"/foo","request_depth":0,"request_id":"","route":"","tree_path":"","user_agent":"","verb":"GET","event":"request_finished","status":200,"request_duration":0,"timestamp":"2009-11-10T23:00:00Z","message":"GET /foo"}
+}