Merge branch 'main' of gitea.libretechconsulting.com:rmcguire/go-app

TODO.md

@@ -1,14 +1,15 @@
 # TODO
 
+- [ ] Add ability to initialize OTEL early (before app runs)
 - [ ] Spruce up the README
-- [ ] Create generic interface for implenting a service
+- [ ] Create generic interface for implementing a service
 - [ ] Create config sample not called demo, so it is more easily reused
 - [ ] Expand config test case to cover GRPC config
 - [ ] Expand tracing
 
 ## Done
 
-- [x] Test and troubleshoot GRPC Gateway supprot
+- [x] Test and troubleshoot GRPC Gateway support
 - [x] Finish implementing GRPC service support
 - [x] Unit tests
 - [x] Pattern for extending config

go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/caarlos0/env/v11 v11.3.1
 	github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.1
-	github.com/prometheus/client_golang v1.22.0
+	github.com/prometheus/client_golang v1.23.0
 	github.com/rs/zerolog v1.34.0
 	github.com/swaggest/jsonschema-go v0.3.78
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.62.0
@@ -22,7 +22,7 @@ require (
 	go.opentelemetry.io/otel/sdk v1.37.0
 	go.opentelemetry.io/otel/sdk/metric v1.37.0
 	go.opentelemetry.io/otel/trace v1.37.0
-	google.golang.org/grpc v1.73.0
+	google.golang.org/grpc v1.74.2
 	gopkg.in/yaml.v3 v3.0.1
 )
 
@@ -31,7 +31,7 @@ require (
 	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
-	github.com/cenkalti/backoff/v5 v5.0.2 // indirect
+	github.com/cenkalti/backoff/v5 v5.0.3 // indirect
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/go-logr/logr v1.4.3 // indirect
@@ -50,12 +50,12 @@ require (
 	github.com/swaggest/refl v1.4.0 // indirect
 	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.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-20250721164621-a45f3dfb1074 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20250721164621-a45f3dfb1074 // 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
 )

go.sum

@@ -14,8 +14,8 @@ github.com/bool64/shared v0.1.5 h1:fp3eUhBsrSjNCQPcSdQqZxxh9bBwrYiZ+zOKFkM0/2E=
 github.com/bool64/shared v0.1.5/go.mod h1:081yz68YC9jeFB3+Bbmno2RFWvGKv1lPKkMP6MHJlPs=
 github.com/caarlos0/env/v11 v11.3.1 h1:cArPWC15hWmEt+gWk7YBi7lEXTXCvpaSdCiZE2X5mCA=
 github.com/caarlos0/env/v11 v11.3.1/go.mod h1:qupehSf/Y0TUTsxKywqRt/vJjN5nz6vauiYEUUr8P4U=
-github.com/cenkalti/backoff/v5 v5.0.2 h1:rIfFVxEf1QsI7E1ZHfp/B4DF/6QBAUhmgkxc0H7Zss8=
-github.com/cenkalti/backoff/v5 v5.0.2/go.mod h1:rkhZdG3JZukswDf7f0cwqPNk4K0sa+F97BxZthm/crw=
+github.com/cenkalti/backoff/v5 v5.0.3 h1:ZN+IMa753KfX5hd8vVaMixjnqRZ3y8CuJKRKj1xcsSM=
+github.com/cenkalti/backoff/v5 v5.0.3/go.mod h1:rkhZdG3JZukswDf7f0cwqPNk4K0sa+F97BxZthm/crw=
 github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
 github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
@@ -66,8 +66,8 @@ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8m
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/prometheus/client_golang v1.22.0 h1:rb93p9lokFEsctTys46VnV1kLCDpVZ0a/Y92Vm0Zc6Q=
-github.com/prometheus/client_golang v1.22.0/go.mod h1:R7ljNsLXhuQXYZYtw6GAE9AZg8Y7vEW5scdCXrWRXC0=
+github.com/prometheus/client_golang v1.23.0 h1:ust4zpdl9r4trLY/gSjlm07PuiBq2ynaXXlptpfy8Uc=
+github.com/prometheus/client_golang v1.23.0/go.mod h1:i/o0R9ByOnHX0McrTMTyhYvKE4haaf2mW08I+jGAjEE=
 github.com/prometheus/client_model v0.6.2 h1:oBsgwpGs7iVziMvrGhE53c/GrLUsZdHnqNwqPLxwZyk=
 github.com/prometheus/client_model v0.6.2/go.mod h1:y3m2F6Gdpfy6Ut/GBsUqTWZqCUvMVzSfMLjcu6wAwpE=
 github.com/prometheus/common v0.65.0 h1:QDwzd+G1twt//Kwj/Ww6E9FQq1iVMmODnILtW1t2VzE=
@@ -131,8 +131,8 @@ go.opentelemetry.io/otel/sdk/metric v1.37.0 h1:90lI228XrB9jCMuSdA0673aubgRobVZFh
 go.opentelemetry.io/otel/sdk/metric v1.37.0/go.mod h1:cNen4ZWfiD37l5NhS+Keb5RXVWZWpRE+9WyVCpbo5ps=
 go.opentelemetry.io/otel/trace v1.37.0 h1:HLdcFNbRQBE2imdSEgm/kwqmQj1Or1l/7bW6mxVK7z4=
 go.opentelemetry.io/otel/trace v1.37.0/go.mod h1:TlgrlQ+PtQO5XFerSPUYG0JSgGyryXewPGyayAWSBS0=
-go.opentelemetry.io/proto/otlp v1.7.0 h1:jX1VolD6nHuFzOYso2E73H85i92Mv8JQYk0K9vz09os=
-go.opentelemetry.io/proto/otlp v1.7.0/go.mod h1:fSKjH6YJ7HDlwzltzyMj036AJ3ejJLCgCSHGj4efDDo=
+go.opentelemetry.io/proto/otlp v1.7.1 h1:gTOMpGDb0WTBOP8JaO72iL3auEZhVmAQg4ipjOVAtj4=
+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=
@@ -146,12 +146,12 @@ 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-20250721164621-a45f3dfb1074 h1:mVXdvnmR3S3BQOqHECm9NGMjYiRtEvDYcqAqedTXY6s=
-google.golang.org/genproto/googleapis/api v0.0.0-20250721164621-a45f3dfb1074/go.mod h1:vYFwMYFbmA8vl6Z/krj/h7+U/AqpHknwJX4Uqgfyc7I=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20250721164621-a45f3dfb1074 h1:qJW29YvkiJmXOYMu5Tf8lyrTp3dOS+K4z6IixtLaCf8=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20250721164621-a45f3dfb1074/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A=
-google.golang.org/grpc v1.73.0 h1:VIWSmpI2MegBtTuFt5/JWy2oXxtjJ/e89Z70ImfD2ok=
-google.golang.org/grpc v1.73.0/go.mod h1:50sbHOUqWoCQGI8V2HQLJM0B+LMlIUjNSZmow7EVBQc=
+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=
+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=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

pkg/app/app_types.go

@@ -1,3 +1,5 @@
+// Package app provides methods to configure, run, and stop
+// a go-app.
 package app
 
 import (
@@ -11,6 +13,8 @@ import (
 	httpopts "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/http/opts"
 )
 
+// App is the main application struct, holding its context, configurations,
+// and various services like HTTP and gRPC.
 type App struct {
 	AppContext    context.Context
 	HTTP          *httpopts.AppHTTP

pkg/app/init.go

@@ -62,7 +62,12 @@ func (a *App) initHTTP(ctx context.Context) error {
 	return err
 }
 
-func (a *App) initOTEL() {
+func (a *App) InitOTEL() {
+	if a.tracer != nil {
+		a.l.Debug().Msg("superfluous call of already configured app otel")
+		return
+	}
+
 	var otelShutdown shutdownFunc
 	a.AppContext, otelShutdown = otel.Init(a.AppContext)
 	a.shutdownFuncs = append(a.shutdownFuncs, otelShutdown)

pkg/app/monitor.go

@@ -27,7 +27,7 @@ func (a *App) monitor() {
 	a.appDone <- nil // Notify app
 }
 
-// Typically invoked when AppContext is done
+// Shutdown is typically invoked when AppContext is done
 // or Server has exited. Not intended to be called
 // manually
 func (a *App) Shutdown() {

pkg/app/run.go

@@ -35,7 +35,7 @@ func (a *App) MustRun() {
 
 	// Start OTEL
 	// Registers a NO-OP provider if not enabled
-	a.initOTEL()
+	a.InitOTEL()
 
 	// With OTEL ready, create an init span to track startup
 	ctx, initSpan := a.tracer.Start(a.AppContext, "init")

pkg/app/schema.go

@@ -6,11 +6,11 @@ import (
 	js "github.com/swaggest/jsonschema-go"
 )
 
-// Generates json schema for app's config.AppConfig
-func (app *App) Schema() ([]byte, error) {
+// Schema generates json schema for app's config.AppConfig
+func (a *App) Schema() ([]byte, error) {
 	r := js.Reflector{}
 
-	s, err := r.Reflect(*app.cfg)
+	s, err := r.Reflect(*a.cfg)
 	if err != nil {
 		return nil, err
 	}
@@ -18,7 +18,7 @@ func (app *App) Schema() ([]byte, error) {
 	return json.MarshalIndent(s, "", "  ")
 }
 
-// Generates json schema for custom config
+// CustomSchema generates json schema for custom config
 // which embeds *config.AppConfig into it
 // Panics if no *config.AppConfig is embedded into custom
 // config type

pkg/app/setup.go

@@ -9,7 +9,7 @@ import (
 	"gitea.libretechconsulting.com/rmcguire/go-app/pkg/logging"
 )
 
-// Helper function to return a context loaded up with
+// MustSetupConfigAndLogging is a helper function to return a context loaded up with
 // config.AppConfig and a logger
 func MustSetupConfigAndLogging(ctx context.Context) context.Context {
 	ctx, err := config.LoadConfig(ctx)
@@ -24,7 +24,7 @@ func MustSetupConfigAndLogging(ctx context.Context) context.Context {
 	return ctx
 }
 
-// Unmarshal config into a custom type
+// MustSetupConfigAndLoggingInto will unmarshal config into a custom type
 // Type MUST include *config.AppConfig
 // Stored in context as *config.AppConfig but can be asserted back
 func MustSetupConfigAndLoggingInto[T any](ctx context.Context, into T) (context.Context, T) {

pkg/app/setup_custom.go

@@ -13,7 +13,7 @@ import (
 	"gitea.libretechconsulting.com/rmcguire/go-app/pkg/config"
 )
 
-// Used to unmarshal config and environment into a custom type
+// MustLoadConfigInto is used to unmarshal config and environment into a custom type
 // that overloads *config.AppConfig. Will perform normal env
 // substitutions for AppConfig, but env overrides for custom type
 // are up to the caller.

pkg/config/config.go

@@ -17,15 +17,15 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
-// To be set by ldflags in go build command or
-// retrieved from build meta below
+// Version is to be set by ldflags in go build command or
+// retrieved from build meta below.
 var Version = "(devel)"
 
-// Calling this will try to load from config if -config is
+// LoadConfig will try to load from config if -config is
 // provided as a file, and will apply any environment overrides
 // on-top of configuration defaults.
 // Config is stored in returned context, and can be retrieved
-// using config.FromCtx(ctx)
+// using config.FromCtx(ctx).
 func LoadConfig(ctx context.Context) (context.Context, error) {
 	configPath := flag.String("config", "", "Path to the configuration file")
 	flag.Parse()
@@ -44,6 +44,8 @@ func LoadConfig(ctx context.Context) (context.Context, error) {
 	return ctx, nil
 }
 
+// loadConfig loads the application configuration from the specified path,
+// applying environment variable overrides.
 func loadConfig(configPath string) (*AppConfig, error) {
 	cfg := *DefaultConfig
 
@@ -73,6 +75,8 @@ func loadConfig(configPath string) (*AppConfig, error) {
 	return &cfg, nil
 }
 
+// prepareConfig enriches and validates the AppConfig, parsing duration strings
+// for HTTP timeouts.
 func prepareConfig(cfg *AppConfig) error {
 	var errs error
 
@@ -104,12 +108,14 @@ func prepareConfig(cfg *AppConfig) error {
 	return errs
 }
 
-// Returns read timeout, write timeout, and idle timeout, in that order
-// nil if unset
+// Timeouts returns read timeout, write timeout, and idle timeout, in that order.
+// Returns nil if unset.
 func (h *HTTPConfig) Timeouts() (*time.Duration, *time.Duration, *time.Duration) {
 	return h.rT, h.wT, h.iT
 }
 
+// getVersion returns the application version, preferring the build info version
+// over the compile-time set Version variable.
 func getVersion() string {
 	if info, ok := debug.ReadBuildInfo(); ok && info.Main.Version != "(devel)" {
 		return info.Main.Version

pkg/config/ctx.go

@@ -9,10 +9,12 @@ type appConfigKey uint8
 
 const appConfigCtxKey appConfigKey = iota
 
-func (a *AppConfig) AddToCtx(ctx context.Context) context.Context {
-	return context.WithValue(ctx, appConfigCtxKey, a)
+// AddToCtx adds the AppConfig to the provided context.
+func (ac *AppConfig) AddToCtx(ctx context.Context) context.Context {
+	return context.WithValue(ctx, appConfigCtxKey, ac)
 }
 
+// MustFromCtx retrieves the AppConfig from the context, or panics if not found.
 func MustFromCtx(ctx context.Context) *AppConfig {
 	cfg, err := FromCtx(ctx)
 	if err != nil {
@@ -21,6 +23,7 @@ func MustFromCtx(ctx context.Context) *AppConfig {
 	return cfg
 }
 
+// FromCtx retrieves the AppConfig from the context.
 func FromCtx(ctx context.Context) (*AppConfig, error) {
 	ctxData := ctx.Value(appConfigCtxKey)
 	if ctxData == nil {

pkg/config/types.go

@@ -1,6 +1,6 @@
 package config
 
-// Default Settings
+// DefaultConfig provides a default application configuration.
 var DefaultConfig = &AppConfig{
 	Environment: "development",
 	Version:     getVersion(),
@@ -23,6 +23,7 @@ type AppConfig struct {
 	GRPC    *GRPCConfig `yaml:"grpc,omitempty" json:"grpc,omitempty"`
 }
 
+// HTTPEnabled returns true if HTTP is enabled in the AppConfig.
 func (ac *AppConfig) HTTPEnabled() bool {
 	if ac.HTTP != nil && ac.HTTP.Enabled {
 		return true
@@ -30,6 +31,7 @@ func (ac *AppConfig) HTTPEnabled() bool {
 	return false
 }
 
+// GRPCEnabled returns true if gRPC is enabled in the AppConfig.
 func (ac *AppConfig) GRPCEnabled() bool {
 	if ac.GRPC != nil && ac.GRPC.Enabled {
 		return true
@@ -37,6 +39,7 @@ func (ac *AppConfig) GRPCEnabled() bool {
 	return false
 }
 
+// OTELEnabled returns true if OpenTelemetry is enabled in the AppConfig.
 func (ac *AppConfig) OTELEnabled() bool {
 	if ac.OTEL != nil && ac.OTEL.Enabled {
 		return true

pkg/config/types_http.go

@@ -12,7 +12,7 @@ var defaultHTTPConfig = &HTTPConfig{
 	IdleTimeout:  "1m",
 }
 
-// HTTP Configuration
+// HTTPConfig provides HTTP server Configuration
 type HTTPConfig struct {
 	Enabled      bool   `yaml:"enabled" env:"APP_HTTP_ENABLED" json:"enabled,omitempty"`
 	Listen       string `yaml:"listen,omitempty" env:"APP_HTTP_LISTEN" json:"listen,omitempty"`

pkg/config/types_logging.go

@@ -8,7 +8,7 @@ var defaultLoggingConfig = &LogConfig{
 	TimeFormat: TimeFormatLong,
 }
 
-// Logging Configuration
+// LogConfig provides Logging Configuration
 type LogConfig struct {
 	Enabled    bool       `yaml:"enabled,omitempty" env:"APP_LOG_ENABLED" json:"enabled,omitempty"`
 	Level      string     `yaml:"level,omitempty" env:"APP_LOG_LEVEL" json:"level,omitempty"`

pkg/config/types_otel.go

@@ -8,7 +8,7 @@ var defaultOTELConfig = &OTELConfig{
 	MetricIntervalSecs: 30,
 }
 
-// OTEL Configuration
+// OtelConfig provides OTEL Configuration
 type OTELConfig struct {
 	Enabled            bool   `yaml:"enabled,omitempty" env:"APP_OTEL_ENABLED" json:"enabled,omitempty"`
 	PrometheusEnabled  bool   `yaml:"prometheusEnabled,omitempty" env:"APP_OTEL_PROMETHEUS_ENABLED" json:"prometheusEnabled,omitempty"`

pkg/logging/logging.go

@@ -1,3 +1,5 @@
+// Package logging provides a centralized logging utility using zerolog,
+// with configurable output formats and log levels.
 package logging
 
 import (

pkg/otel/otel.go

@@ -1,3 +1,4 @@
+// Package otel provides OpenTelemetry initialization and configuration for tracing and metrics.
 package otel
 
 import (
@@ -39,6 +40,7 @@ var (
 
 const defMetricInterval = 15 * time.Second
 
+// Init prepares otel, loading a tracer and meter stored in appp context.
 // Context must carry config.AppConfig
 func Init(ctx context.Context) (context.Context, func(context.Context) error) {
 	cfg := config.MustFromCtx(ctx)
@@ -232,7 +234,7 @@ func (s *settings) newMeterProvider(ctx context.Context) (*metric.MeterProvider,
 	return meterProvider, nil
 }
 
-// Creates a new tracer from the global opentelemetry provider
+// NewTracer creates a new tracer from the global opentelemetry provider
 func NewTracer(options ...trace.TracerOption) trace.Tracer {
 	return opentelemetry.GetTracerProvider().Tracer(
 		os.Getenv("OTEL_SERVICE_NAME"),

pkg/srv/grpc/grpc.go

@@ -1,3 +1,5 @@
+// Package grpc provides a gRPC server implementation with OpenTelemetry integration
+// and gRPC Gateway for RESTful API exposure.
 package grpc
 
 import (

pkg/srv/http/http_health.go

@@ -55,7 +55,7 @@ func handleHealthCheckFunc(ctx context.Context, hcFuncs ...opts.HealthCheckFunc)
 }
 
 func dummyHealthCheck(ctx context.Context) error {
-	workFor := rand.Intn(750)
+	workFor := rand.Intn(740) + 10 // ensure positive
 	ticker := time.NewTicker(time.Duration(time.Duration(workFor) * time.Millisecond))
 
 	select {