[*] move some packages from internal to pkg

.github/workflows/build.yml

@@ -99,7 +99,7 @@ jobs:
     - name: Test
       run: |
         go generate ./api/pb/
-        go test -failfast -v -timeout=300s -p 1 -coverprofile=profile.cov ./cmd/... ./internal/...
+        go test -failfast -v -timeout=300s -p 1 -coverprofile=profile.cov ./cmd/... ./pkg/... ./internal/...
 
     - name: Coveralls
       uses: coverallsapp/github-action@v2

.goreleaser.yml

@@ -29,7 +29,7 @@ archives:
   files:
     - "./grafana/**/*"
     - "./README.md"
-    - src: "./internal/metrics/metrics.yaml"
+    - src: "./pkg/metrics/metrics.yaml"
       dst: "metrics.yaml"
     - src: "./contrib/sample.sources.yaml"
       dst: "sample.sources.yaml"
@@ -66,7 +66,7 @@ nfpms:
         dst: "/etc/pgwatch/grafana"
       - src: "./contrib/sample.sources.yaml"
         dst: "/etc/pgwatch/sample.sources.yaml"
-      - src: "./internal/metrics/metrics.yaml"
+      - src: "./pkg/metrics/metrics.yaml"
         dst: "/etc/pgwatch/metrics.yaml"
       - src: "./README.md"
         dst: "/etc/pgwatch/README.md"

api/pb/pgwatch.proto

@@ -27,7 +27,7 @@ message SyncReq {
 }
 
 // SyncOp represents synchronization operations for metrics.
-// The actual constants are defined in internal/sinks/types.go
+// The actual constants are defined in pkg/sinks/types.go
 // and should be used instead of these protobuf-generated constants.
 enum SyncOp {
     InvalidOp = 0;

cmd/pgwatch/main.go

@@ -10,9 +10,9 @@ import (
 	"sync/atomic"
 	"syscall"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/cmdopts"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/log"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/reaper"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/cmdopts"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/log"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/reaper"
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/webserver"
 )
 

cmd/pgwatch/main_integration_test.go

@@ -6,7 +6,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/cmdopts"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/cmdopts"
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/testutil"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"

docker/Dockerfile

@@ -63,7 +63,7 @@ FROM alpine
 
 # Copy over the compiled gatherer
 COPY --from=go-builder /pgwatch/pgwatch /pgwatch/
-COPY internal/metrics/metrics.yaml /pgwatch/metrics/metrics.yaml
+COPY pkg/metrics/metrics.yaml /pgwatch/metrics/metrics.yaml
 
 # Admin UI for configuring servers to be monitored
 EXPOSE 8080

docker/compose.pgwatch.yml

@@ -19,7 +19,7 @@ services:
       - "9187:9187"
       # - "6060:6060" # Uncomment for profiling
     volumes:
-      - "../internal/metrics/metrics.yaml:/etc/pgwatch/metrics.yml"
+      - "../pkg/metrics/metrics.yaml:/etc/pgwatch/metrics.yml"
       - "./bootstrap/.pgpass:/root/.pgpass:ro"
     depends_on:
       postgres:

docker/demo/Dockerfile

@@ -62,7 +62,7 @@ FROM postgres:18-bookworm AS demo
 
 # Copy over the compiled gatherer
 COPY --from=go-builder /pgwatch/pgwatch /pgwatch/
-COPY internal/metrics/metrics.yaml /pgwatch/metrics/metrics.yaml
+COPY pkg/metrics/metrics.yaml /pgwatch/metrics/metrics.yaml
 
 # Install TimescaleDB and extensions
 ENV DEBIAN_FRONTEND=noninteractive

docs/developer/reaper-batch-consolidation.md

@@ -87,19 +87,19 @@ At peak alignment (t = 7200s, all 32 metrics due): **32 → 1 round-trip = 97% r
 
 | File | Lines | Purpose |
 |------|-------|---------|
-| `internal/reaper/source_reaper.go` | 494 | SourceReaper struct, GCD, batch execution, Run loop |
-| `internal/reaper/source_reaper_test.go` | 471 | pgxmock unit tests (12 test functions, 20+ subtests) |
-| `internal/reaper/source_reaper_integration_test.go` | 301 | testcontainers integration tests (6 test functions) |
-| `internal/reaper/observability.go` | 38 | Prometheus metrics for batch observability |
+| `pkg/reaper/source_reaper.go` | 494 | SourceReaper struct, GCD, batch execution, Run loop |
+| `pkg/reaper/source_reaper_test.go` | 471 | pgxmock unit tests (12 test functions, 20+ subtests) |
+| `pkg/reaper/source_reaper_integration_test.go` | 301 | testcontainers integration tests (6 test functions) |
+| `pkg/reaper/observability.go` | 38 | Prometheus metrics for batch observability |
 
 ### Modified Files
 
 | File | Changes | Purpose |
 |------|---------|---------|
 | `internal/db/conn.go` | +1 line | Added `SendBatch` to `PgxPoolIface` interface |
-| `internal/reaper/reaper.go` | +21 / -186 lines | Per-source goroutines, simplified cancel management |
-| `internal/reaper/database.go` | +303 lines | Batched change detection, `prefetchChangeDetectionData` |
-| `internal/reaper/reaper_test.go` | +15 / -14 lines | Updated tests for per-source cancel pattern |
+| `pkg/reaper/reaper.go` | +21 / -186 lines | Per-source goroutines, simplified cancel management |
+| `pkg/reaper/database.go` | +303 lines | Batched change detection, `prefetchChangeDetectionData` |
+| `pkg/reaper/reaper_test.go` | +15 / -14 lines | Updated tests for per-source cancel pattern |
 
 **Total: 4 new files (1,304 lines), 4 modified files (+340 / -200 net)**
 
@@ -137,7 +137,7 @@ At peak alignment (t = 7200s, all 32 metrics due): **32 → 1 round-trip = 97% r
 
 ### Existing Tests — 0 regressions
 
-All 152 test cases in `internal/reaper/` pass, including all pre-existing tests for `DetectSprocChanges`, `DetectTableChanges`, `DetectIndexChanges`, `DetectPrivilegeChanges`, `DetectConfigurationChanges`, `FetchMetric`, `LoadSources`, `LoadMetrics`, log parser tests, and OS metric tests.
+All 152 test cases in `pkg/reaper/` pass, including all pre-existing tests for `DetectSprocChanges`, `DetectTableChanges`, `DetectIndexChanges`, `DetectPrivilegeChanges`, `DetectConfigurationChanges`, `FetchMetric`, `LoadSources`, `LoadMetrics`, log parser tests, and OS metric tests.
 
 ---
 

docs/reference/metric_definitions.md

@@ -34,7 +34,7 @@ provided by the pgwatch project to cover all typical needs.
 However, when monitoring hundreds of hosts, you'd typically want to define **custom metrics and/or presets**
 or at least adjust the metric fetching intervals according to your monitoring goals.
 
-You can find the full list in pgwatch's default [metrics.yaml](https://github.com/cybertec-postgresql/pgwatch/blob/master/internal/metrics/metrics.yaml) file,
+You can find the full list in pgwatch's default [metrics.yaml](https://github.com/cybertec-postgresql/pgwatch/blob/master/pkg/metrics/metrics.yaml) file,
 for a more user-friendly experience, consider browsing them via the [Web UI](../gallery/webui.md)
 
 !!! tip "Exporting Metric Definitions"

docs/tutorial/docker_installation.md

@@ -220,4 +220,4 @@ Source file `sources.yaml` in the same directory:
 Running this setup you get pgwatch that uses sources from YAML file and
 outputs measurements to postgres DB and exposes them for Prometheus
 to scrape on port 8080 instead of WebUI (which is disabled by `--web-disable`).
-Metrics definition are built-in, you can examine definition in [`internal/metrics/metrics.yaml`](https://github.com/cybertec-postgresql/pgwatch/blob/master/internal/metrics/metrics.yaml).
+Metrics definition are built-in, you can examine definition in [`pkg/metrics/metrics.yaml`](https://github.com/cybertec-postgresql/pgwatch/blob/master/pkg/metrics/metrics.yaml).

internal/db/bootstrap.go

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

internal/testutil/mocks.go

@@ -5,8 +5,8 @@ import (
 	"errors"
 
 	"github.com/cybertec-postgresql/pgwatch/v5/api/pb"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 	"google.golang.org/protobuf/types/known/structpb"
 )
 

internal/testutil/mocks_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/cybertec-postgresql/pgwatch/v5/api/pb"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/testutil"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"

internal/testutil/types.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/log"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/log"
 )
 
 var TestContext = log.WithLogger(context.Background(), log.NewNoopLogger())

internal/webserver/metric.go

@@ -7,7 +7,7 @@ import (
 
 	jsoniter "github.com/json-iterator/go"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
 )
 
 func (s *WebUIServer) handleMetrics(w http.ResponseWriter, r *http.Request) {

internal/webserver/metric_test.go

@@ -9,7 +9,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/testutil"
 	jsoniter "github.com/json-iterator/go"
 	"github.com/stretchr/testify/assert"

internal/webserver/source.go

@@ -7,7 +7,7 @@ import (
 
 	jsoniter "github.com/json-iterator/go"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 )
 
 func (s *WebUIServer) handleSources(w http.ResponseWriter, r *http.Request) {

internal/webserver/source_test.go

@@ -9,7 +9,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/testutil"
 	jsoniter "github.com/json-iterator/go"
 	"github.com/stretchr/testify/assert"

internal/webserver/webserver.go

@@ -18,9 +18,9 @@ import (
 	"time"
 
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/db"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/log"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/log"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 )
 
 //go:embed build

internal/webserver/webserver_test.go

@@ -10,7 +10,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
 	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
 )

internal/webserver/wslog.go

@@ -4,7 +4,7 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/log"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/log"
 	"github.com/gorilla/websocket"
 )
 

internal/webserver/wslog_test.go

@@ -8,7 +8,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/log"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/log"
 	"github.com/gorilla/websocket"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"

internal/cmdopts/cmdconfig.go → pkg/cmdopts/cmdconfig.go

@@ -6,9 +6,9 @@ import (
 	"fmt"
 
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/db"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sinks"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sinks"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 )
 
 type ConfigCommand struct {

internal/cmdopts/cmdconfig_integration_test.go → pkg/cmdopts/cmdconfig_integration_test.go

@@ -6,9 +6,9 @@ import (
 	"testing"
 	"time"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sinks"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sinks"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/testutil"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"

internal/cmdopts/cmdconfig_test.go → pkg/cmdopts/cmdconfig_test.go

@@ -6,9 +6,9 @@ import (
 	"os"
 	"testing"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sinks"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sinks"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )

internal/cmdopts/cmdoptions.go → pkg/cmdopts/cmdoptions.go

@@ -9,10 +9,10 @@ import (
 	"time"
 
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/db"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/log"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sinks"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/log"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sinks"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/webserver"
 	flags "github.com/jessevdk/go-flags"
 )

internal/cmdopts/cmdoptions_test.go → pkg/cmdopts/cmdoptions_test.go

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

internal/cmdopts/cmdsource.go → pkg/cmdopts/cmdsource.go

@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"net/url"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 )
 
 type SourceCommand struct {

internal/cmdopts/cmdsource_test.go → pkg/cmdopts/cmdsource_test.go

@@ -6,7 +6,7 @@ import (
 	"testing"
 
 	"github.com/cybertec-postgresql/pgwatch/v5/internal/db"
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/sources"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/sources"
 	"github.com/jackc/pgx/v5/pgxpool"
 	"github.com/pashagolub/pgxmock/v4"
 	"github.com/stretchr/testify/assert"

internal/log/formatter_test.go → pkg/log/formatter_test.go

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

internal/log/log_test.go → pkg/log/log_test.go

@@ -5,7 +5,7 @@ import (
 	"os"
 	"testing"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/log"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/log"
 	"github.com/jackc/pgx/v5/tracelog"
 	"github.com/stretchr/testify/assert"
 )

internal/metrics/default_test.go → pkg/metrics/default_test.go

@@ -5,7 +5,7 @@ import (
 	"errors"
 	"testing"
 
-	"github.com/cybertec-postgresql/pgwatch/v5/internal/metrics"
+	"github.com/cybertec-postgresql/pgwatch/v5/pkg/metrics"
 	"github.com/stretchr/testify/assert"
 )