refactors HTTP server initialization, improves logging middleware, and updates documentation

pkg/srv/http/http.go

@@ -1,3 +1,6 @@
+// Package http provides functionality for setting up and managing HTTP servers.
+// It includes features for health checks, Prometheus metrics, OpenTelemetry
+// tracing, and custom middleware integration.
 package http
 
 import (
@@ -133,8 +136,8 @@ func prepHTTPServer(opts *opts.AppHTTP) *http.Server {
 	}
 }
 
-// Returns a shutdown func and a done channel if the
-// server aborts abnormally. Returns error on failure to start
+// InitHTTPServer returns a shutdown func and a done channel if the
+// server aborts abnormally. Returns error on failure to start.
 func InitHTTPServer(opts *opts.AppHTTP) (
 	func(context.Context) error, <-chan any, error,
 ) {

pkg/srv/http/http_log.go

@@ -41,12 +41,11 @@ func loggingMiddleware(appCtx context.Context, next http.Handler) http.Handler {
 			Dur("duration", time.Since(start)).
 			Msg("http request served")
 
-		// Log response body
+		// Log response with body if not 204
+		if lrr.statusCode != http.StatusNoContent {
 			trcLog := log.Trace().
 				Str("path", r.URL.Path).
 				Int("statusCode", lrr.statusCode)
-
-		// Check if it's JSON
 			firstByte, err := lrr.body.ReadByte()
 			if err != nil {
 				trcLog.Err(errors.New("invalid response body")).Send()
@@ -59,11 +58,12 @@ func loggingMiddleware(appCtx context.Context, next http.Handler) http.Handler {
 			} else {
 				trcLog = trcLog.Bytes("response", lrr.body.Bytes())
 			}
-		trcLog.Msg("response payload")
+			trcLog.Msg("http response")
+		}
 	})
 }
 
-// Implement Flush to support the http.Flusher interface
+// Flush implements the http.Flusher interface to allow flushing buffered data.
 func (w *LoggingResponseWriter) Flush() {
 	if flusher, ok := w.ResponseWriter.(http.Flusher); ok {
 		flusher.Flush()