7 Commits

22 changed files with 96 additions and 56 deletions

9
CHANGELOG.md Normal file
View File

@@ -0,0 +1,9 @@
# 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.

View File

@@ -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

18
go.mod
View File

@@ -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
)

32
go.sum
View File

@@ -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=

View File

@@ -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

View File

@@ -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)

View File

@@ -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() {

View File

@@ -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")

View File

@@ -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

View File

@@ -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) {

View File

@@ -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.

View File

@@ -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

View File

@@ -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 {

View File

@@ -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

View File

@@ -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"`

View File

@@ -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"`

View File

@@ -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"`

View File

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

View File

@@ -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"),

View File

@@ -1,3 +1,5 @@
// Package grpc provides a gRPC server implementation with OpenTelemetry integration
// and gRPC Gateway for RESTful API exposure.
package grpc
import (
@@ -29,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,
) {

View File

@@ -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}

View File

@@ -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 {