Merge remote-tracking branch 'upstream/development' into github439

CrunchyData · Jan 8, 2025 · 069d720 · 069d720
2 parents 55a31e1 + e071152
commit 069d720
Show file tree

Hide file tree

Showing 96 changed files with 200 additions and 132 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,7 +3,7 @@ default_install_hook_types:
   - pre-commit
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.6.0
+  rev: v5.0.0
   hooks:
     - id: check-merge-conflict
     - id: check-symlinks
@@ -21,7 +21,7 @@ repos:
       stages: [commit-msg]
       additional_dependencies: ['@commitlint/config-conventional']
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.1.0
+  rev: v2.3.0
   hooks:
     - id: codespell
       # if you need to add more words to ignore, they are comme separated

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,6 +4,26 @@ pgMonitor Release Notes
 
 .. contents:: Topics
 
+v4.12.0
+=======
+
+Release Summary
+---------------
+
+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.
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- 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.
+
+Bugfixes
+--------
+
+- grafana - Fix etcd dashboard to use new metric names in etcd 3.5
+- postgres_exporter - Fix query for database table size to remove duplicate word
+- postgres_exporter - Fix query for pgBackRest monitoring to handle 3 number versions
+
 
 v5.1.1
 ======

diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ Please view the official Crunchy Data pgMonitor documentation [here](https://acc
 
 ## Legal Notices
 
-Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 
 CRUNCHY DATA SOLUTIONS, INC. PROVIDES THIS GUIDE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 

diff --git a/alertmanager/common/crunchy-alertmanager.yml b/alertmanager/common/crunchy-alertmanager.yml
@@ -1,6 +1,6 @@
 ###
 #
-# Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+# Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 #
 ###
 

diff --git a/alertmanager/linux/crunchy-alertmanager-service-rhel.conf b/alertmanager/linux/crunchy-alertmanager-service-rhel.conf
@@ -1,6 +1,6 @@
 ###
 #
-# Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+# Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 #
 ###
 

diff --git a/alertmanager/linux/sysconfig.alertmanager b/alertmanager/linux/sysconfig.alertmanager
@@ -1,6 +1,6 @@
 ###
 #
-# Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+# Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 #
 ###
 

diff --git a/blackbox_exporter/common/blackbox_exporter.sysconfig b/blackbox_exporter/common/blackbox_exporter.sysconfig
@@ -1,6 +1,6 @@
 ###
 #
-# Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+# Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 #
 ###
 

diff --git a/blackbox_exporter/common/crunchy-blackbox.yml b/blackbox_exporter/common/crunchy-blackbox.yml
@@ -1,6 +1,6 @@
 ###
 #
-# Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+# Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 #
 ###
 

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -1,5 +1,6 @@
 ancestor: null
 releases:
+
   4.10.0:
     changes:
       major_changes:
@@ -207,3 +208,24 @@ releases:
     - 435.yml
     - release_summary.yml
     release_date: '2024-10-04'
+  4.12.0:
+    changes:
+      breaking_changes:
+      - 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.
+      bugfixes:
+      - grafana - Fix etcd dashboard to use new metric names in etcd 3.5
+      - postgres_exporter - Fix query for database table size to remove duplicate
+        word
+      - postgres_exporter - Fix query for pgBackRest monitoring to handle 3 number
+        versions
+      release_summary: 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.
+    fragments:
+    - 412_release.yml
+    - 425.yml
+    - 441.yml
+    release_date: '2024-11-04'
diff --git a/changelogs/fragments/448.yml b/changelogs/fragments/448.yml
@@ -0,0 +1,3 @@
+---
+trivial:
+  - documentation - Update copyright year
diff --git a/changelogs/fragments/package_docs.yml b/changelogs/fragments/package_docs.yml
@@ -0,0 +1,3 @@
+---
+trivial:
+  - documentation - Make documentation around package vs non-package installs more clear and consistent. Remove postgres_exporter file references from PG Metrics list.
diff --git a/grafana/common/crunchy_grafana_dashboards.yml b/grafana/common/crunchy_grafana_dashboards.yml
@@ -1,6 +1,6 @@
 ###
 #
-# Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+# Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 #
 ###
 apiVersion: 1

diff --git a/grafana/common/crunchy_grafana_datasource.yml b/grafana/common/crunchy_grafana_datasource.yml
@@ -1,6 +1,6 @@
 ###
 #
-# Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+# Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 #
 ###
 

diff --git a/grafana/containers/crunchy_grafana_dashboards.yml b/grafana/containers/crunchy_grafana_dashboards.yml
@@ -1,6 +1,6 @@
 ###
 #
-# Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+# Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 #
 ###
 apiVersion: 1

diff --git a/grafana/containers/crunchy_grafana_datasource.yml b/grafana/containers/crunchy_grafana_datasource.yml
@@ -1,6 +1,6 @@
 ###
 #
-# Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+# Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 #
 ###
 

diff --git a/hugo/content/_index.md b/hugo/content/_index.md
@@ -96,7 +96,7 @@ For the [full history](/changelog) of pgMonitor, please see the [CHANGELOG](/cha
 
 ## Legal Notices
 
-Copyright © 2017-2024 Crunchy Data Solutions, Inc. All Rights Reserved.
+Copyright © 2017-2025 Crunchy Data Solutions, Inc. All Rights Reserved.
 
 CRUNCHY DATA SOLUTIONS, INC. PROVIDES THIS GUIDE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 

diff --git a/hugo/content/changelog/_index.md b/hugo/content/changelog/_index.md
@@ -4,6 +4,26 @@ draft: false
 weight: 5
 ---
 
+## v4.12.0
+
+Release Summary
+---------------
+
+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.
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- 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.
+
+Bugfixes
+--------
+
+- grafana - Fix etcd dashboard to use new metric names in etcd 3.5
+- postgres_exporter - Fix query for database table size to remove duplicate word
+- postgres_exporter - Fix query for pgBackRest monitoring to handle 3 number versionso
+
+
 ## v5.1.1
 
 ### Release Summary

diff --git a/hugo/content/exporter/_index.md b/hugo/content/exporter/_index.md
@@ -8,43 +8,44 @@ The Linux instructions below use RHEL, but any Linux-based system should work. [
 
 
 - [Installation](#installation)
-   - [RPM installs](#rpm-installs)
-   - [Non-RPMs installs](#non-rpm-installs)
+   - [Package Install](#package-install)
+   - [Non-Package Install](#non-package-install)
 - [Upgrading](#upgrading)
 - [Setup](#setup)
-   - [RHEL or CentOS](#setup-on-rhel-or-centos)
+   - [RHEL](#setup-on-rhel)
 - [Metrics Collected](#metrics-collected)
    - [PostgreSQL](#postgresql)
    - [System](#system)
 - [Legacy postgres_exporter Setup](#postgres-exporter)
 
 
-IMPORTANT NOTE: As of pgMonitor version 5.0.0, postgres_exporter has been deprecated in favor of sql_exporter. Support for postgres_exporter is still possible with 5.0, but only for bug fixes while custom queries are still supported. No new features will be added using postgres_exporter and it will be fully obsoleted in a future version of pgMonitor. We recommend migrating to sql_exporter as soon as possible.
+IMPORTANT NOTE: As of pgMonitor version 5.0.0, postgres_exporter has been deprecated in favor of sql_exporter. Support for postgres_exporter is still possible with 5.0, but only for bug fixes while custom queries are still supported upstream. No new features will be added using postgres_exporter and it will be fully obsoleted in a future version of pgMonitor. We recommend migrating to sql_exporter as soon as possible.
 
 ## Installation {#installation}
 
 
-### RPM installs {#rpm-installs}
+### Package Install {#package-install}
 
 The following RPM packages are available to [Crunchy Data](https://www.crunchydata.com) customers through the [Crunchy Customer Portal](https://access.crunchydata.com/). To access the pgMonitor packages, please follow the same instructions for setting up access to the Crunchy Postgres packages.
 
 After installing via these packages, continue reading at the [Setup](#setup) section.
 
-##### Available Packages
+#### Available Packages
 
-| Package Name                   | Description                                                               |
-|--------------------------------|---------------------------------------------------------------------------|
-| blackbox-exporter              | Package for the blackbox_exporter                                         |
-| node-exporter                  | Base package for node_exporter                                            |
-| pg-bloat-check                 | Package for pg_bloat_check script                                         |
-| pgmonitor-node_exporter-extras | Crunchy-optimized configurations for node_exporter                        |
-| pgmonitor-pg##-extension       | Crunchy monitoring PostgreSQL extension used by sql_exporter              |
-| sql-exporter                   | Base package for sql_exporter                                             |
-| sql-exporter-extras            | Crunchy-optimized configurations for sql_exporter                         |
+| Package Name                          | Description                                                               |
+|---------------------------------------|---------------------------------------------------------------------------|
+| blackbox-exporter                     | Package for the blackbox_exporter                                         |
+| pgmonitor-blackbox-exporter-extras    | Crunchy-optimized configurations for blackbox_exporter                    |
+| node-exporter                         | Base package for node_exporter                                            |
+| pg-bloat-check                        | Package for pg_bloat_check script                                         |
+| pgmonitor-node_exporter-extras        | Crunchy-optimized configurations for node_exporter                        |
+| pgmonitor-pg##-extension              | Crunchy monitoring PostgreSQL extension used by sql_exporter              |
+| sql-exporter                          | Base package for sql_exporter                                             |
+| pgmonitor-sql-exporter-extras         | Crunchy-optimized configurations for sql_exporter                         |
 
 
 
-### Non-RPM installs {#non-rpm-installs}
+### Non-Package Install {#non-package-install}
 
 For non-package installations on Linux, applications can be downloaded from their respective repositories:
 
@@ -127,7 +128,7 @@ Note that blackbox_exporter is typically installed on the Prometheus node and do
 
 ## Setup {#setup}
 
-### Setup on RHEL or CentOS {#setup-on-rhel-or-centos}
+### Setup on RHEL {#setup-on-rhel}
 
 #### Service Configuration
 
@@ -332,7 +333,7 @@ PostgreSQL metrics are collected by [sql_exporter](https://github.com/burningalc
 
 #### Common Metrics
 
-Metrics contained in the `queries_global.yml` file. These metrics are common to all versions of PostgreSQL and are recommended as a minimum default for the global exporter.
+These metrics are common to all versions of PostgreSQL and are recommended as a minimum default for the global exporter exporter connection.
 
  * *ccp_archive_command_status_seconds_since_last_fail* - Seconds since the last `archive_command` run failed. If zero, the `archive_command` is succeeding without error.
 
@@ -429,15 +430,15 @@ The following `ccp_stat_database_*` metrics are statistics collected from the [p
 
 #### PostgreSQL Version Specific Metrics
 
-The following metrics either require special considerations when monitoring specific versions of PostgreSQL, or are only available for specific versions. These metrics are found in the `queries_pg##.yml` files, where ## is the major version of PG. Unless otherwise noted, the below metrics are available for all versions of PG. These metrics are recommend as a minimum default for the global exporter.
+The following metrics either require special considerations when monitoring specific versions of PostgreSQL, or are only available for specific versions.  Unless otherwise noted, the below metrics are available for all versions of PG. These metrics are recommend as a minimum default for the global exporter.
 
  * *ccp_data_checksum_failure_count* - PostgreSQL 12 and later only. Total number of checksum failures on this database.
 
  * *ccp_data_checksum_failure_time_since_last_failure_seconds* - PostgreSQL 12 and later only. Time interval in seconds since the last checksum failure was encountered.
 
 #### Backup Metrics
 
-Backup monitoring only covers pgBackRest at this time. These metrics are found in the `queries_backrest.yml` file. These metrics only need to be collected once per database instance so should be collected by the global postgres_exporter.
+Backup monitoring only covers pgBackRest at this time. These metrics only need to be collected once per PostgreSQL instance so should be collected by the global exporter connection.
 
  * *ccp_backrest_last_full_backup_time_since_completion_seconds* - Time since completion of last pgBackRest FULL backup
 
@@ -455,7 +456,7 @@ Backup monitoring only covers pgBackRest at this time. These metrics are found i
 
 #### Per-Database Metrics
 
-These are metrics that are only available on a per-database level. These metrics are found in the `queries_per_db.yml` file. These metrics are optional and recommended for the non-global, per-db postgres_exporter. They can be included in the global exporter as well if the global database needs per-database metrics monitored. Please note that depending on the number of objects in your database, collecting these metrics can greatly increase the storage requirements for Prometheus since all of these metrics are being collected for each individual object.
+These are metrics that are only available on a per-database level. These metrics are optional and recommended for the non-global, per-db exporter connection. They can be included in the global exporter as well if the global database needs per-database metrics monitored. Please note that depending on the number of objects in your database, collecting these metrics can greatly increase the storage requirements for Prometheus since all of these metrics are being collected for each individual object.
 
  * *ccp_table_size_size_bytes* - Table size inclusive of all indexes in that table
 
@@ -477,7 +478,7 @@ The following `ccp_stat_user_tables_*` metrics are statistics collected from the
 
 #### Bloat Metrics
 
-Bloat metrics are only available if the `pg_bloat_check` script has been setup to run. See instructions above. These metrics are found in the `queries_bloat.yml` file. These metrics are per-database so, should be used by the per-db postgres_exporter.
+Bloat metrics are only available if the `pg_bloat_check` script has been setup to run. See instructions above. These metrics are per-database so, should be used by the per-db exporter connection.
 
  * *ccp_bloat_check_size_bytes* - Size of object in bytes
 
@@ -533,7 +534,7 @@ There are many other suggestions, projects, and exporters out there that can pro
 
 ## Legacy postgres_exporter Setup {#postgres-exporter}
 
-If you had been using pgMonitor prior to version 5.0.0, postgres_exporter was the method used to collect PostgreSQL metrics. This exporter can still be used with 5.0.0, but there are some additional steps required. It is HIGHLY recommended to switch to using sql_exporter as soon as possible. Custom query support will be dropped from postgres_exporter at some point in the future and that will break pgMonitor since it relies solely on custom queries. No new features of pgMonitor are being developed around postgres_exporter.
+If you had been using pgMonitor prior to version 5.0.0, postgres_exporter was the method used to collect PostgreSQL metrics. This exporter can still be used with 5.0.0, but there are some additional steps required and it will be deprecated in the near future. It is HIGHLY recommended to switch to using sql_exporter as soon as possible. Custom query support will be dropped from postgres_exporter at some point in the future and that will break pgMonitor since it relies solely on custom queries. No new features of pgMonitor are being developed around postgres_exporter.
 
 Most of the installation steps are the same as above with the below differences for the relevant sections.
 

diff --git a/hugo/content/grafana/_index.md b/hugo/content/grafana/_index.md
@@ -6,10 +6,11 @@ weight: 3
 
 - [Included Dashboards](#dashboards)
 - [Installation](#installation)
-    - [Linux](#linux)
+    - [Package Install](#package-install)
+    - [Non-Package Install](#non-package-install)
 - [Upgrading](#upgrading)
 - [Setup](#setup)
-    - [Linux](#setup-on-linux)
+    - [RHEL](#setup-on-linux)
 
 ### Included Dashboards {#dashboards}
 
@@ -40,9 +41,7 @@ pgMonitor comes with several dashboards ready to be used with automatic provisio
 
 ## Installation {#installation}
 
-### Linux {#linux}
-
-#### With RPM Packages
+### Package Install {#package-install}
 
 There are RPM packages available to [Crunchy Data](https://www.crunchydata.com) customers through the [Crunchy Customer Portal](https://access.crunchydata.com/). To access the pgMonitor packages, please follow the same instructions for setting up access to the Crunchy Postgres packages.
 
@@ -56,14 +55,15 @@ If you install the below available packages, you can continue reading at the [Se
 | pgmonitor-grafana-extras-common               | Crunchy files common for all Grafana installations (Ex. datasource & dashboard provisioning)      |
 | pgmonitor-grafana-extras-etcd                 | Crunchy dashboards for etcd (etcd built-in exporter)                                              |
 | pgmonitor-grafana-extras-linux                | Crunchy dashboards for Linux OS metrics (node_exporter)                                           |
+| pgmonitor-grafana-extras-haproxy              | Crunchy dashboards for HAProxy (built-in exporter)                                           |
 | pgmonitor-grafana-extras-pg                   | Crunchy dashboards for PostgreSQL metrics common to all PG exporters                              |
 | pgmonitor-grafana-extras-pg-postgres-exporter | Crunchy dashboards for metrics provided by postgres_exporter (see version 5 upgrade for deprecation notice) |
 | pgmonitor-grafana-extras-pg-sql-exporter      | Crunchy dashboards for metrics provided by the sql_exporter                                       |
 | pgmonitor-grafana-extras-pgbouncer-direct     | Crunchy dashboards for PgBouncer metrics collected directly from bouncer via the sql_exporter     |
 | pgmonitor-grafana-extras-pgbouncer-fdw        | Crunchy dashboards for PgBouncer metrics collected via the pgbouncer_fdw                          |
 | pgmonitor-grafana-extras-prometheus           | Crunchy dashboards for proividing direct Prometheus visualization (alerting)                      |
 
-#### Without Packages
+### Non-Package Install {#non-package-install}
 
 Create the following directories on your grafana server if they don't exist:
 
@@ -94,7 +94,7 @@ Please note that due to the change from postgres_exporter to sql_exporter, and i
 
 ## Setup {#setup}
 
-### Setup on Linux {#setup-on-linux}
+### Setup on RHEL {#setup-on-linux}
 
 #### Configuration Database