Add logging middleware

TODO.md

@@ -0,0 +1,4 @@
+# TODO
+
+- [ ] Unit tests
+- [ ] HTTP Logging Middleware

go.mod

@@ -3,7 +3,7 @@ module gitea.libretechconsulting.com/rmcguire/go-app
 go 1.23.4
 
 require (
-	github.com/caarlos0/env/v9 v9.0.0
+	github.com/caarlos0/env/v11 v11.3.1
 	github.com/prometheus/client_golang v1.20.5
 	github.com/rs/zerolog v1.33.0
 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.58.0
@@ -28,10 +28,10 @@ require (
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/google/uuid v1.6.0 // indirect
-	github.com/grpc-ecosystem/grpc-gateway/v2 v2.24.0 // indirect
+	github.com/grpc-ecosystem/grpc-gateway/v2 v2.25.1 // indirect
-	github.com/klauspost/compress v1.17.9 // indirect
+	github.com/klauspost/compress v1.17.11 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
-	github.com/mattn/go-isatty v0.0.19 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
 	github.com/prometheus/common v0.61.0 // indirect
@@ -39,11 +39,11 @@ require (
 	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.33.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.4.0 // indirect
-	golang.org/x/net v0.32.0 // indirect
+	golang.org/x/net v0.33.0 // indirect
-	golang.org/x/sys v0.28.0 // indirect
+	golang.org/x/sys v0.29.0 // indirect
 	golang.org/x/text v0.21.0 // indirect
-	google.golang.org/genproto/googleapis/api v0.0.0-20241209162323-e6fa225c2576 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20250102185135-69823020774d // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20241209162323-e6fa225c2576 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20250102185135-69823020774d // indirect
-	google.golang.org/grpc v1.68.1 // indirect
+	google.golang.org/grpc v1.69.2 // indirect
-	google.golang.org/protobuf v1.35.2 // indirect
+	google.golang.org/protobuf v1.36.1 // indirect
 )

go.sum

@@ -1,7 +1,7 @@
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
-github.com/caarlos0/env/v9 v9.0.0 h1:SI6JNsOA+y5gj9njpgybykATIylrRMklbs5ch6wO6pc=
+github.com/caarlos0/env/v11 v11.3.1 h1:cArPWC15hWmEt+gWk7YBi7lEXTXCvpaSdCiZE2X5mCA=
-github.com/caarlos0/env/v9 v9.0.0/go.mod h1:ye5mlCVMYh6tZ+vCgrs/B95sj88cg5Tlnc0XIzgZ020=
+github.com/caarlos0/env/v11 v11.3.1/go.mod h1:qupehSf/Y0TUTsxKywqRt/vJjN5nz6vauiYEUUr8P4U=
 github.com/cenkalti/backoff/v4 v4.3.0 h1:MyRJ/UdXutAwSAT+s3wNd7MfTIcy71VQueUuFK343L8=
 github.com/cenkalti/backoff/v4 v4.3.0/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE=
 github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
@@ -23,10 +23,10 @@ github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/grpc-ecosystem/grpc-gateway/v2 v2.24.0 h1:TmHmbvxPmaegwhDubVz0lICL0J5Ka2vwTzhoePEXsGE=
+github.com/grpc-ecosystem/grpc-gateway/v2 v2.25.1 h1:VNqngBF40hVlDloBruUehVYC3ArSgIyScOAyMRqBxRg=
-github.com/grpc-ecosystem/grpc-gateway/v2 v2.24.0/go.mod h1:qztMSjm835F2bXf+5HKAPIS5qsmQDqZna/PgVt4rWtI=
+github.com/grpc-ecosystem/grpc-gateway/v2 v2.25.1/go.mod h1:RBRO7fro65R6tjKzYgLAFo0t1QEXY1Dp+i/bvpRiqiQ=
-github.com/klauspost/compress v1.17.9 h1:6KIumPrER1LHsvBVuDa0r5xaG0Es51mhhB9BQB2qeMA=
+github.com/klauspost/compress v1.17.11 h1:In6xLpyWOi1+C7tXUUWv2ot1QvBjxevKAaI6IXrJmUc=
-github.com/klauspost/compress v1.17.9/go.mod h1:Di0epgTjJY877eYKx5yC51cX2A2Vl2ibi7bDH9ttBbw=
+github.com/klauspost/compress v1.17.11/go.mod h1:pMDklpSncoRMuLFrf1W9Ss9KT+0rH90U12bZKk7uwG0=
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
 github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
@@ -36,8 +36,9 @@ github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+
 github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
 github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
-github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
 github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
@@ -88,23 +89,23 @@ go.opentelemetry.io/proto/otlp v1.4.0 h1:TA9WRvW6zMwP+Ssb6fLoUIuirti1gGbP28GcKG1
 go.opentelemetry.io/proto/otlp v1.4.0/go.mod h1:PPBWZIP98o2ElSqI35IHfu7hIhSwvc5N38Jw8pXuGFY=
 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/net v0.32.0 h1:ZqPmj8Kzc+Y6e0+skZsuACbx+wzMgo5MQsJh9Qd6aYI=
+golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I=
-golang.org/x/net v0.32.0/go.mod h1:CwU0IoeOlnQQWJ6ioyFrfRuomB8GKF6KbYXZVyeXNfs=
+golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
 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.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
+golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
-golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
 golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
-google.golang.org/genproto/googleapis/api v0.0.0-20241209162323-e6fa225c2576 h1:CkkIfIt50+lT6NHAVoRYEyAvQGFM7xEwXUUywFvEb3Q=
+google.golang.org/genproto/googleapis/api v0.0.0-20250102185135-69823020774d h1:H8tOf8XM88HvKqLTxe755haY6r1fqqzLbEnfrmLXlSA=
-google.golang.org/genproto/googleapis/api v0.0.0-20241209162323-e6fa225c2576/go.mod h1:1R3kvZ1dtP3+4p4d3G8uJ8rFk/fWlScl38vanWACI08=
+google.golang.org/genproto/googleapis/api v0.0.0-20250102185135-69823020774d/go.mod h1:2v7Z7gP2ZUOGsaFyxATQSRoBnKygqVq2Cwnvom7QiqY=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20241209162323-e6fa225c2576 h1:8ZmaLZE4XWrtU3MyClkYqqtl6Oegr3235h7jxsDyqCY=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20250102185135-69823020774d h1:xJJRGY7TJcvIlpSrN3K6LAWgNFUILlO+OMAqtg9aqnw=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20241209162323-e6fa225c2576/go.mod h1:5uTbfoYQed2U9p3KIj2/Zzm02PYhndfdmML0qC3q3FU=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20250102185135-69823020774d/go.mod h1:3ENsm/5D1mzDyhpzeRi1NR784I0BcofWBoSc5QqqMK4=
-google.golang.org/grpc v1.68.1 h1:oI5oTa11+ng8r8XMMN7jAOmWfPZWbYpCFaMUTACxkM0=
+google.golang.org/grpc v1.69.2 h1:U3S9QEtbXC0bYNvRtcoklF3xGtLViumSYxWykJS+7AU=
-google.golang.org/grpc v1.68.1/go.mod h1:+q1XYFJjShcqn0QZHvCyeR4CXPA+llXIeUIfIe00waw=
+google.golang.org/grpc v1.69.2/go.mod h1:vyjdE6jLBI76dgpDojsFGNaHlxdjXN9ghpnd2o7JGZ4=
-google.golang.org/protobuf v1.35.2 h1:8Ar7bF+apOIoThw1EdZl0p1oWvMqTHmpA2fRTyZO8io=
+google.golang.org/protobuf v1.36.1 h1:yBPeRvTftaleIgM3PZ/WBIZ7XM/eEYAaEyCwvyjq/gk=
-google.golang.org/protobuf v1.35.2/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
+google.golang.org/protobuf v1.36.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
 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/config/config.go

@@ -2,12 +2,14 @@ package config
 
 import (
 	"context"
+	"errors"
 	"flag"
 	"fmt"
 	"os"
 	"runtime/debug"
+	"time"
 
-	"github.com/caarlos0/env/v9"
+	"github.com/caarlos0/env/v11"
 	"gopkg.in/yaml.v3"
 )
 
@@ -39,7 +41,7 @@ func LoadConfig(ctx context.Context) (context.Context, error) {
 }
 
 func loadConfig(configPath string) (*AppConfig, error) {
-	cfg := newAppConfig()
+	cfg := *DefaultConfig
 
 	if configPath != "" {
 		file, err := os.Open(configPath)
@@ -49,16 +51,59 @@ func loadConfig(configPath string) (*AppConfig, error) {
 		defer file.Close()
 
 		decoder := yaml.NewDecoder(file)
-		if err := decoder.Decode(cfg); err != nil {
+		if err := decoder.Decode(&cfg); err != nil {
 			return nil, fmt.Errorf("could not decode config file: %w", err)
 		}
 	}
 
-	if err := env.Parse(cfg); err != nil {
+	if err := env.Parse(&cfg); err != nil {
 		return nil, fmt.Errorf("could not parse environment variables: %w", err)
 	}
 
-	return cfg, nil
+	// Perform updates / enrichments
+	err := prepareConfig(&cfg)
+	if err != nil {
+		return nil, err
+	}
+
+	return &cfg, nil
+}
+
+func prepareConfig(cfg *AppConfig) error {
+	var errs error
+
+	// Set timeouts
+	if cfg.HTTP.ReadTimeout != "" {
+		if rT, err := time.ParseDuration(cfg.HTTP.ReadTimeout); err == nil {
+			cfg.HTTP.rT = &rT
+		} else {
+			errs = errors.Join(errs, err)
+		}
+	}
+
+	if cfg.HTTP.ReadTimeout != "" {
+		if wT, err := time.ParseDuration(cfg.HTTP.WriteTimeout); err == nil {
+			cfg.HTTP.wT = &wT
+		} else {
+			errs = errors.Join(errs, err)
+		}
+	}
+
+	if cfg.HTTP.IdleTimeout != "" {
+		if iT, err := time.ParseDuration(cfg.HTTP.IdleTimeout); err == nil {
+			cfg.HTTP.iT = &iT
+		} else {
+			errs = errors.Join(errs, err)
+		}
+	}
+
+	return errs
+}
+
+// Returns read timeout, write timeout, and idle timeout, in that order
+// nil if unset
+func (h *HTTPConfig) Timeouts() (*time.Duration, *time.Duration, *time.Duration) {
+	return h.rT, h.wT, h.iT
 }
 
 func getVersion() string {

pkg/config/types.go

@@ -1,33 +1,53 @@
 package config
 
-func newAppConfig() *AppConfig {
+import "time"
-	return &AppConfig{
+
-		Version: getVersion(),
+// Default Settings
-		Logging: &LogConfig{},
+var DefaultConfig = &AppConfig{
-		HTTP:    &HTTPConfig{},
+	Environment: "development",
-		OTEL:    &OTELConfig{},
+	Version:     getVersion(),
-	}
+	Logging: &LogConfig{
+		Enabled:    true,
+		Level:      "info",
+		Format:     LogFormatJSON,
+		Output:     "stderr",
+		TimeFormat: TimeFormatLong,
+	},
+	HTTP: &HTTPConfig{
+		Listen:       "127.0.0.1:8080",
+		LogRequests:  false,
+		ReadTimeout:  "10s",
+		WriteTimeout: "10s",
+		IdleTimeout:  "1m",
+	},
+	OTEL: &OTELConfig{
+		Enabled:            true,
+		PrometheusEnabled:  true,
+		PrometheusPath:     "/metrics",
+		StdoutEnabled:      false,
+		MetricIntervalSecs: 30,
+	},
 }
 
 type AppConfig struct {
-	Name        string `yaml:"name" env:"APP_NAME" envDefault:"go-http-server-with-otel"`
+	Name        string `yaml:"name,omitempty" env:"APP_NAME"`
-	Environment string `yaml:"environment" env:"APP_ENVIRONMENT" envDefault:"development"`
+	Environment string `yaml:"environment,omitempty" env:"APP_ENVIRONMENT"`
 	// This should either be set by ldflags, such as with
 	// go build -ldflags "-X gitea.libretechconsulting.com/rmcguire/go-app/pkg/config.Version=$(VERSION)"
 	// or allow this to use build meta. Will default to (devel)
-	Version string      `yaml:"version" env:"APP_VERSION"`
+	Version string      `yaml:"version,omitempty" env:"APP_VERSION"`
-	Logging *LogConfig  `yaml:"logging"`
+	Logging *LogConfig  `yaml:"logging,omitempty"`
-	HTTP    *HTTPConfig `yaml:"http"`
+	HTTP    *HTTPConfig `yaml:"http,omitempty"`
-	OTEL    *OTELConfig `yaml:"otel"`
+	OTEL    *OTELConfig `yaml:"otel,omitempty"`
 }
 
 // Logging Configuration
 type LogConfig struct {
-	Enabled    bool       `yaml:"enabled" env:"APP_LOG_ENABLED" envDefault:"true"`
+	Enabled    bool       `yaml:"enabled,omitempty" env:"APP_LOG_ENABLED"`
-	Level      string     `yaml:"level" env:"APP_LOG_LEVEL" envDefault:"info"`
+	Level      string     `yaml:"level,omitempty" env:"APP_LOG_LEVEL"`
-	Format     LogFormat  `yaml:"format" env:"APP_LOG_FORMAT" envDefault:"json"`
+	Format     LogFormat  `yaml:"format,omitempty" env:"APP_LOG_FORMAT"`
-	Output     LogOutput  `yaml:"output" env:"APP_LOG_OUTPUT" envDefault:"stderr"`
+	Output     LogOutput  `yaml:"output,omitempty" env:"APP_LOG_OUTPUT"`
-	TimeFormat TimeFormat `yaml:"timeFormat" env:"APP_LOG_TIME_FORMAT" envDefault:"short"`
+	TimeFormat TimeFormat `yaml:"timeFormat,omitempty" env:"APP_LOG_TIME_FORMAT"`
 }
 
 type LogFormat string
@@ -56,15 +76,21 @@ const (
 
 // HTTP Configuration
 type HTTPConfig struct {
-	Listen         string `yaml:"listen" env:"APP_HTTP_LISTEN" envDefault:"127.0.0.1:8080"`
+	Listen       string `yaml:"listen,omitempty" env:"APP_HTTP_LISTEN"`
-	RequestTimeout int    `yaml:"requestTimeout" env:"APP_HTTP_REQUEST_TIMEOUT" envDefault:"30"`
+	LogRequests  bool   `yaml:"logRequests" env:"APP_HTTP_LOG_REQUESTS"`
+	ReadTimeout  string `yaml:"readTimeout" env:"APP_HTTP_READ_TIMEOUT"`   // Go duration (e.g. 10s)
+	WriteTimeout string `yaml:"writeTimeout" env:"APP_HTTP_WRITE_TIMEOUT"` // Go duration (e.g. 10s)
+	IdleTimeout  string `yaml:"idleTimeout" env:"APP_HTTP_IDLE_TIMEOUT"`   // Go duration (e.g. 10s)
+	rT           *time.Duration
+	wT           *time.Duration
+	iT           *time.Duration
 }
 
 // OTEL Configuration
 type OTELConfig struct {
-	Enabled            bool   `yaml:"enabled" env:"APP_OTEL_ENABLED" envDefault:"true"`
+	Enabled            bool   `yaml:"enabled,omitempty" env:"APP_OTEL_ENABLED"`
-	PrometheusEnabled  bool   `yaml:"prometheusEnabled" env:"APP_OTEL_PROMETHEUS_ENABLED" envDefault:"true"`
+	PrometheusEnabled  bool   `yaml:"prometheusEnabled,omitempty" env:"APP_OTEL_PROMETHEUS_ENABLED"`
-	PrometheusPath     string `yaml:"prometheusPath" env:"APP_OTEL_PROMETHEUS_PATH" envDefault:"/metrics"`
+	PrometheusPath     string `yaml:"prometheusPath,omitempty" env:"APP_OTEL_PROMETHEUS_PATH"`
-	StdoutEnabled      bool   `yaml:"stdoutEnabled" env:"APP_OTEL_STDOUT_ENABLED" envDefault:"false"`
+	StdoutEnabled      bool   `yaml:"stdoutEnabled,omitempty" env:"APP_OTEL_STDOUT_ENABLED"`
-	MetricIntervalSecs int    `yaml:"metricIntervalSecs" env:"APP_OTEL_METRIC_INTERVAL_SECS" envDefault:"15"`
+	MetricIntervalSecs int    `yaml:"metricIntervalSecs,omitempty" env:"APP_OTEL_METRIC_INTERVAL_SECS"`
 }

pkg/otel/util.go

@@ -2,6 +2,7 @@ package otel
 
 import (
 	"context"
+	"os"
 	"strings"
 
 	"go.opentelemetry.io/otel"
@@ -22,8 +23,13 @@ func GetMeter(ctx context.Context, components ...string) metric.Meter {
 func getName(ctx context.Context, components ...string) string {
 	cfg := config.MustFromCtx(ctx)
 
+	serviceName := cfg.Name
+	if otelEnvName := os.Getenv("OTEL_SERVICE_NAME"); otelEnvName != "" {
+		serviceName = otelEnvName
+	}
+
 	path := make([]string, 0, len(components)+1)
-	path = append(path, cfg.Name)
+	path = append(path, serviceName)
 	path = append(path, components...)
 
 	return strings.Join(path, ".")

pkg/srv/http.go

@@ -17,11 +17,11 @@ import (
 )
 
 var (
-	httpMeter    metric.Meter
+	httpMeter       metric.Meter
-	httpTracer   trace.Tracer
+	httpTracer      trace.Tracer
-	readTimeout  = 10 * time.Second
+	defReadTimeout  = 10 * time.Second
-	writeTimeout = 10 * time.Second
+	defWriteTimeout = 10 * time.Second
-	idleTimeout  = 15 * time.Second
+	defIdleTimeout  = 15 * time.Second
 )
 
 type HTTPFunc struct {
@@ -72,6 +72,28 @@ func prepHTTPServer(ctx context.Context, handleFuncs []HTTPFunc, hcFuncs ...Heal
 			}
 		}))
 
+	// Set timeouts from defaults, override
+	// with config timeouts if set
+	readTimeout := defReadTimeout
+	writeTimeout := defWriteTimeout
+	idleTimeout := defIdleTimeout
+
+	rT, wT, iT := cfg.HTTP.Timeouts()
+	if rT != nil {
+		readTimeout = *rT
+	}
+	if wT != nil {
+		writeTimeout = *wT
+	}
+	if iT != nil {
+		idleTimeout = *iT
+	}
+
+	// Inject logging middleware
+	if cfg.HTTP.LogRequests {
+		handler = loggingMiddleware(ctx, handler)
+	}
+
 	return &http.Server{
 		Addr:         cfg.HTTP.Listen,
 		ReadTimeout:  readTimeout,

pkg/srv/http_log.go

@@ -0,0 +1,87 @@
+package srv
+
+import (
+	"bytes"
+	"context"
+	"errors"
+	"net/http"
+	"regexp"
+	"time"
+
+	"github.com/rs/zerolog"
+)
+
+var ExcludeFromLogging = regexp.MustCompile(`\/(ready|live|metrics)$`)
+
+type LoggingResponseWriter struct {
+	http.ResponseWriter
+	statusCode int
+	body       *bytes.Buffer
+}
+
+func loggingMiddleware(appCtx context.Context, next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if ExcludeFromLogging.Match([]byte(r.URL.Path)) {
+			next.ServeHTTP(w, r)
+			return
+		}
+
+		log := zerolog.Ctx(appCtx)
+
+		start := time.Now()
+		lrr := newLoggingResponseWriter(w)
+		next.ServeHTTP(lrr, r)
+
+		log.Debug().
+			Str("path", r.URL.Path).
+			Any("query", r.URL.Query()).
+			Int("statusCode", lrr.statusCode).
+			Str("protocol", r.Proto).
+			Str("remote", r.RemoteAddr).
+			Dur("duration", time.Since(start)).
+			Msg("http request served")
+
+		// Log response body
+		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
+		}
+		lrr.body.UnreadByte()
+
+		if firstByte == '{' {
+			trcLog = trcLog.RawJSON("response", lrr.body.Bytes())
+		} else {
+			trcLog = trcLog.Bytes("response", lrr.body.Bytes())
+		}
+		trcLog.Msg("response payload")
+	})
+}
+
+// Implement Flush to support the http.Flusher interface
+func (w *LoggingResponseWriter) Flush() {
+	if flusher, ok := w.ResponseWriter.(http.Flusher); ok {
+		flusher.Flush()
+	}
+}
+
+func (w *LoggingResponseWriter) WriteHeader(code int) {
+	w.statusCode = code
+	w.ResponseWriter.WriteHeader(code)
+}
+
+func (w *LoggingResponseWriter) Write(b []byte) (int, error) {
+	w.body.Write(b)
+	return w.ResponseWriter.Write(b)
+}
+
+func newLoggingResponseWriter(w http.ResponseWriter) *LoggingResponseWriter {
+	return &LoggingResponseWriter{
+		ResponseWriter: w, statusCode: http.StatusOK, body: bytes.NewBuffer(nil),
+	}
+}