drop zerolog; introduce slog

Author: moukoublen

.gitattributes

@@ -0,0 +1 @@
+*.go text eol=lf

.golangci.yml

@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://golangci-lint.run/jsonschema/golangci.jsonschema.json
+
 # https://golangci-lint.run/usage/configuration/
 # https://golangci-lint.run/usage/linters/
 
@@ -21,6 +23,8 @@ output:
 linters:
   enable-all: true
   disable:
+    - exportloopref # deprecated
+    - execinquery # deprecated
     - exhaustruct # TODO: reconsider
     - depguard # TODO: reconsider
     - funlen # TODO: reconsider
@@ -30,6 +34,11 @@ linters:
     - varnamelen
     - nonamedreturns
     - testpackage
+    - godox
+    - godot
+    - gochecknoglobals
+    - gomnd
+    - mnd
 
 issues:
   # https://golangci-lint.run/usage/false-positives/#default-exclusions
@@ -50,7 +59,6 @@ linters-settings:
   unused:
     field-writes-are-uses: false
     post-statements-are-reads: false
-    exported-is-used: true
     exported-fields-are-used: true
     parameters-are-used: true
     local-variables-are-used: false

.vscode/launch.json

@@ -22,12 +22,12 @@
       ],
     },
     {
-      "name": "Run Main",
+      "name": "Debug Main",
       "preLaunchTask": "build debug",
       "type": "go",
       "request": "launch",
-      "mode": "exec",
-      "program": "${workspaceFolder}/output/goboilerplate",
+      "mode": "debug",
+      "program": "${workspaceFolder}/cmd/goboilerplate",
       "debugAdapter": "dlv-dap",
       "buildFlags": "",
       "env": {
@@ -36,7 +36,7 @@
         "APP_HTTP_OUTBOUND_TRAFFIC_LOG_LEVEL": "2",
         "APP_HTTP_READ_HEADER_TIMEOUT": "3s",
         "APP_SHUTDOWN_TIMEOUT": "6s",
-        "APP_LOG_LEVEL": "-1"
+        "APP_LOG_LEVEL": "DEBUG"
       }
     }
   ]

README.md

@@ -1,14 +1,20 @@
 # Go service boilerplate
 
 The boilerplate consists of:
-* Go code with [chi](https://github.com/go-chi/chi) http router, [zerolog](https://github.com/rs/zerolog) logging, [knadh/koanf](github.com/knadh/koanf) config library and [testify](github.com/stretchr/testify). Basic code infra with http setup and request and response logger (configurable), logging setup, config setup and graceful shutdown.
+* Go code with
+    * [chi](https://github.com/go-chi/chi) http router.
+    * [slog](https://pkg.go.dev/log/slog) logging,
+    * [knadh/koanf](github.com/knadh/koanf) config library.
+    * [testify](github.com/stretchr/testify).
+    * Basic code infra with http setup and request and response logger (configurable), logging setup, config setup and graceful shutdown.
+    * Optional verbose logging of http traffic, with payload,
 * Makefile targets for local installation of external tools (`staticcheck`, `golangci-lint`, `goimports`, `gofumpt`, `gojq`, `air`).
 * Makefile targets for linting (installing all necessary tools locally), building, testing, and local run (docker compose or native).
 * [GitHub Actions](https://github.com/features/actions) for linter checks and tests on each pr.
 * [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates) setup for updating dependencies.
 * [Visual Studio Code](https://code.visualstudio.com/) settings, tasks and launch configuration for building, debugging and testing the code.
 * Docker compose and development Dockerfile with hot-rebuild (using [air](https://github.com/air-verse/air)) and dlv debug server.
-* Production Dockerfile
+* Production Dockerfile.
 
 ## How to use
 1. Click `Use this template` from this repo github page, and choose your destination repo/name (e.g. `github.com/glendale/service`)
@@ -17,6 +23,7 @@ The boilerplate consists of:
 
 
 ## Go package and file structure
+The project structure attempts to be on a par with [golang-standards/project-layout](https://github.com/golang-standards/project-layout).
 
 > Every local package that collides with a golang std package is named with `x` postfix. For example `.../internal/httpx` or `.../internal/logx`. By doing this cheat you can avoid putting aliases when you need both of those and you can take advantage of package autocomplete/autoimport features more easily than having colliding names.
 
@@ -26,125 +33,12 @@ The boilerplate consists of:
 | `internal/exec.go` | the `Main` struct that wraps the long running / signal handling / graceful shutdown of the service |
 | `internal/config`  | this package contain the initialization of `koanf` config. |
 | `internal/httpx`   | this package contains: the setup of the `chi` router, some helpers functions for parsing/writing http request and http response and some middlewares like for logging each request/response. |
-| `internal/logx`   | this package contains the setup/init function for `zerolog` logger. |
+| `internal/logx`   | this package contains the setup/init function for `slog` logger. |
 
 | Folder/File        | Description    |
 |--------------------|-----------------------------------------|
-| `deployments`      | this folder is intended to hold everything regarding deployment (e.g. helm/kubernetes etc). Inside `compose` directory a `docker-compose.yml` file is included that is intended for local development. |
+| `deployments`      | this folder is intended to hold everything regarding deployment (e.g. helm/kubernetes etc). Inside `local` directory a `docker-compose.yml` file is included that is intended for local development. |
 | `build/docker`     | this folder contains production-like docker file as well as a local development one. |
 
-
-
-
-## Make file targets
-
-
-### Build, Debug and Local Deploy Targets
-
-#### `build`
-Builds all binaries under `./cmd` (one for each directory) and outputs the binaries into `./output` folder using this patter `./cmd/<directory name> -> ./output/<directory name>`.
-___
-
-#### `cmd.<directory name>`
-Builds a specific cmd directory `<directory name>` and outputs the binary into `./output` folder using this pattern `./cmd/<directory name> -> ./output/<directory name>`.
-___
-
-#### `clean`
-Deletes `./output` folder.
-___
-
-#### `compose-up`
-Deploys (rebuilds and recreates) the docker compose file `deployments/compose/docker-compose.yml` in attached mode. This docker compose file is intended for local development.<br>
-It uses the docker file `build/docker/debug.Dockerfile` and runs `air` target (see below), including hot-reload (rebuild on changes) and debug server.
-___
-
-#### `compose-down`
-Stops (if started) the containers specified by the docker compose file `deployments/compose/docker-compose.yml` removes containers, cleans up the volumes and delete local docker images.
-___
-
-#### `air`
-Installs (if needed) [air](https://github.com/air-verse/air) under `TOOLS_BIN` folder (default is `./.tools/bin`) and runs `air -c .air.toml`. <br>
-Air watches for code file changes and rebuilds the binary according to the configuration `.air.toml`. <br>
-Current air configuration executes `cmd.goboilerplate` target (on each file change) and then runs the `./build/dlv` that starts the debug server (`dlv exec`) with the produced binary.
-___
-
-#### `image`
-Builds the docker image using the docker file `./build/docker/Dockerfile`. <br>
-This docker file is intended to be used as a production image. <br>
-Image name and tag are specified by `IMAGE_NAME` and `IMAGE_TAG`. Default values can be overwritten during execution (eg `make IMAGE_NAME=myimage IMAGE_TAG=1.0.0 image`).
-___
-
-
-### Util Targets
-
-#### `mod`
-Runs go mod [tidy](https://go.dev/ref/mod#go-mod-tidy) and [verify](https://go.dev/ref/mod#go-mod-verify).
-___
-
-#### `vendor`
-Runs [go mod vendor](https://go.dev/ref/mod#go-mod-vendor) that downloads all dependencies into `./vendor` folder.
-___
-
-#### `env`
-Prints information regarding the local environment. More specifically: go env, all go packages and folders, and the specified tools bin directory.
-___
-
-#### `git-reset`
-Full hard reset to HEAD. Cleans up all untracked files and restore all staged and un-staged changes.
-___
-
-
-### Tests and Linters Targets
-
-#### `test`
-Runs go [test](https://pkg.go.dev/cmd/go/internal/test) with race conditions and prints cover report.
-___
-
-#### `tools`
-Installs (if needed) all tools (goimports, staticcheck, gofumpt, etc) under `TOOLS_BIN` folder (default is `./.tools/bin`).
-___
-
-#### `checks`
-Runs all default checks (`vet`, `staticcheck`, `gofumpt`, `goimports`, `golangci-lint`).
-___
-
-#### `vet`
-Runs go [vet](https://pkg.go.dev/cmd/vet).
-___
-
-#### `gofumpt`
-Installs (if needed) [gofumpt](https://github.com/mvdan/gofumpt) under `TOOLS_BIN` folder (default is `./.tools/bin`) and runs `gofumpt` for each folder. <br>
-If `gofumpt` finds files that need fix/format it displays those files as list and the target fails (_exit 1_).
-___
-
-#### `gofumpt.display`
-In case of `gofumpt` fails this target can be used to display the necessary changes. It runs `gofumpt -d` to display the needed changes that can be applied with `make gofumpt.fix`.
-___
-
-#### `gofumpt.fix`
-Runs `gofumpt -w` to fix/format files (that need fix).
-___
-
-#### `goimports`
-Installs (if needed) [goimports](https://pkg.go.dev/golang.org/x/tools/cmd/goimports) under `TOOLS_BIN` folder (default is `./.tools/bin`) and runs `goimports` for each folder. <br>
-If `goimports` finds files that need fix/format it displays those files as list and the target fails (_exit 1_).
-___
-
-#### `goimports.display`
-In case of `goimports` fails this target can be used to display the necessary changes. It runs `goimports -d` to display the needed changes that can be applied with `make goimports.fix`.
-___
-
-#### `goimports.fix`
-Runs `goimports -w` to fix files (that need fix).
-___
-
-#### `staticcheck`
-Installs (if needed) [staticcheck](https://staticcheck.io/) under `TOOLS_BIN` folder (default is `./.tools/bin`) and runs `staticcheck` using all [checks](https://staticcheck.io/docs/checks) excluding [ST1000](https://staticcheck.io/docs/checks/#ST1000). <br>
-If issues are found the target fails (due to `staticcheck` exit status).
-___
-
-#### `golangci-lint`
-Installs (if needed) [golangci-lint](https://golangci-lint.run/) under `TOOLS_BIN` folder (default is `./.tools/bin`) and runs `golangci-lint`. <br>
-If issues are found the target fails (due to `golangci-lint` exit status).
-___
-
+## Makefile targets
+Makefile targets can be found in [docs/makefile_targets.md](docs/makefile_targets.md) file.

api/sample.http

@@ -0,0 +1,10 @@
+GET http://localhost:8888/about
+Accept: application/json
+Accept-Encoding: gzip, deflate, br
+
+GET http://localhost:8888/echo
+Accept: application/json
+Accept-Encoding: gzip, deflate, br
+{
+    "test": "value"
+}

build/docker/Dockerfile

@@ -4,7 +4,7 @@
 # https://docs.docker.com/build/guide/mounts/
 
 # https://hub.docker.com/_/golang
-FROM --platform=$BUILDPLATFORM golang:1.23.0-alpine3.20 AS builder
+FROM --platform=$BUILDPLATFORM golang:1.23.2-alpine3.20 AS builder
 RUN apk update && apk add --no-cache make git bash ca-certificates
 WORKDIR /app
 ARG TARGETOS TARGETARCH

build/docker/debug.Dockerfile

@@ -2,7 +2,7 @@
 ### https://hub.docker.com/r/docker/dockerfile
 
 # https://hub.docker.com/_/golang
-FROM golang:1.23.0-alpine3.20
+FROM golang:1.23.2-alpine3.20
 
 WORKDIR /wd
 

cmd/goboilerplate/main.go

@@ -3,12 +3,13 @@ package main
 import (
 	"context"
 	"fmt"
+	"log/slog"
+	"os"
 
 	"github.com/moukoublen/goboilerplate/internal"
 	"github.com/moukoublen/goboilerplate/internal/config"
 	"github.com/moukoublen/goboilerplate/internal/httpx"
 	"github.com/moukoublen/goboilerplate/internal/logx"
-	"github.com/rs/zerolog/log"
 )
 
 func defaultConfigs() map[string]any {
@@ -31,22 +32,26 @@ func defaultConfigs() map[string]any {
 }
 
 func main() {
-	cnf, err := config.Load("APP_", defaultConfigs())
+	// pre-init slog with default config
+	logger := logx.InitSLog(logx.Config{LogType: logx.LogTypeText, Level: slog.LevelInfo})
+	logger.Info("starting up...")
+
+	cnf, err := config.Load(context.Background(), "APP_", defaultConfigs())
 	if err != nil {
-		log.Fatal().Err(err).Send()
+		logger.Error("error during config init", logx.Error(err))
+		os.Exit(1)
 	}
 
-	logx.SetupLog(logx.ParseConfig(cnf))
-	log.Info().Msgf("Starting up")
+	logger = logx.InitSLog(logx.ParseConfig(cnf))
 
 	daemon, ctx := internal.NewDaemon(
 		context.Background(),
+		logger,
 		internal.SetShutdownTimeout(cnf.Duration("shutdown_timeout")),
 	)
-	_ = ctx
 
 	httpConf := httpx.ParseConfig(cnf)
-	router := httpx.NewDefaultRouter(httpConf)
+	router := httpx.NewDefaultRouter(ctx, httpConf)
 
 	// init services / application
 	server := httpx.StartListenAndServe(
@@ -55,14 +60,14 @@ func main() {
 		httpConf.ReadHeaderTimeout,
 		daemon.FatalErrorsChannel(),
 	)
-	log.Info().Msgf("service started at %s:%d", httpConf.IP, httpConf.Port)
+	logger.InfoContext(ctx, "service started", slog.String("bind", fmt.Sprintf("%s:%d", httpConf.IP, httpConf.Port)))
 
 	// set onShutdown for other components/services.
 	daemon.OnShutDown(
 		func(ctx context.Context) {
-			log.Info().Msg("shuting down http server")
+			logger.InfoContext(ctx, "shuting down  http server")
 			if err := server.Shutdown(ctx); err != nil {
-				log.Warn().Err(err).Msg("error during http server shutdown")
+				logger.Warn("error during http server shutdown", logx.Error(err))
 			}
 		},
 	)

docs/makefile_targets.md

@@ -0,0 +1,28 @@
+# Makefile targets
+
+| Target               | Description |
+| -------------------- | ----------- |
+| `mod`                | Runs go mod [tidy](https://go.dev/ref/mod#go-mod-tidy) and [verify](https://go.dev/ref/mod#go-mod-verify). |
+| `vendor`             | Runs [go mod vendor](https://go.dev/ref/mod#go-mod-vendor) that downloads all dependencies into `./vendor` folder. |
+| `go-deps-upgrade`    | Runs updates all `go.mod` dependencies. |
+| `env`                | Prints information regarding the local environment. More specifically: go env, all go packages and folders, and the specified tools bin directory. |
+| `git-reset`          | Full hard reset to HEAD. Cleans up all untracked files and restore all staged and un-staged changes. |
+| `build`              | Builds all binaries under `./cmd` (one for each directory) and outputs the binaries into `./output` folder using this pattern: `./cmd/<directory name> -> ./output/<directory name>`. |
+| `cmd.<cmd dir name>` | Builds a specific cmd directory `<directory name>` and outputs the binary into `./output` folder using this pattern: `./cmd/<directory name> -> ./output/<directory name>`.
+| `dbg.<cmd dir name>` | Builds a specific cmd directory `<directory name>` (keeping debug symbols) and outputs the binary into `./output` folder using this pattern: `./cmd/<directory name> -> ./output/<directory name>`.
+| `clean`              | Deletes `./output` folder.
+| `compose-up`         | Deploys (rebuilds and recreates) the docker compose file `deployments/compose/docker-compose.yml` in attached mode. This docker compose file is intended for local development.<br>It uses the docker file `build/docker/debug.Dockerfile` and runs `air` target (see below), including hot-reload (rebuild on changes) and debug server.
+| `compose-down`       | Stops (if started) the containers specified by the docker compose file `deployments/compose/docker-compose.yml` removes containers, cleans up the volumes and delete local docker images.
+| `air`                | Installs (if needed) [air](https://github.com/air-verse/air) under `TOOLS_BIN` folder (default is `./.tools/bin`) and runs `air -c .air.toml`.<br>Air watches for code file changes and rebuilds the binary according to the configuration `.air.toml`.<br>Current air configuration executes `cmd.goboilerplate` target (on each file change) and then runs the `./build/dlv` that starts the debug server (`dlv exec`) with the produced binary.
+| `image`              | Builds the docker image using the docker file `./build/docker/Dockerfile`.<br>This docker file is intended to be used as a production image.<br>Image name and tag are specified by `IMAGE_NAME` and `IMAGE_TAG`. Default values can be overwritten during execution (eg `make IMAGE_NAME=myimage IMAGE_TAG=1.0.0 image`).
+| `test`               | Runs go [test](https://pkg.go.dev/cmd/go/internal/test) with race conditions and prints cover report.
+| `tools`              | Installs (if needed) all tools (goimports, staticcheck, gofumpt, etc) under `TOOLS_BIN` folder (default is `./.tools/bin`).
+| `checks`             | Runs all default checks (`vet`, `staticcheck`, `gofumpt`, `goimports`, `golangci-lint`).
+| `vet`                | Runs go [vet](https://pkg.go.dev/cmd/vet).
+| `gofumpt`            | Installs (if needed) [gofumpt](https://github.com/mvdan/gofumpt) under `TOOLS_BIN` folder (default is `./.tools/bin`) and runs `gofumpt` for each folder.<br>If `gofumpt` finds files that need fix/format it displays those files as list and the target fails (_exit 1_).
+| `gofumpt.fix`        | Runs `gofumpt -w` to fix/format files (that need fix).
+| `goimports`          | Installs (if needed) [goimports](https://pkg.go.dev/golang.org/x/tools/cmd/goimports) under `TOOLS_BIN` folder (default is `./.tools/bin`) and runs `goimports` for each folder.<br>If `goimports` finds files that need fix/format it displays those files as list and the target fails (_exit 1_).
+| `goimports.fix`      | Runs `goimports -w` to fix files (that need fix).
+| `staticcheck`        | Installs (if needed) [staticcheck](https://staticcheck.io/) under `TOOLS_BIN` folder (default is `./.tools/bin`) and runs `staticcheck` using all [checks](https://staticcheck.io/docs/checks) excluding [ST1000](https://staticcheck.io/docs/checks/#ST1000).<br>If issues are found the target fails (due to `staticcheck` exit status).
+| `golangci-lint`      | Installs (if needed) [golangci-lint](https://golangci-lint.run/) under `TOOLS_BIN` folder (default is `./.tools/bin`) and runs `golangci-lint`. <br>If issues are found the target fails (due to `golangci-lint` exit status).
+

go.mod

@@ -10,7 +10,6 @@ require (
 	github.com/knadh/koanf/providers/env v0.1.0
 	github.com/knadh/koanf/providers/file v1.1.0
 	github.com/knadh/koanf/v2 v2.1.1
-	github.com/rs/zerolog v1.33.0
 	github.com/stretchr/testify v1.9.0
 )
 
@@ -20,11 +19,8 @@ require (
 	github.com/go-viper/mapstructure/v2 v2.1.0 // indirect
 	github.com/joho/godotenv v1.5.1 // indirect
 	github.com/knadh/koanf/maps v0.1.1 // indirect
-	github.com/mattn/go-colorable v0.1.13 // indirect
-	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
-	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/stretchr/objx v0.5.2 // indirect
 	golang.org/x/sys v0.25.0 // indirect