[!] restructure code tree, closes #518 (#521)

* [!] restructure code tree, closes #518
- get rid of `src` folder
- put `go.mod` to the root folder
- put packages in `internal`
- provide one public `api` package to allow import for rpc sinks
- put `main.go` under `cmd\pgwatch`
- move `utils\convert` to `cmd\pgwatch`
* [*] rename `MeasurementMessage` to `MeasurementEnvelope`

.github/dependabot.yml

@@ -3,7 +3,7 @@ updates:
 
   # Maintain dependencies for Go modules
   - package-ecosystem: gomod
-    directory: "src/"
+    directory: "/" 
     schedule:
       interval: daily
       time: "04:00"

.github/workflows/build.yml

@@ -24,35 +24,34 @@ jobs:
       uses: actions/setup-go@v5
       with:
         go-version: '1.22'
-        cache-dependency-path: 'src/go.sum'
+        cache-dependency-path: 'go.sum'
 
     - name: Cache npm packages
       uses: actions/cache@v4
       with:
         path: |
-          src/webui/node_modules
+          internal/webui/node_modules
         key: ${{ runner.os }}-npm-${{ hashFiles('**/yarn.lock') }}
         restore-keys: |
           ${{ runner.os }}-npm-        
  
     - name: Build
       run: |
-        cd src/webui
+        cd internal/webui
         yarn install --network-timeout 100000 && yarn build
-        cd ..
-        go build
+        cd -
+        go build ./cmd/pgwatch
 
     - name: Upload webui as artifact
       uses: actions/upload-artifact@v4
       with:
         name: webui-build
-        path: src/webui/build
+        path: internal/webui/build
 
     - name: GolangCI-Lint
       uses: golangci/golangci-lint-action@v6
       with:
         version: latest
-        working-directory: src
 
   test:
     if: true # false to skip job during debug
@@ -68,24 +67,22 @@ jobs:
       uses: actions/setup-go@v5
       with:
         go-version: '1.22'
-        cache-dependency-path: 'src/go.sum'
+        cache-dependency-path: 'go.sum'
 
     - name: Download webui artifact
       uses: actions/download-artifact@v4
       with:
         name: webui-build
-        path: src/webui/build        
+        path: internal/webui/build        
 
     - name: Test
       run: |
-        cd src
         go test -failfast -v -timeout=300s -p 1 -coverprofile=profile.cov ./...
 
     - name: Coveralls
       uses: coverallsapp/github-action@v2
       with:
-        base-path: src
-        file: src/profile.cov 
+        file: profile.cov 
 
   goreleaser:
     if: true # false to skip job during debug    
@@ -101,7 +98,7 @@ jobs:
       uses: actions/setup-go@v5
       with:
         go-version: '1.22'
-        cache-dependency-path: 'src/go.sum'
+        cache-dependency-path: 'go.sum'
 
     - name: Run GoReleaser
       uses: goreleaser/goreleaser-action@v6

.gitignore

@@ -24,6 +24,3 @@ debug
 
 # IntelliJ Idea settings
 .idea/
-
-# leftovers
-src/metrics/sql/

.goreleaser.yml

@@ -3,12 +3,10 @@ version: 2
 before:
   hooks:
     # weirdly goreleaser doesn't all to include outside of the Go build "root" so need to copy
-    - cp -r grafana ./src/
-    - sh -c "cd ./src/webui && yarn install && yarn build"
+    - sh -c "cd ./internal/webui && yarn install && yarn build"
 
 builds:
-- dir: src
-  binary: pgwatch
+- main: ./cmd/pgwatch
   env:
     - CGO_ENABLED=0
   goos:

api/types.go

@@ -0,0 +1,13 @@
+package api
+
+import (
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/metrics"
+)
+
+type (
+	// Metric represents a metric definition
+	Metric = metrics.Metric
+	// MeasurementEnvelope represents a collection of measurement messages wrapped up
+	// with metadata such as metric name, source type, etc.
+	MeasurementEnvelope = metrics.MeasurementEnvelope
+)

src/main.go → cmd/pgwatch/main.go

@@ -10,30 +10,12 @@ import (
 	"sync/atomic"
 	"syscall"
 
-	"github.com/cybertec-postgresql/pgwatch/cmdopts"
-	"github.com/cybertec-postgresql/pgwatch/log"
-	"github.com/cybertec-postgresql/pgwatch/reaper"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/cmdopts"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/log"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/reaper"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/webui"
 )
 
-// version output variables
-var (
-	commit  = "unknown"
-	version = "unknown"
-	date    = "unknown"
-	dbapi   = "00179"
-)
-
-func printVersion() {
-	fmt.Printf(`
-Version info:
-  Version:      %s
-  DB Schema:    %s
-  Git Commit:   %s
-  Built:        %s
-
-`, version, dbapi, commit, date)
-}
-
 // SetupCloseHandler creates a 'listener' on a new goroutine which will notify the
 // program if it receives an interrupt from the OS. We then handle this by calling
 // our clean up procedure and exiting the program.
@@ -108,7 +90,7 @@ func main() {
 		return
 	}
 
-	if err = opts.InitWebUI(webuifs, logger); err != nil {
+	if err = opts.InitWebUI(webui.WebUIFs, logger); err != nil {
 		exitCode.Store(cmdopts.ExitCodeWebUIError)
 		logger.Error(err)
 		return

cmd/pgwatch/version.go

@@ -0,0 +1,22 @@
+package main
+
+import "fmt"
+
+// version output variables
+var (
+	commit  = "unknown"
+	version = "unknown"
+	date    = "unknown"
+	dbapi   = "00179"
+)
+
+func printVersion() {
+	fmt.Printf(`
+Version info:
+  Version:      %s
+  DB Schema:    %s
+  Git Commit:   %s
+  Built:        %s
+
+`, version, dbapi, commit, date)
+}

docker/Dockerfile

@@ -2,7 +2,7 @@
 # 1. Build Web UI
 # ----------------------------------------------------------------
 FROM node:21 AS uibuilder
-ADD src/webui /webui
+ADD internal/webui /webui
 RUN cd webui && yarn install --network-timeout 100000 && yarn build
 
 # ----------------------------------------------------------------
@@ -14,9 +14,9 @@ ARG VERSION
 ARG GIT_HASH
 ARG GIT_TIME
 
-ADD src /pgwatch
-COPY --from=uibuilder /webui/build /pgwatch/webui/build
-RUN cd /pgwatch && CGO_ENABLED=0 go build -ldflags "-X 'main.commit=${GIT_HASH}' -X 'main.date=${GIT_TIME}' -X 'main.version=${VERSION}'"
+COPY . /pgwatch
+COPY --from=uibuilder /webui/build /pgwatch/internal/webui/build
+RUN cd /pgwatch && CGO_ENABLED=0 go build -ldflags "-X 'main.commit=${GIT_HASH}' -X 'main.date=${GIT_TIME}' -X 'main.version=${VERSION}'" ./cmd/pgwatch
 
 # ----------------------------------------------------------------
 # 3. Build the final image
@@ -25,7 +25,7 @@ FROM alpine
 
 # Copy over the compiled gatherer
 COPY --from=builder /pgwatch/pgwatch /pgwatch/
-COPY src/metrics/metrics.yaml /pgwatch/metrics/metrics.yaml
+COPY internal/metrics/metrics.yaml /pgwatch/metrics/metrics.yaml
 
 # Admin UI for configuring servers to be monitored
 EXPOSE 8080

docker/demo/Dockerfile

@@ -2,7 +2,7 @@
 # 1. Build Web UI
 # ----------------------------------------------------------------
 FROM node:21 AS uibuilder
-ADD src/webui /webui
+COPY internal/webui /webui
 RUN cd webui && yarn install --network-timeout 100000 && yarn build
 
 # ----------------------------------------------------------------
@@ -14,9 +14,9 @@ ARG VERSION
 ARG GIT_HASH
 ARG GIT_TIME
 
-ADD src /pgwatch
-COPY --from=uibuilder /webui/build /pgwatch/webui/build
-RUN cd /pgwatch && CGO_ENABLED=0 go build -ldflags "-X 'main.commit=${GIT_HASH}' -X 'main.date=${GIT_TIME}' -X 'main.version=${VERSION}'"
+COPY . /pgwatch
+COPY --from=uibuilder /webui/build /pgwatch/internal/webui/build
+RUN cd /pgwatch && CGO_ENABLED=0 go build -ldflags "-X 'main.commit=${GIT_HASH}' -X 'main.date=${GIT_TIME}' -X 'main.version=${VERSION}'" ./cmd/pgwatch
 
 # ----------------------------------------------------------------
 # 3. Build the final image
@@ -25,7 +25,7 @@ FROM postgres:16-bullseye AS releaser
 
 # Copy over the compiled gatherer
 COPY --from=builder /pgwatch/pgwatch /pgwatch/
-COPY src/metrics/metrics.yaml /pgwatch/metrics/metrics.yaml
+COPY internal/metrics/metrics.yaml /pgwatch/metrics/metrics.yaml
 
 # Install dependencies
 ENV DEBIAN_FRONTEND=noninteractive

docs/advanced_features.md

@@ -34,7 +34,7 @@ config (for Config DB based setups) looks like:
 ```
 
 For YAML based setups an example can be found from the
-[instances.yaml](https://github.com/cybertec-postgresql/pgwatch/blob/master/src/sources/sample.sources.yaml#L21)
+[instances.yaml](https://github.com/cybertec-postgresql/pgwatch/blob/master/internal/sources/sample.sources.yaml#L21)
 file.
 
 If Patroni is powered by *etcd*, then also username, password, ca_file,
@@ -55,7 +55,7 @@ database server logs for errors. Out-of-the-box it will though only work
 when logs are written in **CSVLOG** format. For other formats user needs
 to specify a regex that parses out named groups of following fields:
 *database_name*, *error_severity*. See
-[here](https://github.com/cybertec-postgresql/pgwatch/blob/master/src/metrics/logparse.go#L27)
+[here](https://github.com/cybertec-postgresql/pgwatch/blob/master/internal/metrics/logparse.go#L27)
 for an example regex.
 
 Note that only the event counts are stored, no error texts, usernames or
@@ -65,7 +65,7 @@ the whole instance. The metric name to enable log parsing is
 destination / setting to work, the monitoring user needs superuser /
 pg_monitor privileges - if this is not possible then log settings need
 to be specified manually under "Host config" as seen for example
-[here](https://github.com/cybertec-postgresql/pgwatch/blob/master/src/sources/sample.sources.yaml).
+[here](https://github.com/cybertec-postgresql/pgwatch/blob/master/internal/sources/sample.sources.yaml).
 
 **Sample configuration if not using CSVLOG logging:**
 

docs/custom_installation.md

@@ -84,7 +84,7 @@ syntax differences.
             daemon
 
                 git clone https://github.com/cybertec-postgresql/pgwatch.git
-                cd pgwatch/src/webui
+                cd pgwatch/internal/webui
                 yarn install --network-timeout 100000 && yarn build
                 cd ..
                 go build

docs/installation_options.md

@@ -24,7 +24,7 @@ The default Docker images use this approach.
 From v1.4.0 one can deploy the gatherer daemon(s) decentrally with
 *hosts to be monitored* defined in simple YAML files. In that case there
 is no need for the central Postgres "config DB". See the sample
-[instances.yaml](https://github.com/cybertec-postgresql/pgwatch/blob/master/src/sources/sample.sources.yaml)
+[instances.yaml](https://github.com/cybertec-postgresql/pgwatch/blob/master/internal/sources/sample.sources.yaml)
 config file for an example. Note that in this mode you also need to
 point out the path to metric definition SQL files when starting the
 gatherer. Also note that the configuration system also supports multiple

src/go.mod → go.mod

@@ -1,4 +1,4 @@
-module github.com/cybertec-postgresql/pgwatch
+module github.com/cybertec-postgresql/pgwatch/v3
 
 go 1.22.0
 

src/cmdopts/cmdconfig.go → internal/cmdopts/cmdconfig.go

@@ -5,8 +5,8 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/cybertec-postgresql/pgwatch/metrics"
-	"github.com/cybertec-postgresql/pgwatch/sources"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/sources"
 )
 
 type ConfigCommand struct {

src/cmdopts/cmdoptions.go → internal/cmdopts/cmdoptions.go

@@ -9,11 +9,11 @@ import (
 	"os"
 	"time"
 
-	"github.com/cybertec-postgresql/pgwatch/log"
-	"github.com/cybertec-postgresql/pgwatch/metrics"
-	"github.com/cybertec-postgresql/pgwatch/sinks"
-	"github.com/cybertec-postgresql/pgwatch/sources"
-	"github.com/cybertec-postgresql/pgwatch/webserver"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/log"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/sinks"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/webserver"
 	"github.com/jackc/pgx/v5"
 	flags "github.com/jessevdk/go-flags"
 )

src/cmdopts/cmdoptions_test.go → internal/cmdopts/cmdoptions_test.go

@@ -4,7 +4,7 @@ import (
 	"os"
 	"testing"
 
-	"github.com/cybertec-postgresql/pgwatch/log"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/log"
 	flags "github.com/jessevdk/go-flags"
 	"github.com/stretchr/testify/assert"
 )

src/cmdopts/cmdsource.go → internal/cmdopts/cmdsource.go

@@ -5,7 +5,7 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/cybertec-postgresql/pgwatch/sources"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/sources"
 )
 
 type SourceCommand struct {

src/db/bootstrap.go → internal/db/bootstrap.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"time"
 
-	"github.com/cybertec-postgresql/pgwatch/log"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/log"
 	"github.com/jackc/pgx/v5"
 	"github.com/jackc/pgx/v5/pgconn"
 	"github.com/jackc/pgx/v5/pgxpool"

src/db/bootstrap_test.go → internal/db/bootstrap_test.go

@@ -11,7 +11,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/cybertec-postgresql/pgwatch/db"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/db"
 	testcontainers "github.com/testcontainers/testcontainers-go"
 	"github.com/testcontainers/testcontainers-go/modules/postgres"
 	"github.com/testcontainers/testcontainers-go/wait"

src/db/conn_test.go → internal/db/conn_test.go

@@ -4,7 +4,7 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/cybertec-postgresql/pgwatch/db"
+	"github.com/cybertec-postgresql/pgwatch/v3/internal/db"
 )
 
 func TestMarshallParam(t *testing.T) {

src/log/formatter.go → internal/log/formatter.go

@@ -137,7 +137,7 @@ func (f *Formatter) Format(entry *logrus.Entry) ([]byte, error) {
 }
 
 func trimFilename(s string) string {
-	const sub = "src/"
+	const sub = "internal/"
 	idx := strings.Index(s, sub)
 	if idx == -1 {
 		return s

src/log/formatter_test.go → internal/log/formatter_test.go

@@ -10,7 +10,7 @@ import (
 	"strings"
 	"testing"
 
-	formatter "github.com/cybertec-postgresql/pgwatch/log"
+	formatter "github.com/cybertec-postgresql/pgwatch/v3/internal/log"
 	"github.com/sirupsen/logrus"
 )