Merge pull request #5596 from EnterpriseDB/content/docs/pem/9.6_release

PEM - 9.6 Release branch
EnterpriseDB · May 15, 2024 · 2446f13 · 2446f13 · github-actions · May 15, 2024
2 parents 2303484 + 2a0395a
commit 2446f13
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 5 deletions.
diff --git a/product_docs/docs/pem/9/installing/dependencies.mdx b/product_docs/docs/pem/9/installing/dependencies.mdx
@@ -46,6 +46,8 @@ Python 3 and mod_wsgi (a Python module for Apache HTTPD) are required for PEM Se
 | Ubuntu 20 | amd64        | `edb-python310/edb-python310-mod-wsgi` | 3.10           | `/usr/libexec/edb-python310/bin/python3` |
 | Ubuntu 22 | amd64        | `python310//libapache2-mod-wsgi-py3`   | 3.10           | `/usr/bin/python3`                       |
 | Debian 10 | amd64        | `edb-python310/edb-python310-mod-wsgi` | 3.10           | `/usr/libexec/edb-python310/bin/python3` |
+| Debian 11 | amd64        | `edb-python310/edb-python310-mod-wsgi` | 3.10           | `/usr/libexec/edb-python310/bin/python3` |
+| Debian 12 | amd64/arm64  | `python311/libapache2-mod-wsgi-py3`     | 3.11           | `/usr/bin/python3`                       |
 
 ## OpenSSL
 
@@ -70,6 +72,8 @@ The PEM Server and Agent require OpenSSL.
 | Ubuntu 20 | amd64        | `openssl-1.1.1f`  |
 | Ubuntu 22 | amd64        | `openssl-3.0.2`   |
 | Debian 10 | amd64        | `openssl-1.1.1n`  |
+| Debian 11 | amd64        | `openssl-1.1.1w`  |
+| Debian 12 | amd64/arm64  | `openssl-3.0.11`  |
 
 ## Libcurl
 
@@ -94,6 +98,8 @@ The PEM Agent requires libcurl.
 | Ubuntu 20 | amd64        | `libcurl4-7.68.0`   |
 | Ubuntu 22 | amd64        | `libcurl4-7.81.0`   |
 | Debian 10 | amd64        | `libcurl4-7.64.0`   |
+| Debian 11 | amd64        | `libcurl4-7.74.0`   |
+| Debian 12 | amd64/arm64  | `libcurl4-7.88.1`   |
 
 ## SNMP++
 
@@ -118,6 +124,8 @@ The PEM Agent requires SNMP++.
 | Ubuntu 20 | amd64        | `edb-snmp++-3.4.10` |
 | Ubuntu 22 | amd64        | `edb-snmp++-3.4.10` |
 | Debian 10 | amd64        | `edb-snmp++-3.4.10` |
+| Debian 11 | amd64        | `edb-snmp++-3.4.10` |
+| Debian 12 | amd64/arm64  | `edb-snmp++-3.4.10` |
 
 ## Boost libraries
 
@@ -141,4 +149,6 @@ The PEM Agent requires the Boost libraries.
 |           | s390x        | `libboost_regex1_66_1-1.66.0`  |
 | Ubuntu 20 | amd64        | `libboost-system1.71.0-1.71.0` |
 | Ubuntu 22 | amd64        | `libboost-system1.74.0-1.74.0` |
-| Debian 10 | amd64        | `libboost-system1.67.0-1.67.0` |
+| Debian 10 | amd64        | `libboost-system1.67.0-1.67.0` |
+| Debian 11 | amd64        | `libboost-system1.74.0-1.74.0` |
+| Debian 12 | amd64/arm64  | `libboost-system1.74.0-1.74.0` |
diff --git a/product_docs/docs/pem/9/monitoring_performance/alerts.mdx b/product_docs/docs/pem/9/monitoring_performance/alerts.mdx
@@ -323,7 +323,11 @@ The tables that follow list the system-defined alert templates that you can use
 | PGD Group Raft Consensus                                                    | PGD group raft consensus not working                                                                                                            | bdr_monitor_group_raft                                  |
 | PGD Group Raft Leader ID not matching                                       | PGD group raft leader id not matching                                                                                                           | bdr_group_raft_details                                  |
 | PGD Group versions check                                                    | PGD/pglogical version mismatched in PGD group                                                                                                   | bdr_monitor_group_raft                                  |
+| PGD worker error detected                                                   | PGD worker error detected reported for PGD node                 | | |
 | Transaction ID exhaustion (wraparound)                                      | Check for Transaction ID exhaustion (wraparound)                                                                                                |                                   |
+| Inactive replication slots                                                  | Check for slots which are inactive for a particular server   | | |
+| Conflicting replication slots                                               | Check for slots which are conflicting for a particular server   | | |
+| Multixact ID exhaustion (wraparound)                                        | Check for Multixact ID exhaustion (wraparound)               | | |
 
 ### Templates applicable on database
 

diff --git a/product_docs/docs/pem/9/monitoring_performance/capacity_manager.mdx b/product_docs/docs/pem/9/monitoring_performance/capacity_manager.mdx
@@ -71,10 +71,11 @@ Use the **Report destination** options to set where to display or save the repor
 -   Select **New tab** to display the report on a new tab in the PEM client. You must select **New tab** to display the first generation of a Capacity Manager report. For subsequent reports, you can select **Previous tab**.
 -   Select **Previous tab** to reuse a previously opened tab when displaying the report.
 -   Select **Download the report as a file** and specify a file name to write the report to the specified file.
+-   Select **Report Type?** as **HTML** or **JSON** type from version 9.6 and later.
 
 After you specify the report boundaries and select the type and destination of the Capacity Manager report, select **Generate** to create the report.
 
-Reports saved to file are stored as HTML. You can review a Capacity Manager report with any web browser that supports scalable vector graphics (SVG). Browsers that don't support SVG can't display a Capacity Manager graph and might include unwanted characters.
+You can review a Capacity Manager report of HTML type with any web browser that supports scalable vector graphics (SVG). Browsers that don't support SVG can't display a Capacity Manager graph and might include unwanted characters.
 
 ## Capacity Manager templates
 

diff --git a/product_docs/docs/pem/9/monitoring_performance/probes.mdx b/product_docs/docs/pem/9/monitoring_performance/probes.mdx
@@ -73,6 +73,9 @@ Unless otherwise noted, Postgres Enterprise Manager enables the following probes
 | User Information                         | A list of the current users. The stored information includes:<br/>The user name<br/>The user type (superuser or non-superuser)<br/>The server to which the user is connected                                                                                                                                                                                                                                                                                                                                                    | Server   |
 | WAL Archive Status                       | Status of the WAL archive. The stored information includes:<br/>The number of WAL archives done<br/>The number of WAL archives pending<br/>The last archive time<br/>The number of WAL archives failed<br/>The time of the last failure                                                                                                                                                                                                                                                                                                     | Server   |
 | xDB Replication                          | Lag data for clusters replicated using xDB replication.                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Database |
+| Multixact ID Exhaustion (Wraparound)     | Information about the multixact ID. The stored information includes:<br/>The name of the database<br/>The oldest current Multixact ID in the database<br/>Percentage towards wraparound<br/>Percentage towards emergency autovacuum   | Server |
+| Replication Slots                        | Information about the replication slots. The stored information includes:<br/>A unique, cluster-wide identifier for the replication slot<br/>The base name of the shared object containing the output plugin this logical slot is using, or null for physical slots<br/>The slot type - physical or logical<br/>The OID of the database this slot is associated with, or null. Only logical slots have an associated database<br/>The name of the database this slot is associated with, or null. Only logical slots have an associated database<br/>Active field is True if this slot is currently actively being used<br/>The oldest transaction that this slot needs the database to retain. VACUUM cannot remove tuples deleted by any later transaction<br/>The oldest transaction affecting the system catalogs that this slot needs the database to retain. VACUUM cannot remove catalog tuples deleted by any later transaction<br/>The address (LSN) of oldest WAL which still might be required by the consumer of this slot and thus won't be automatically removed during checkpoints | Server |
+
 
 <div id="pgd_probes" class="registered_link"></div>
 
@@ -256,6 +259,52 @@ If you specify a parent node in the **Copy Probe Configuration** tree, PEM copie
 
 After you select the target object or objects, select **Configure Probes** to copy the probe definitions to the location selected in the dialog box.
 
+## Managing probes using pemworker
+
+From version 9.6, you can enable and disable a probe using the pemworker utility using `--probe-display-name`, `--probe-internal-name`, or `--probe-id` option.
+
+### Examples
+
+**On Linux**
+
+This example shows how to disable a probe using the probe display name:
+
+```shell
+export PEM_SERVER_PASSWORD=edb
+./pemworker --pem-user enterprisedb --disable-probe --probe-display-name "cpu usage"
+__OUTPUT__
+Wed Mar 27 01:43:40 2024 INFO: Probe status updated for agent (id: 1)
+```
+
+This example shows how to enable a probe using the probe display name:
+
+```shell
+export PEM_SERVER_PASSWORD=edb
+./pemworker  --pem-user enterprisedb --enable-probe --probe-display-name "database size"
+__OUTPUT__
+Wed Mar 27 02:02:20 2024 INFO: Probe status updated for server (id: 1)
+```
+
+**On Windows**
+
+This example shows how to disable a probe using the probe display name:
+
+```shell
+set PEM_SERVER_PASSWORD=edb
+./pemworker.exe DISABLE-PROBE --pem-user postgres --probe-display-name "CPU usage"
+__OUTPUT__
+INFO: Probe status updated for agent (id: 1)
+```
+
+This example shows how to enable a probe using the probe display name:
+
+```shell
+set PEM_SERVER_PASSWORD=edb
+./pemworker.exe ENABLE-PROBE --pem-user postgres --probe-display-name "CPU usage"
+__OUTPUT__
+INFO: Probe status updated for agent (id: 1)
+```
+
 ## PEM probes – reference
 
 A probe is a scheduled task that retrieves information about the database objects that are being monitored by the PEM agent. PEM uses the collected information to build the graphs displayed on each dashboard. The **Manage Probes** tab (accessed from the **Management** menu) allows you to modify the data collection schedule and the length of time that PEM retains information returned by a specific probe.

diff --git a/product_docs/docs/pem/9/pem_rel_notes/960_rel_notes.mdx b/product_docs/docs/pem/9/pem_rel_notes/960_rel_notes.mdx
@@ -0,0 +1,20 @@
+---
+title: "Postgres Enterprise Manager 9.6.0 release notes"
+navTitle: Version 9.6.0
+---
+
+Released: 15 May 2024
+
+New features, enhancements, bug fixes, and other changes in PEM 9.6.0 include:
+
+| Type         | Description                                                                                                                                                                                                                              |
+|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Enhancement  | Added an option to enable probes using the pemworker utility.                                                                                                                                                                            |
+| Enhancement  | PEM now includes the error message in email notifications of a failed job. The default character limit for error output is 1000, which can be configured now using `job_notification_error_limit` parameter in the server configuration. |
+| Enhancement  | Added two alert templates &mdash; `Inactive replication slots` and `Conflicting replication slots` and added two probes &mdash; `Replication slots` and `Multixact ID Exhaustion (Wraparound)`.                                          |
+| Enhancement  | The default display name for a newly registered agent is now the host's fully qualified domain name (FQDN), falling back to the previous default of the hostname if the FQDN is not set.                                                 |
+| Enhancement  | Updated the alert template `Table size in server/database/schema` with more detailed SQL query.                                                                                                                                          |
+| Bug&nbsp;fix | Fixed an issue where audit manager was setting `edb_audit_statement` parameter to '' instead of 'none' when log statement parameter was left empty in the GUI resulting in failure of server restart.                                    |
+| Bug&nbsp;fix | Fixed an issue whereby an error "`NoneType` has no `len()`" would occur when alerts were listed on the alert dashboard.                                                                                                                  |
+| Bug&nbsp;fix | Fixed an issue where team role was not working with PEM agents as expected.                                                                                                                                                              |
+| Bug&nbsp;fix | Fixed an issue with SQL query for the PEM agent registration. Added the public schema name in the table prefix to execute the SQL query successfully even if schema name is not in the search path.                                      |
diff --git a/product_docs/docs/pem/9/registering_agent.mdx b/product_docs/docs/pem/9/registering_agent.mdx
@@ -51,7 +51,7 @@ set PEM_SERVER_PASSWORD=edb
 | `--pem-agent-user`              | The agent user to connect the PEM server backend database server.                                                                                                                                   |
 | `--cert-path`                   | The complete path to the directory where certificates are created. If you don't provide a path, certificates are created in `~/.pem` on Linux and `%APPDATA%/pem` on Windows                        |
 | `--config-dir`                  | The directory path for the configuration file. The default is `<pemworker path>/../etc`.                                                                                                            |
-| `--display-name`                | A user-friendly name for the agent to display in the PEM browser tree. The default is the system hostname.                                                                                          |
+| `--display-name`                | A user-friendly name for the agent to display in the PEM browser tree. In PEM 9.6 and later, the default is the host's fully qualified domain name (FQDN), falling back to the hostname if this is not set. Prior to PEM 9.6, the default is the hostname.                                                                                          |
 | `--force-registration`          | Include the `force_registration` clause to register the agent with the arguments provided. This clause is useful if you're overriding an existing agent configuration. The default value is `Yes`.  |
 | `--group`                       | The name of the group in which the agent is displayed.                                                                                                                                              |
 | `--team`                        | The name of the database role on the PEM backend database server with access to the monitored database server.                                                                                      |
@@ -64,8 +64,6 @@ set PEM_SERVER_PASSWORD=edb
 | `--enable-snmp`                 | Enable the `enable-snmp parameter` to allow the PEM agent to send the SNMP traps on behalf of the PEM server. The default value is `False`.                                                         |
 | `-o`                            | Specifies whether you want to override the configuration file options.                                                                                                                              |
 
-
-
 !!! Note Allowing the agent to restart the database server
     If you use any feature of PEM that requires a database server restart by the PEM agent (such as Audit Manager, Log Manager, or the Tuning Wizard), then you must set the value of `allow_server_restart` to `true` in the `agent.cfg` file or restart the server manually for changes to take effect.