Skip to content

Commit

Permalink
Merge pull request #5632 from EnterpriseDB/docs/edits_to_pem_pr5596
Browse files Browse the repository at this point in the history 
Edits to PEM PR5596
  • Loading branch information
@nidhibhammar
nidhibhammar authored May 17, 2024
2 parents 1ea68cb + 4e49c9d commit dab77b9
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 25 deletions.
12 changes: 6 additions & 6 deletions product_docs/docs/pem/9/monitoring_performance/alerts.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -320,14 +320,14 @@ The tables that follow list the system-defined alert templates that you can use
| Number of WAL archives pending | Streaming Replication: number of WAL files pending to be replayed at replica | wal_archive_status |
| Number of minutes lag of replica server from primary server | Streaming Replication: number of minutes replica node is lagging behind the primary node | streaming_replication_lag_time |
| Log config mismatch | Check for log config parameter mismatch | log_configuration |
| 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 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) | | |
| Transaction ID exhaustion (wraparound) | Check for transaction ID exhaustion (wraparound) | |
| Inactive replication slots | Check for slots that are inactive for a particular server | | |
| Conflicting replication slots | Check for slots that are conflicting for a particular server | | |
| Multixact ID exhaustion (wraparound) | Check for multixact ID exhaustion (wraparound) | | |

### Templates applicable on database

Expand Down
4 changes: 2 additions & 2 deletions product_docs/docs/pem/9/monitoring_performance/capacity_manager.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +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.
- For **Report Type?**, select **HTML** or **JSON** type (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.

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.
You can review a Capacity Manager HTML 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.

## Capacity Manager templates

Expand Down
6 changes: 3 additions & 3 deletions product_docs/docs/pem/9/monitoring_performance/probes.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ 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 |
| 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 toward wraparound<br/>Percentage toward 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 slot.<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 can't remove tuples deleted by any later transaction<br/>The oldest transaction affecting the system catalogs that this slot needs the database to retain. VACUUM can't 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>
Expand Down Expand Up @@ -305,7 +305,7 @@ __OUTPUT__
INFO: Probe status updated for agent (id: 1)
```

## PEM probes – reference
## 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.

Expand Down
27 changes: 14 additions & 13 deletions product_docs/docs/pem/9/pem_rel_notes/960_rel_notes.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,17 @@ 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. |
| Enhancement | Added an option to download the Capacity Manager report in JSON format. |
| Enhancement | You can now specify a CA Certificate path when registering a Barman server using pemworker without having to specify a client certificate and key. |
| 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. |
| 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 the `job_notification_error_limit` parameter in the server configuration. |
| Enhancement | Added two alert templates (`Inactive replication slots` and `Conflicting replication slots`) and two probes (`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 isn't set. |
| Enhancement | Updated the alert template `Table size in server/database/schema` with more detailed SQL query. |
| Enhancement | Added an option to download the Capacity Manager report in JSON format. |
| Enhancement | You can now specify a CA Certificate path when registering a Barman server using pemworker without having to specify a client certificate and key. |
| 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 where audit manager was setting `edb_audit_statement` parameter to '' instead of 'none' when the log statement parameter was left empty in the GUI. This issue resulted in the failure of server restart. |
| Bug&nbsp;fix | Fixed an issue whereby an error "`NoneType` has no `len()`" occurred when alerts were listed on the alert dashboard. |
| Bug&nbsp;fix | Fixed an issue where team role wasn't working with PEM agents as expected. |
| Bug&nbsp;fix | Fixed an issue with the SQL query for the PEM agent registration. Added the public schema name in the table prefix to execute the SQL query successfully even if the schema name isn't in the search path. |
2 changes: 1 addition & 1 deletion product_docs/docs/pem/9/registering_agent.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. 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. |
| `--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 option isn't set. For releases earlier than 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. |
Expand Down

1 comment on commit dab77b9

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 Published on https://edb-docs-staging.netlify.app as production
🚀 Deployed on https://66471fa45b0c7997b63265d3--edb-docs-staging.netlify.app

Please sign in to comment.