v4.0.0-beta

[pashagolub]

What's New

This major release introduces several significant updates, new features, bug fixes, and enhancements

Important Changes

PostgreSQL 18 Metrics

• total_XXX_time columns are added to table_stats metric;
• read_bytes, write_bytes, and extend_bytes are added to stat_io metric;
• use pg_stat_io for wal_stats metric;
• use pg_ls_archive_statusdir() in archiver_pending_count metric;
• num_done and slru_written columns are added to checkpointer metric;
• parallel_workers_to_launch and parallel_workers_launched columns are added to db_stats metric.

Grafana Dashboards

• New Grafana v12 dashboards have been added for both PostgreSQL and Prometheus sinks;
• Grafana v10 support is discontinued;
• New "Global Database Overview" dashboard with 26 panels, including new panels for replication, connections, and index usage;
• New "Database Overview" now has 21 panels with time lag support and improved visualizations;
• New "Query Performance Analysis" dashboard with enhanced table with 17 metrics and 8 visualization panels;
• New "Tables Overview" dashboard providing insights into table sizes, bloat, and index usage with treemap visualizations panels.

Metrics

• Realtime metrics have been deprecated and removed from the system.
• Metrics can now be loaded from a specified folder, allowing for better organization and management of metric definitions.

Sinks

• gRPC Sink Enhancements: Basic authentication support has been added to the gRPC sink, along with improved documentation for its usage.

Development and Contribution

• The development experience with Docker Compose has been enhanced, making it easier to set up and manage the environment.
• A new repository, pgwatch-contrib, has been created to host additional contributions and extensions for pgwatch from the community. The rpc subdirectory contains sample gRPC sinks implementations.

Changelog

• [!] add Grafana v12 dashboards for Prometheus data source by @pashagolub in [!] add Grafana v12 dashboards for Prometheus data source #933
• [!] add support for PostgreSQL v18 by @pashagolub in [!] add support for PostgreSQL v18 #903
• [!] deprecate realtime metrics by @pashagolub in [!] deprecate realtime metrics #925
• [!] remove Grafana v10 dashboards due to EOL of Grafana v10 by @pashagolub in [!] remove Grafana v10 dashboards due to EOL of Grafana v10 #934
• [!] remove obsolete db_stats_aurora metric by @pashagolub in [!] remove obsolete db_stats_aurora metric #930
• [+] add "Query Performance Analysis" dashboard by @pashagolub in [+] add "Query Performance Analysis" dashboard #916
• [+] add "Tables Overview" dashboard by @pashagolub in [+] add "Tables Overview" dashboard #918
• [+] add basic auth support to grpc sink by @0xgouda in [+] add basic auth support to grpc sink #862
• [+] add docs for grpc sink by @0xgouda in [+] add docs for grpc sink #867
• [+] add PlantUML diagrams by @pashagolub in [+] add PlantUML diagrams #926
• [+] add sample metrics YAML file, closes Adding a sample for custom metric #883 by @pashagolub in [+] add sample metrics YAML file, closes #883 #900
• [+] allow metrics loading from folder, closes Can't load a custom metrics directory with PW_METRICS #882 by @0xgouda in [+] allow metrics loading from folder, closes #882 #889
• [+] bump actions/checkout from 4 to 5 by @dependabot[bot] in [+] bump actions/checkout from 4 to 5 #888
• [+] bump actions/download-artifact from 4 to 5 by @dependabot[bot] in [+] bump actions/download-artifact from 4 to 5 #881
• [+] bump actions/setup-go from 5 to 6 by @dependabot[bot] in [+] bump actions/setup-go from 5 to 6 #939
• [+] bump actions/setup-node from 4 to 5 by @dependabot[bot] in [+] bump actions/setup-node from 4 to 5 #936
• [+] bump actions/setup-python from 5 to 6 by @dependabot[bot] in [+] bump actions/setup-python from 5 to 6 #938
• [+] bump actions/stale from 9 to 10 by @dependabot[bot] in [+] bump actions/stale from 9 to 10 #937
• [+] bump docker/docker from 28.3.2 to 28.3.3 by @dependabot[bot] in [+] bump docker/docker from 28.3.2 to 28.3.3 #872
• [+] bump go.etcd.io/etcd/client/v3 from 3.6.2 to 3.6.4 by @dependabot[bot] in [+] bump go.etcd.io/etcd/client/v3 from 3.6.2 to 3.6.3 #858 [+] bump go.etcd.io/etcd/client/v3 from 3.6.3 to 3.6.4 #868
• [+] bump golang-jwt/jwt/v5 from 5.2.3 to 5.3.0 by @dependabot[bot] in [+] bump golang-jwt/jwt/v5 from 5.2.3 to 5.3.0 #876
• [+] bump google.golang.org/grpc from 1.73.0 to 1.75.0 by @dependabot[bot] in [+] bump google.golang.org/grpc from 1.73.0 to 1.74.2 #865 [+] bump google.golang.org/grpc from 1.74.2 to 1.75.0 #902
• [+] bump google.golang.org/protobuf from 1.36.6 to 1.36.8 by @dependabot[bot] in [+] bump google.golang.org/protobuf from 1.36.6 to 1.36.7 #887 [+] bump google.golang.org/protobuf from 1.36.7 to 1.36.8 #904
• [+] bump prometheus/client_golang from 1.22.0 to 1.23.2 by @dependabot[bot] in [+] bump prometheus/client_golang from 1.22.0 to 1.23.0 #878 [+] bump prometheus/client_golang from 1.23.0 to 1.23.2 #941
• [+] bump shirou/gopsutil/v4 from 4.25.6 to 4.25.8 by @dependabot[bot] in [+] bump shirou/gopsutil/v4 from 4.25.6 to 4.25.7 #877 [+] bump shirou/gopsutil/v4 from 4.25.7 to 4.25.8 #923
• [+] bump stretchr/testify from 1.10.0 to 1.11.1 by @dependabot[bot] in [+] bump stretchr/testify from 1.10.0 to 1.11.0 #906 [+] bump stretchr/testify from 1.11.0 to 1.11.1 #912
• [+] bump webui/react-scripts to v5.0.1 (pinned version) by @pashagolub in [+] bump webui/react-scripts to v5.0.1 (pinned version) #866
• [+] improve "Global Database Overview" dashboard by @pashagolub in [+] improve "Global Database Overview" dashboard #869
• [+] improve change_events metric processing by @pashagolub in [+] improve change_events metric processing #932
• [+] improve development experience with docker compose by @pashagolub in [+] improve development experience with docker compose #927
• [+] update docs with new v12 dashboards screenshots by @pashagolub in [+] update docs with new v12 dashboards screenshots #943
• [*] add note in sizing docs about metrics returning thousands of rows by @0xgouda in [*] add note in sizing docs about metrics returning thousands of rows #874
• [*] clarify the usage of docker compose, closes Docker-compose issues when building a project #879 by @pashagolub in [*] clarify the usage of docker compose, closes #879 #880
• [*] fix updateSources() query parameters number by @0xgouda in [*] fix updateSources() query parameters number #875
• [*] mention pgwatch-contrib/rpc in docs by @0xgouda in [*] mention pgwatch-contrib/rpc in docs #922
• [*] misc minor updates to docs by @0xgouda in [*] misc minor updates to docs #871
• [*] remove hard coded metric defs from docs by @0xgouda in [*] remove hard coded metric defs from docs #870
• [*] update docs for metrics yaml folder configs by @0xgouda in [*] update docs for metrics yaml folder configs #892
• [-] do not fail on db resolve error, just log an error, fixes Single faulty host with postgres-continuous-discovery breaks metrics collection for all hosts #890 by @pashagolub in [-] do not fail on db resolve error, just log an error, fixes #890 #899
• [-] fix source YAML test introduced by [+] add sample metrics YAML file, closes #883 #900 by @pashagolub in [-] fix source YAML test introduced by #900 #901
• [-] move to next envelope in Postgres sink if COPY fails, fixes Panic: runtime error: index out of range [6] when COPY encounters NaN value from get_psutil_mem() #908 by @pashagolub in [-] move to next envelope in Postgres sink if COPY fails, fixes #908 #911
• [-] remove host_config querying from GetSources() by @0xgouda in [-] remove host_config querying from GetSources() #863
• [-] remove double "git checkout" from "README.md" by @smiyc in [docs]: remove doulbe "git checkout" from README.md #942

New Contributors

• @smiyc made their first contribution in [docs]: remove doulbe "git checkout" from README.md #942

Full Changelog: v3.7.0...v4.0.0-beta

---

This discussion was created from the release v4.0.0-beta.