Skip to content

Commit 714a65a

Browse files
keithf4hunleyd
andauthored
docs: update changelog and docs for 5.2 (#462)
* docs: update changelog and docs for 5.2 * Update hugo/content/exporter/_index.md Co-authored-by: Douglas J Hunley <[email protected]> --------- Co-authored-by: Douglas J Hunley <[email protected]>
1 parent dddc7d4 commit 714a65a

File tree

13 files changed

+140
-80
lines changed

13 files changed

+140
-80
lines changed

CHANGELOG.rst

Lines changed: 46 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,41 @@ pgMonitor Release Notes
44

55
.. contents:: Topics
66

7-
v4.12.0
8-
=======
7+
v5.2.0
8+
======
99

1010
Release Summary
1111
---------------
1212

13-
Crunchy Data is pleased to announce the availability of pgMonitor 4.12.0. This release primarily brings support for Grafana 10.4. See Changelog for additional information.
13+
Crunchy Data is pleased to announce the availability of pgMonitor 5.2.0. This release brings support for the latest pgmonitor extension version 2.1.0 and many bug fixes.
1414

15-
Breaking Changes / Porting Guide
16-
--------------------------------
15+
Major Changes
16+
-------------
1717

18-
- grafana - Update the dashboards to support Grafana 10.4 so that we're on an officially supported version of Grafana. This does potentially break backward compatibility with Grafana 9.x, so an update to Grafana 10.4 will be required with this version of pgMonitor.
18+
- sql_exporter - Updated metric queries for pgmonitor-extension 2.1.0
19+
20+
Minor Changes
21+
-------------
22+
23+
- grafana - Improve Query Statistics dashboard to more accurately report lifetime vs time range statistics
24+
- grafana - Removed the `Last Backup Size (Total)` panel from the pgBackRest Grafana dashboard since it was backed by the removed metric.
25+
- postgres_exporter - Removed the metric `ccp_backrest_last_info_repo_total_size_bytes`.
26+
- prometheus - Added new alerts to monitor the new metrics for the minimum required version of the pgmonitor extension
27+
- sql_exporter - Add additional metrics for monitoring replication slot status. For PG16+ monitor for conflicts. For PG17+, monitor synced and failover status.
28+
- sql_exporter - Add scrape_error_drop_interval setting to the configuration example
29+
- sql_exporter - Added new metrics to monitor pgmonitor-extension version. - `ccp_pgmonitor_extension_global_version` - shows the currently installed version of the extension on the global database as an integer - `ccp_pgmonitor_extension_per_db_version` - shows the currently installed version of the extension on each monitored user database as an integer - `ccp_pgmonitor_extension_global_min_version_installed` - shows whether the currently installed version of the extension is the minimum required for this version of pgMonitor on the global database (0 true, 1 false) - `ccp_pgmonitor_extension_per_db_min_version_installed` - shows whether the currently installed version of the extension is the minimum required for this version of pgMonitor on each monitored user database (0 true, 1 false)
30+
- sql_exporter - Removed the metric `ccp_backrest_last_info_repo_total_size_bytes`. When block incremental backups are enabled, this metric is no longer available from pgBackRest.
1931

2032
Bugfixes
2133
--------
2234

23-
- grafana - Fix etcd dashboard to use new metric names in etcd 3.5
24-
- postgres_exporter - Fix query for database table size to remove duplicate word
25-
- postgres_exporter - Fix query for pgBackRest monitoring to handle 3 number versions
26-
35+
- grafana - Fix Cache Hit Ratio panel on PG Details dashboard to always be lines. Depending on data returned was sometimes being shown as points.
36+
- grafana - Fix pgBackRest recovery window panel showing multiple values after a PostgreSQL switchover
37+
- postgres_exporter - Disable all collectors included with postgres_exporter by default in example configuration. The other options to disable default metrics are not applied to the new collections.
38+
- postgres_exporter - Fix the `ccp_table_size_size_bytes` metric to remove the duplicate word and just be `ccp_table_size_bytes`
39+
- sql_exporter - Fix the `ccp_table_size_size_bytes` metric to remove the duplicate word and just be `ccp_table_size_bytes`
40+
- sql_exporter - Fix the names of ccp_pgbouncer_database_db_conn_perc_used, ccp_pgbouncer_database_paused, ccp_pgbouncer_database_disabled, and ccp_pgbouncer_list_item_count to be consistent with the old metric names from postgres exporter. These new names are the ones expected in the Grafana dashboard so this change fixes that to work properly again.
41+
- sql_exporter - Removed extraneous double quote at the end of the pgbouncer fdw collector file
2742

2843
v5.1.1
2944
======
@@ -46,7 +61,6 @@ Release Summary
4661

4762
Crunchy Data is pleased to announce the availability of pgMonitor 5.1.0. This release brings support for PostgreSQL 17. It also brings more flexible Grafana dashboards, an HAProxy dashboard and better support for etcd and pgBackRest.
4863

49-
5064
Major Changes
5165
-------------
5266

@@ -56,7 +70,7 @@ Major Changes
5670
Minor Changes
5771
-------------
5872

59-
- grafana - Add a new variable dropdown to all dashboards for the Datasource. Allows more flexiblity when importing the dashboard to different environments.
73+
- grafana - Add a new variable dropdown to all dashboards for the Datasource. Allows more flexibility when importing the dashboard to different environments.
6074
- grafana - Add panel to PG Details dashboard to track autovac workers running vs max
6175
- grafana - add a dashboard for HAProxy
6276
- sql_exporter - Add metrics to track current autovacuum workers running and max autovacuum workers
@@ -104,6 +118,26 @@ Bugfixes
104118
- sql_exporter - add new metric for n_tup_newpage_upd
105119
- sql_exporter - use the new views from pgmonitor-extension instead of full queries
106120

121+
v4.12.0
122+
=======
123+
124+
Release Summary
125+
---------------
126+
127+
Crunchy Data is pleased to announce the availability of pgMonitor 4.12.0. This release primarily brings support for Grafana 10.4. See Changelog for additional information.
128+
129+
Breaking Changes / Porting Guide
130+
--------------------------------
131+
132+
- grafana - Update the dashboards to support Grafana 10.4 so that we're on an officially supported version of Grafana. This does potentially break backward compatibility with Grafana 9.x, so an update to Grafana 10.4 will be required with this version of pgMonitor.
133+
134+
Bugfixes
135+
--------
136+
137+
- grafana - Fix etcd dashboard to use new metric names in etcd 3.5
138+
- postgres_exporter - Fix query for database table size to remove duplicate word
139+
- postgres_exporter - Fix query for pgBackRest monitoring to handle 3 number versions
140+
107141
v4.11.0
108142
=======
109143

changelogs/changelog.yaml

Lines changed: 81 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
ancestor: null
22
releases:
3-
43
4.10.0:
54
changes:
65
major_changes:
@@ -39,6 +38,27 @@ releases:
3938
- 378.yml
4039
- release.yml
4140
release_date: '2024-01-24'
41+
4.12.0:
42+
changes:
43+
breaking_changes:
44+
- grafana - Update the dashboards to support Grafana 10.4 so that we're on an
45+
officially supported version of Grafana. This does potentially break backward
46+
compatibility with Grafana 9.x, so an update to Grafana 10.4 will be required
47+
with this version of pgMonitor.
48+
bugfixes:
49+
- grafana - Fix etcd dashboard to use new metric names in etcd 3.5
50+
- postgres_exporter - Fix query for database table size to remove duplicate
51+
word
52+
- postgres_exporter - Fix query for pgBackRest monitoring to handle 3 number
53+
versions
54+
release_summary: Crunchy Data is pleased to announce the availability of pgMonitor
55+
4.12.0. This release primarily brings support for Grafana 10.4. See Changelog
56+
for additional information.
57+
fragments:
58+
- 412_release.yml
59+
- 425.yml
60+
- 441.yml
61+
release_date: '2024-11-04'
4262
4.8.0:
4363
changes:
4464
bugfixes:
@@ -167,7 +187,7 @@ releases:
167187
- sql_exporter - add support for PG17
168188
minor_changes:
169189
- grafana - Add a new variable dropdown to all dashboards for the Datasource.
170-
Allows more flexiblity when importing the dashboard to different environments.
190+
Allows more flexibility when importing the dashboard to different environments.
171191
- grafana - Add panel to PG Details dashboard to track autovac workers running
172192
vs max
173193
- grafana - add a dashboard for HAProxy
@@ -208,24 +228,66 @@ releases:
208228
- 435.yml
209229
- release_summary.yml
210230
release_date: '2024-10-04'
211-
4.12.0:
231+
5.2.0:
212232
changes:
213-
breaking_changes:
214-
- grafana - Update the dashboards to support Grafana 10.4 so that we're on an
215-
officially supported version of Grafana. This does potentially break backward
216-
compatibility with Grafana 9.x, so an update to Grafana 10.4 will be required
217-
with this version of pgMonitor.
218233
bugfixes:
219-
- grafana - Fix etcd dashboard to use new metric names in etcd 3.5
220-
- postgres_exporter - Fix query for database table size to remove duplicate
221-
word
222-
- postgres_exporter - Fix query for pgBackRest monitoring to handle 3 number
223-
versions
234+
- grafana - Fix Cache Hit Ratio panel on PG Details dashboard to always be lines.
235+
Depending on data returned was sometimes being shown as points.
236+
- grafana - Fix pgBackRest recovery window panel showing multiple values after
237+
a PostgreSQL switchover
238+
- postgres_exporter - Disable all collectors included with postgres_exporter
239+
by default in example configuration. The other options to disable default
240+
metrics are not applied to the new collections.
241+
- postgres_exporter - Fix the `ccp_table_size_size_bytes` metric to remove the
242+
duplicate word and just be `ccp_table_size_bytes`
243+
- sql_exporter - Fix the `ccp_table_size_size_bytes` metric to remove the duplicate
244+
word and just be `ccp_table_size_bytes`
245+
- sql_exporter - Fix the names of ccp_pgbouncer_database_db_conn_perc_used,
246+
ccp_pgbouncer_database_paused, ccp_pgbouncer_database_disabled, and ccp_pgbouncer_list_item_count
247+
to be consistent with the old metric names from postgres exporter. These new
248+
names are the ones expected in the Grafana dashboard so this change fixes
249+
that to work properly again.
250+
- sql_exporter - Removed extraneous double quote at the end of the pgbouncer
251+
fdw collector file
252+
major_changes:
253+
- sql_exporter - Updated metric queries for pgmonitor-extension 2.1.0
254+
minor_changes:
255+
- grafana - Improve Query Statistics dashboard to more accurately report lifetime
256+
vs time range statistics
257+
- grafana - Removed the `Last Backup Size (Total)` panel from the pgBackRest
258+
Grafana dashboard since it was backed by the removed metric.
259+
- postgres_exporter - Removed the metric `ccp_backrest_last_info_repo_total_size_bytes`.
260+
- prometheus - Added new alerts to monitor the new metrics for the minimum required
261+
version of the pgmonitor extension
262+
- sql_exporter - Add additional metrics for monitoring replication slot status.
263+
For PG16+ monitor for conflicts. For PG17+, monitor synced and failover status.
264+
- sql_exporter - Add scrape_error_drop_interval setting to the configuration
265+
example
266+
- sql_exporter - Added new metrics to monitor pgmonitor-extension version. -
267+
`ccp_pgmonitor_extension_global_version` - shows the currently installed version
268+
of the extension on the global database as an integer - `ccp_pgmonitor_extension_per_db_version`
269+
- shows the currently installed version of the extension on each monitored
270+
user database as an integer - `ccp_pgmonitor_extension_global_min_version_installed`
271+
- shows whether the currently installed version of the extension is the minimum
272+
required for this version of pgMonitor on the global database (0 true, 1 false)
273+
- `ccp_pgmonitor_extension_per_db_min_version_installed` - shows whether the
274+
currently installed version of the extension is the minimum required for this
275+
version of pgMonitor on each monitored user database (0 true, 1 false)
276+
- sql_exporter - Removed the metric `ccp_backrest_last_info_repo_total_size_bytes`.
277+
When block incremental backups are enabled, this metric is no longer available
278+
from pgBackRest.
224279
release_summary: Crunchy Data is pleased to announce the availability of pgMonitor
225-
4.12.0. This release primarily brings support for Grafana 10.4. See Changelog
226-
for additional information.
280+
5.2.0. This release brings support for the latest pgmonitor extension version
281+
2.1.0 and many bug fixes.
227282
fragments:
228-
- 412_release.yml
229-
- 425.yml
230-
- 441.yml
231-
release_date: '2024-11-04'
283+
- 431.yml
284+
- 434.yml
285+
- 437.yml
286+
- 439.yml
287+
- 448.yml
288+
- 449.yml
289+
- 456.yml
290+
- 459.yml
291+
- package_docs.yml
292+
- release.yml
293+
release_date: '2025-03-25'

changelogs/fragments/431.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/434.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/437.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/439.yml

Lines changed: 0 additions & 4 deletions
This file was deleted.

changelogs/fragments/448.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/449.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/456.yml

Lines changed: 0 additions & 15 deletions
This file was deleted.

changelogs/fragments/459.yml

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)