added nilaway (#18)

.github/workflows/checks.yml

@@ -45,6 +45,9 @@ jobs:
       - name: Install golangci-lint
         run: go install github.com/golangci/golangci-lint/cmd/[email protected]
 
+      - name: Install NilAway
+        run: go install go.uber.org/nilaway/cmd/nilaway@latest
+
       - name: Lint
         run: make lint
 

Makefile

@@ -36,6 +36,7 @@ lint:
 	go vet ./...
 	staticcheck ./...
 	golangci-lint run
+	nilaway ./...
 
 .PHONY: fmt
 fmt:

README.md

@@ -15,6 +15,7 @@ Toolbox and building blocks for new Go projects, to get started quickly and righ
   * Prometheus metrics
   * Using https://pkg.go.dev/github.com/go-chi/chi/v5 for routing
   * [Urfave](https://cli.urfave.org/) for cli args
+* https://github.com/uber-go/nilaway
 * See also:
   * Public project setup: https://github.com/flashbots/flashbots-repository-template
   * Repository for common Go utilities: https://github.com/flashbots/go-utils

cmd/httpserver/main.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/flashbots/go-template/common"
 	"github.com/flashbots/go-template/httpserver"
+	"github.com/google/uuid"
 	"github.com/urfave/cli/v2" // imports as package "cli"
 )
 
@@ -33,6 +34,11 @@ var flags []cli.Flag = []cli.Flag{
 		Value: false,
 		Usage: "log debug messages",
 	},
+	&cli.BoolFlag{
+		Name:  "log-uid",
+		Value: false,
+		Usage: "generate a uuid and add to all log messages",
+	},
 	&cli.StringFlag{
 		Name:  "log-service",
 		Value: "your-project",
@@ -55,6 +61,7 @@ func main() {
 			metricsAddr := cCtx.String("metrics-addr")
 			logJSON := cCtx.Bool("log-json")
 			logDebug := cCtx.Bool("log-debug")
+			logUID := cCtx.Bool("log-uid")
 			logService := cCtx.String("log-service")
 			drainDuration := time.Duration(cCtx.Int64("drain-seconds")) * time.Second
 
@@ -65,6 +72,11 @@ func main() {
 				Version: common.Version,
 			})
 
+			if logUID {
+				id := uuid.Must(uuid.NewRandom())
+				log = log.With("uid", id.String())
+			}
+
 			cfg := &httpserver.HTTPServerConfig{
 				ListenAddr:  listenAddr,
 				MetricsAddr: metricsAddr,

httpserver/server.go

@@ -11,7 +11,6 @@ import (
 	"github.com/flashbots/go-template/metrics"
 	"github.com/flashbots/go-utils/httplogger"
 	"github.com/go-chi/chi/v5"
-	"github.com/google/uuid"
 	"go.uber.org/atomic"
 )
 
@@ -28,7 +27,6 @@ type HTTPServerConfig struct {
 
 type Server struct {
 	cfg     *HTTPServerConfig
-	id      uuid.UUID
 	isReady atomic.Bool
 	log     *slog.Logger
 
@@ -37,14 +35,16 @@ type Server struct {
 }
 
 func New(cfg *HTTPServerConfig) (srv *Server, err error) {
-	id := uuid.Must(uuid.NewRandom())
+	metrics, err := metrics.New(common.PackageName, cfg.MetricsAddr)
+	if err != nil {
+		return nil, err
+	}
 
 	srv = &Server{
 		cfg:     cfg,
-		id:      id,
-		isReady: atomic.Bool{},
-		log:     cfg.Log.With("serverID", id.String()),
+		log:     cfg.Log,
 		srv:     nil,
+		metrics: metrics,
 	}
 	srv.isReady.Swap(true)
 
@@ -62,11 +62,6 @@ func New(cfg *HTTPServerConfig) (srv *Server, err error) {
 		WriteTimeout: cfg.WriteTimeout,
 	}
 
-	srv.metrics, err = metrics.New(common.PackageName, cfg.MetricsAddr)
-	if err != nil {
-		return nil, err
-	}
-
 	return srv, nil
 }