update changelog

Reviewed-on: #1

CHANGELOG.md

@@ -0,0 +1,17 @@
+# v0.11.1:
+* docs: Add comprehensive package-level documentation for the `http` package.
+* docs: Improve documentation for the `InitHTTPServer` function.
+* feat: Introduce specific logging for HTTP 204 (No Content) responses, omitting body logging.
+* fix: Enhance error handling and logging for empty or unreadable HTTP response bodies.
+* chore: Refine HTTP response log messages for improved clarity and consistency.
+* docs: Update documentation for the `Flush` method in `LoggingResponseWriter`
+
+# v0.11.0:
+*   Updated `github.com/prometheus/client_golang` dependency to v1.23.0.
+*   Updated `google.golang.org/grpc` dependency to v1.74.2.
+*   Added a `replace` directive for `github.com/prometheus/otlptranslator`.
+*   Renamed `initOTEL` function to `InitOTEL` and added a check to prevent re-initialization.
+*   Improved `dummyHealthCheck` to ensure a positive random duration.
+*   Added comprehensive package, struct, and function comments across `pkg/app`, `pkg/config`, `pkg/logging`, `pkg/otel`, `pkg/srv/grpc`, and `pkg/srv/http` for improved clarity.
+*   Corrected typos in `TODO.md` for "implementing" and "support".
+*   Added a new item to `TODO.md` for early OpenTelemetry initialization.

go.mod

@@ -2,6 +2,8 @@ module gitea.libretechconsulting.com/rmcguire/go-app
 
 go 1.24.2
 
+replace github.com/prometheus/otlptranslator => github.com/prometheus/otlptranslator v0.0.0-20250717125610-8549f4ab4f8f
+
 require (
 	buf.build/go/protovalidate v0.14.0
 	github.com/caarlos0/env/v11 v11.3.1
@@ -27,7 +29,7 @@ require (
 )
 
 require (
-	buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.6-20250717185734-6c6e0d3c608e.1 // indirect
+	buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.7-20250717185734-6c6e0d3c608e.1 // indirect
 	cel.dev/expr v0.24.0 // indirect
 	github.com/antlr4-go/antlr/v4 v4.13.1 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
@@ -51,11 +53,11 @@ require (
 	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.37.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.7.1 // indirect
-	golang.org/x/exp v0.0.0-20250718183923-645b1fa84792 // indirect
-	golang.org/x/net v0.42.0 // indirect
-	golang.org/x/sys v0.34.0 // indirect
-	golang.org/x/text v0.27.0 // indirect
-	google.golang.org/genproto/googleapis/api v0.0.0-20250728155136-f173205681a0 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20250728155136-f173205681a0 // indirect
-	google.golang.org/protobuf v1.36.6 // indirect
+	golang.org/x/exp v0.0.0-20250813145105-42675adae3e6 // indirect
+	golang.org/x/net v0.43.0 // indirect
+	golang.org/x/sys v0.35.0 // indirect
+	golang.org/x/text v0.28.0 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20250811230008-5f3141c8851a // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20250811230008-5f3141c8851a // indirect
+	google.golang.org/protobuf v1.36.7 // indirect
 )

go.sum

@@ -1,5 +1,5 @@
-buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.6-20250717185734-6c6e0d3c608e.1 h1:Lg6klmCi3v7VvpqeeLEER9/m5S8y9e9DjhqQnSCNy4k=
-buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.6-20250717185734-6c6e0d3c608e.1/go.mod h1:avRlCjnFzl98VPaeCtJ24RrV/wwHFzB8sWXhj26+n/U=
+buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.7-20250717185734-6c6e0d3c608e.1 h1:/AZH8sVB6LHv8G+hZlAMCP31NevnesHwYgnlgS5Vt14=
+buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.7-20250717185734-6c6e0d3c608e.1/go.mod h1:eva/VCrd8X7xuJw+JtwCEyrCKiRRASukFqmirnWBvFU=
 buf.build/go/protovalidate v0.14.0 h1:kr/rC/no+DtRyYX+8KXLDxNnI1rINz0imk5K44ZpZ3A=
 buf.build/go/protovalidate v0.14.0/go.mod h1:+F/oISho9MO7gJQNYC2VWLzcO1fTPmaTA08SDYJZncA=
 cel.dev/expr v0.24.0 h1:56OvJKSH3hDGL0ml5uSxZmz3/3Pq4tJ+fb1unVLAFcY=
@@ -135,25 +135,25 @@ go.opentelemetry.io/proto/otlp v1.7.1 h1:gTOMpGDb0WTBOP8JaO72iL3auEZhVmAQg4ipjOV
 go.opentelemetry.io/proto/otlp v1.7.1/go.mod h1:b2rVh6rfI/s2pHWNlB7ILJcRALpcNDzKhACevjI+ZnE=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
 go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
-golang.org/x/exp v0.0.0-20250718183923-645b1fa84792 h1:R9PFI6EUdfVKgwKjZef7QIwGcBKu86OEFpJ9nUEP2l4=
-golang.org/x/exp v0.0.0-20250718183923-645b1fa84792/go.mod h1:A+z0yzpGtvnG90cToK5n2tu8UJVP2XUATh+r+sfOOOc=
-golang.org/x/net v0.42.0 h1:jzkYrhi3YQWD6MLBJcsklgQsoAcw89EcZbJw8Z614hs=
-golang.org/x/net v0.42.0/go.mod h1:FF1RA5d3u7nAYA4z2TkclSCKh68eSXtiFwcWQpPXdt8=
+golang.org/x/exp v0.0.0-20250813145105-42675adae3e6 h1:SbTAbRFnd5kjQXbczszQ0hdk3ctwYf3qBNH9jIsGclE=
+golang.org/x/exp v0.0.0-20250813145105-42675adae3e6/go.mod h1:4QTo5u+SEIbbKW1RacMZq1YEfOBqeXa19JeshGi+zc4=
+golang.org/x/net v0.43.0 h1:lat02VYK2j4aLzMzecihNvTlJNQUq316m2Mr9rnM6YE=
+golang.org/x/net v0.43.0/go.mod h1:vhO1fvI4dGsIjh73sWfUVjj3N7CA9WkKJNQm2svM6Jg=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.34.0 h1:H5Y5sJ2L2JRdyv7ROF1he/lPdvFsd0mJHFw2ThKHxLA=
-golang.org/x/sys v0.34.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
-golang.org/x/text v0.27.0 h1:4fGWRpyh641NLlecmyl4LOe6yDdfaYNrGb2zdfo4JV4=
-golang.org/x/text v0.27.0/go.mod h1:1D28KMCvyooCX9hBiosv5Tz/+YLxj0j7XhWjpSUF7CU=
-google.golang.org/genproto/googleapis/api v0.0.0-20250728155136-f173205681a0 h1:0UOBWO4dC+e51ui0NFKSPbkHHiQ4TmrEfEZMLDyRmY8=
-google.golang.org/genproto/googleapis/api v0.0.0-20250728155136-f173205681a0/go.mod h1:8ytArBbtOy2xfht+y2fqKd5DRDJRUQhqbyEnQ4bDChs=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20250728155136-f173205681a0 h1:MAKi5q709QWfnkkpNQ0M12hYJ1+e8qYVDyowc4U1XZM=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20250728155136-f173205681a0/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A=
+golang.org/x/sys v0.35.0 h1:vz1N37gP5bs89s7He8XuIYXpyY0+QlsKmzipCbUtyxI=
+golang.org/x/sys v0.35.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng=
+golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU=
+google.golang.org/genproto/googleapis/api v0.0.0-20250811230008-5f3141c8851a h1:DMCgtIAIQGZqJXMVzJF4MV8BlWoJh2ZuFiRdAleyr58=
+google.golang.org/genproto/googleapis/api v0.0.0-20250811230008-5f3141c8851a/go.mod h1:y2yVLIE/CSMCPXaHnSKXxu1spLPnglFLegmgdY23uuE=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20250811230008-5f3141c8851a h1:tPE/Kp+x9dMSwUm/uM0JKK0IfdiJkwAbSMSeZBXXJXc=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20250811230008-5f3141c8851a/go.mod h1:gw1tLEfykwDz2ET4a12jcXt4couGAm7IwsVaTy0Sflo=
 google.golang.org/grpc v1.74.2 h1:WoosgB65DlWVC9FqI82dGsZhWFNBSLjQ84bjROOpMu4=
 google.golang.org/grpc v1.74.2/go.mod h1:CtQ+BGjaAIXHs/5YS3i473GqwBBa1zGQNevxdeBEXrM=
-google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9xY=
-google.golang.org/protobuf v1.36.6/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY=
+google.golang.org/protobuf v1.36.7 h1:IgrO7UwFQGJdRNXH/sQux4R1Dj1WAKcLElzeeRaXV2A=
+google.golang.org/protobuf v1.36.7/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=

pkg/srv/grpc/grpc.go

@@ -31,8 +31,9 @@ type appGRPCServer struct {
 	doneChan     chan error
 }
 
-// Returns a shutdown func, a channel indicating done / error,
-// and an up-front error if server fails to start
+// InitGRPCServer initializes and starts a gRPC server.
+// It returns a shutdown function, a channel to signal completion or error,
+// and an error if the server fails to start.
 func InitGRPCServer(ctx context.Context, opts *opts.GRPCOpts) (
 	func(context.Context) error, <-chan error, error,
 ) {

pkg/srv/grpc/logger.go

@@ -8,19 +8,19 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-// A grpc logging middleware compatible logger
+// GRPCLogger is a grpc logging middleware compatible logger
 // implementation using a zerolog logger, either from
-// the global logger or a context logger
+// the global logger or a context logger.
 type GRPCLogger struct {
 	logger zerolog.Logger
 }
 
-// Returns a grpcLogger using the global zerolog Logger
+// NewGRPCLogger returns a grpcLogger using the global zerolog Logger.
 func NewGRPCLogger() *GRPCLogger {
 	return &GRPCLogger{logger: log.Logger}
 }
 
-// Returns a grpcLogger using the zerolog logger in the provided context
+// NewGRPCContextLogger returns a grpcLogger using the zerolog logger in the provided context.
 func NewGRPCContextLogger(ctx context.Context) *GRPCLogger {
 	logger := log.Ctx(ctx)
 	return &GRPCLogger{logger: *logger}

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

@@ -3,7 +3,8 @@ package http
 import (
 	"bytes"
 	"context"
-	"errors"
+	"fmt"
+	"io"
 	"net/http"
 	"regexp"
 	"time"
@@ -41,29 +42,42 @@ 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)
+			trcLog.Msg("http response (no content)") // Explicitly log 204
+			return                                   // No body to log for 204 No Content
+		}
+
 		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()
-			return
+			if err == io.EOF {
+				// Body is empty, which might be valid for some non-204 responses.
+				trcLog.Msg("http response (empty body)")
+			} else {
+				// Other error reading the body. Wrap the original error for context.
+				trcLog.Err(fmt.Errorf("error reading response body: %w", err)).Send()
 			}
-		lrr.body.UnreadByte()
+			return // No further body processing if there was an error or it was empty
+		}
+		lrr.body.UnreadByte() // Put the byte back for Bytes() to read
 
 		if firstByte == '{' {
 			trcLog = trcLog.RawJSON("response", lrr.body.Bytes())
 		} 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()