diff --git a/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx b/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx index 41c54da108a..14f02fc39db 100644 --- a/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx +++ b/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx @@ -51,7 +51,7 @@ You are now able to: - [Log in to BigAnimal](#log-in) - [Invite new users](#invite-users) -- [Set up your cloud service provider](02_connecting_to_your_cloud/01_connecting_your_own_cloud) +- [Set up your cloud service provider](02_connecting_to_your_cloud/) ### Log in diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index 2d64d6aef10..ee6e932f4d1 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -45,7 +45,7 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. Select the number of standby replicas for your cluster. -1. Select the cloud provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud/#setting-up-your-cloud-service-provider). +1. Select the cloud provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Connecting to your cloud](/biganimal/latest/getting_started/02_connecting_to_your_cloud). ### Cluster Settings tab diff --git a/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx b/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx index 1d995dd1f3b..4f40d986698 100644 --- a/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx @@ -85,4 +85,4 @@ For step-by-step instructions for setting up specific identity providers, see: You and other users can log in to BigAnimal using your identity provider credentials. -You can [Set up your cloud service provider](02_connecting_to_your_cloud/01_connecting_your_own_cloud) so that you or other users with the correct permissions can create clusters. +You can [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/) so that you or other users with the correct permissions can create clusters. diff --git a/product_docs/docs/eprs/7/eprs_rel_notes/index.mdx b/product_docs/docs/eprs/7/eprs_rel_notes/index.mdx index 2c926a04cdd..902965287b9 100644 --- a/product_docs/docs/eprs/7/eprs_rel_notes/index.mdx +++ b/product_docs/docs/eprs/7/eprs_rel_notes/index.mdx @@ -20,5 +20,5 @@ The Replication Server documentation describes the latest version including mino You can only upgrade to Replication Server 7.x from 6.2.15 or later 6.2.x point version. If you are running a version earlier than 6.2.15, you need to first upgrade to 6.2.15 or later 6.2.x point version before upgrading to 7.x. !!!note - Version 7.x provides a non-breaking upgrade path for existing 6.2.x based cluster deployments; however, we strongly recommended that you verify the upgrade in a staging or nonproduction environment before applying the upgrade in a production environment. + Version 7.x provides a non-breaking upgrade path for existing 6.2.x based cluster deployments; however, we strongly recommended that you verify the upgrade in a staging or nonproduction environment before applying the upgrade in a production environment. There is no downgrade path from version 7.x to version 6.2.x so it is essential to test the upgrade first before applying it to the production environment. diff --git a/product_docs/docs/pem/8/considerations/authentication_options/configuring_the_pem_server_to_use_windows_kerberos_server.mdx b/product_docs/docs/pem/8/considerations/authentication_options/configuring_the_pem_server_to_use_windows_kerberos_server.mdx index 3b3667559d3..74f42cbe7bd 100644 --- a/product_docs/docs/pem/8/considerations/authentication_options/configuring_the_pem_server_to_use_windows_kerberos_server.mdx +++ b/product_docs/docs/pem/8/considerations/authentication_options/configuring_the_pem_server_to_use_windows_kerberos_server.mdx @@ -27,22 +27,16 @@ Perform the following installations: Create users in Active Directory of the Windows server to map with the HTTP service principal for the PEM web application. -1. Open **Active Directory Users and Computers > <DOMAIN_NAME> > Users**. Right-click and select **New > User** +1. Open **Active Directory Users and Computers > <DOMAIN_NAME> > Users**. Right-click and select **New > User**. ![Active Directory Users and Computers](../../images/active_directory_users_and_computers.png) 1. Enter the user details. - ![Active Directory Users and Computers Create User](../../images/active_directory_users_and_computers_create_user.png) - 1. Give the password and make sure to clear **User must change password at next logon**. Also select **User cannot change password** and **Password never expires**. - ![Active Directory Users and Computers set password](../../images/active_directory_users_and_computers_set_password.png) - 1. Review the user details. - ![Active Directory Users and Computers User Details](../../images/active_directory_users_and_computers_user_details.png) - 1. On the PEMServer Web Properties dialog box, add the users as members of the Domain Users group: ![PEM Server Web Properties](../../images/pem_server_web_properties_member_of.png) @@ -74,17 +68,15 @@ Extract the key tables for the service principals and map them with the respecti !!! Note The command line argument `+rndpass` resets the password for the domain user pemserverweb to a random password. The `/target` option is optional. -1. On the **Accounts** tab, Add Kerberos support for the user accounts. +1. On the **Accounts** tab, add Kerberos support for the user accounts. ![PEM Server Web Properties](../../images/pem_server_web_properties_account.png) !!! Note - On the **Accounts** tab, the user logon name shows **HTTP/pem.edbpem.internal@EDBPEM.INTERNAL**. The **Delegation** tab is enabled for the `pemserverweb` user. + On the **Accounts** tab, the user logon name shows **HTTP/pem.edbpem.internal@EDBPEM.INTERNAL**. The **Delegation** tab is enabled for the pemserverweb user. 1. On the **Delegation** tab, select **Trust this user for delegation to any service (Kerberos only)** for the users you created. - ![PEM Server Web Properties Delegation](../../images/pem_server_web_properties_delegation.png) - 1. Copy both the key tables to the PEM server host or to the PEM web server and PEM backend database server hosts if installed on different hosts. 1. On the PEM server, move the key tables to the required location and change the ownership: diff --git a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_centos7_x86.mdx b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_centos7_x86.mdx index 042a00a565b..de13b682e5a 100644 --- a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_centos7_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_centos7_x86.mdx @@ -39,8 +39,6 @@ Install the PEM agent package: When the installation is complete, you can review a list of the installed packages and dependencies. -![](../../../images/pem_rpm_installation_agent.png) - When you install an RPM package that's signed by a source that isn't recognized by your system, yum might ask for your permission to import the key to your local server. If prompted, and you're satisfied that the packages come from a trustworthy source, enter `y`, and press **Return** to continue. During the installation, yum might encounter a dependency that it can't resolve. If it does, it provides a list of the required dependencies to manually resolve. diff --git a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_other_linux8_x86.mdx b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_other_linux8_x86.mdx index eff23811033..0bb4d452899 100644 --- a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_other_linux8_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_other_linux8_x86.mdx @@ -45,8 +45,6 @@ To request credentials for the repository, contact [EDB](https://www.enterprised When the installation is complete, you can review a list of the installed packages and dependencies. -![](../../../images/pem_rpm_installation_agent.png) - When you install an RPM package that's signed by a source that isn't recognized by your system, yum might ask for your permission to import the key to your local server. If prompted, and you're satisfied that the packages come from a trustworthy source, enter `y`, and press **Return** to continue. During the installation, yum might encounter a dependency that it can't resolve. If it does, it provides a list of the required dependencies to manually resolve. diff --git a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel7_x86.mdx b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel7_x86.mdx index 9cf73e8fe8a..7cf0a37af34 100644 --- a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel7_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel7_x86.mdx @@ -45,8 +45,6 @@ Install the PEM agent package: When the installation is complete, you can review a list of the installed packages and dependencies. -![](../../../images/pem_rpm_installation_agent.png) - When you install an RPM package that's signed by a source that isn't recognized by your system, yum might ask for your permission to import the key to your local server. If prompted, and you're satisfied that the packages come from a trustworthy source, enter `y`, and press **Return** to continue. During the installation, yum might encounter a dependency that it can't resolve. If it does, it provides a list of the required dependencies to manually resolve. diff --git a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel8_x86.mdx b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel8_x86.mdx index e50609bdd77..8d599fa1dfc 100644 --- a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel8_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel8_x86.mdx @@ -46,8 +46,6 @@ To request credentials for the repository, contact [EDB](https://www.enterprised When the installation is complete, you can review a list of the installed packages and dependencies. -![](../../../images/pem_rpm_installation_agent.png) - When you install an RPM package that's signed by a source that isn't recognized by your system, yum might ask for your permission to import the key to your local server. If prompted, and you're satisfied that the packages come from a trustworthy source, enter `y`, and press **Return** to continue. During the installation, yum might encounter a dependency that it can't resolve. If it does, it provides a list of the required dependencies to manually resolve. diff --git a/product_docs/docs/pem/8/installing_pem_agent/installing_pem_agent_on_windows.mdx b/product_docs/docs/pem/8/installing_pem_agent/installing_pem_agent_on_windows.mdx index 4eab6e83cf0..1be95cdd8dc 100644 --- a/product_docs/docs/pem/8/installing_pem_agent/installing_pem_agent_on_windows.mdx +++ b/product_docs/docs/pem/8/installing_pem_agent/installing_pem_agent_on_windows.mdx @@ -18,65 +18,43 @@ To invoke the PEM agent installer, assume administrator privileges and navigate pem_agent-7..--platform.exe ``` -The Setup screen opens, welcoming you to the PEM agent installer. +1. The Setup screen opens, welcoming you to the PEM agent installer. Select **Next**. -![PEM Agent Wizard - Welcome dialog](../images/pem_agent_welcome_dialog.png) +1. Review the license agreement before selecting the appropriate radio button and accepting the agreement. Select **Next**. -Select **Next**. +1. By default, the PEM agent is installed in the `C:\Program Files (x86)\edb\pem` directory. You can accept the default installation directory. Or you can modify the contents of the **Installation Directory** field, specifying an alternate installation directory for the PEM agent. -![PEM Agent Wizard - License Agreement dialog](../images/pem_agent_windows_license_agreement.png) + - By default, the PEM agent installer places a certificate in the Administrator’s `%APPDATA%\pem` directory. Select **Show advanced options** to include a dialog box in the installation process that allows you to specify an alternate path for the certificate file. -Review the license agreement before selecting the appropriate radio button and accepting the agreement. Select **Next**. + - Select **Register now?** to register the newly installed PEM agent with the PEM server. -![PEM Agent Wizard - Installation Directory dialog](../images/pem_agent_windows_installation_directory.png) + - Select **Next**. -By default, the PEM agent is installed in the `C:\Program Files (x86)\edb\pem` directory. You can accept the default installation directory. Or you can modify the contents of the **Installation Directory** field, specifying an alternate installation directory for the PEM agent. +1. Enter the connection details for the PEM server in the PEM Server Installation Details dialog box. -By default, the PEM agent installer places a certificate in the Administrator’s `%APPDATA%\pem` directory. Select **Show advanced options** to include a dialog box in the installation process that allows you to specify an alternate path for the certificate file. + - Specify the name or IP address of the system where the PEM database server resides in the **Host** field. If the PEM-HTTPD web server and PEM database are hosted on different systems, you must specify the host of the PEM database. + - Specify the name of the database superuser in the **User Name** field. + - Specify the password associated with the database superuser in the **Password** field. + - Specify the port that PostgreSQL is monitoring in the **Port** field. -Select **Register now?** to register the newly installed PEM agent with the PEM server. +1. Select **Next** to continue to pemAgent Service Account. The installer attempts to connect to the server to verify that the details are correct. -Select **Next**. + !!! Note + The PEM server must allow connections from the PEM agent installer. If you encounter a connection error, confirm the connection properties specified in the PEM Server Installation Details dialog box are correct. Confirm that the `pg_hba.conf` file on the PEM server allows a connection to the server described in the error message. -![PEM Agent Wizard - PEM Server Installation details dialog](../images/pem_agent_pem_server_windows_installation_details.png) +1. Provide the password for the edb account for the pemAgent service to run under. The agent certificate and key files are created in the `C:\Users\edb\AppData\Roaming\pem` directory. Select **Next**. -Enter the connection details for the PEM server in the PEM Server Installation Details dialog box: +1. The tree displayed in the Browser panel of the PEM web interface displays the value entered in the **Description** field to identify the PEM agent. Specify a descriptive name for the agent, such as the hostname of the machine the agent is installed on or a name that reflects the host's functionality. -- Specify the name or IP address of the system where the PEM database server resides in the **Host** field. If the PEM-HTTPD web server and PEM database are hosted on different systems, you must specify the host of the PEM database. -- Specify the name of the database superuser in the **User Name** field. -- Specify the password associated with the database superuser in the **Password** field. -- Specify the port that PostgreSQL is monitoring in the **Port** field. + Provide a descriptive name, or accept the default provided by the PEM Agent host. Select **Next**. -Select **Next** to continue to pemAgent Service Account. The installer attempts to connect to the server to verify that the details are correct. +1. If you selected **Show advanced options**, the Advanced Options dialog box opens. By default, the PEM agent installer places the certificate in the `C:\Program Files (x86)\edb\pem` directory. Specify an alternate path for the certificate, or accept the default and select **Next**. -!!! Note - The PEM server must allow connections from the PEM agent installer. If you encounter a connection error, confirm the connection properties specified in the PEM Server Installation Details dialog box are correct. Confirm that the `pg_hba.conf` file on the PEM server allows a connection to the server described in the error message. - -![PEM Agent Wizard - pemAgent Service Account password dialog](../images/pem_agent_service_account_windows_password.png) - -Provide the password for the edb account for the pemAgent service to run undeer. The agent certificate and key files are created in the `C:\Users\edb\AppData\Roaming\pem` directory. Selct **Next**. - -![PEM Agent Wizard - Naming PEM Agent dialog](../images/pem_agent_windows_agent_details.png) - -The tree displayed in the Browser panel of the PEM web interface displays the value entered in the **Description** field to identify the PEM agent. Specify a descriptive name for the agent, such as the hostname of the machine the agent is installed on or a name that reflects the host's functionality. - -Provide a descriptive name, or accept the default provided by the PEM Agent host. Select **Next**. - -If you selected **Show advanced options**, the Advanced Options dialog box opens. +1. The wizard is ready to install the PEM agent. Select **Next**. -![PEM Agent Wizard - Advanced Options - Certificate Path dialog](../images/pem_agent_windows_advanced_options_certificate_path.png) +1. On the Ready to Install dialog box, select **Next**. The installer copies files to the system and registers the agent on the PEM server. -By default, the PEM agent installer places the certificate in the `C:\Program Files (x86)\edb\pem` directory. Specify an alternate path for the certificate, or accept the default and select **Next**. - -The wizard is now ready to install the PEM Agent. Select **Next**. - -![PEM Agent Wizard - Ready to install](../images/pem_agent_windows_installation_ready_to_begin.png) - -On the Ready to Install dialog box, select **Next**. The installer copies files to the system and registers the agent on the PEM server. - -![PEM Agent Wizard - Finish Installation dialog](../images/pem_agent_windows_installation_complete.png) - -When the installation has completed, the PEM agent is running and reporting operating system and host data to the PEM server. To start monitoring Postgres instances on the host of the PEM agent, add them to PEM’s enterprise directory and bound them to the agent. + When the installation completes, the PEM agent is running and reporting operating system and host data to the PEM server. To start monitoring Postgres instances on the host of the PEM agent, add them to PEM’s enterprise directory and bound them to the agent. ## Invoking the agent installer from the command ine @@ -111,9 +89,5 @@ Where: - `pguser_password` specifies the password associated with the PEM database superuser. - `agent_name` specifies a descriptive name for the PEM agent. -```text -EnterpriseDB is the leading provider of value-added products and services for the Postgres community. Please visit our website at www.enterprisedb.com. -``` - !!! Note When configuring a shell/batch script run by a Windows agent that has PEM 7.11 or later version installed, set the `AllowBatchJobSteps` parameter to `True` in the `agent.cfg` file. The PEM agent doesn't execute any batch/shell script by default. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/index.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/index.mdx index edbc2aeef7f..b22c144ab2c 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/index.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/index.mdx @@ -38,11 +38,7 @@ The PEM server backend database can be an EDB distribution of the PostgreSQL or - For troubleshooting the installation or configuration of the PEM agent, see [Troubleshooting PEM agent](../../troubleshooting_agent/). -The PEM server installer also installs the software required to access the server using the PEM web interface. You can access the web interface with a supported version of your browser. - -![The PEM web interface](../../images/pem_web_interface.png) - -You can use the web interface to: +The PEM server installer also installs the software required to access the server using the PEM web interface. You can access the web interface with a supported version of your browser. You can use the web interface to: - Review information about objects that reside on monitored servers - Manage databases and database objects that reside on monitored servers - Review statistical information gathered by the PEM server diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_and_httpd_on_diff_host.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_and_httpd_on_diff_host.mdx index cde97ebefd1..913f3708587 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_and_httpd_on_diff_host.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_and_httpd_on_diff_host.mdx @@ -12,149 +12,103 @@ To use separate hosts for the PEM server backend database and PEM-HTTPD: 2. Modify the `pg_hba.conf` file of the Postgres installation on which the PEM server (and `pem` database) resides, allowing connections from the host of the PEM-HTTPD server. 3. Invoke the PEM server installer on the host of the PEM-HTTPD server, selecting the **Web Services** option on the Installation Type dialog box. -To invoke the PEM server installer on a Windows system, right-click the installer and select **Run as Administrator**. The installer displays a Welcome screen. +To start the installation: -![PEM Server Wizard - Welcome dialog](../../images/pem_server_on_separate_host_welcome_wizard.png) +1. On a Windows system, invoke the PEM server installer. Right-click the installer and select **Run as Administrator**. The installer displays a Welcome screen. Select **Next**. -Select **Next**. +1. Review the license agreement before selecting the appropriate radio button and accepting the agreement. Select **Next**. -![PEM Server Wizard - License Agreement dialog](../../images/pem_server_on_separate_host_license_agreement.png) +1. Use fields on the Installation Directory dialog box to specify the directory for the PEM server to reside and to open the Advanced Options dialog box during installation: -Review the license agreement before selecting the appropriate radio button and accepting the agreement. Select **Next**. + - By default, the PEM server is installed in `C:\Program Files\edb\pem` on Windows. Accept the default location, or use the **Installation Directory** field to open a browser dialog box and select the directory to install the PEM server in. + - To install the PEM server and PEM-HTTPD on separate hosts, use the Advanced Options dialog box to specify the installation type (**Web Services** or **Database**). Select **Show advanced options** to include the Advanced Options dialog box in the installation process. + - Select **Next**. -![PEM Server Wizard - Installation Directory dialog](../../images/pem_server_on_separate_host_installation_directory.png) +1. Use the Advanced Options dialog box to specify the components that you want to install: -Use fields on the Installation Directory dialog box to specify the directory for the PEM server to reside and to open the Advanced Options dialog box during installation: + - Select **Web Services and Database** to indicate that the Postgres server and PEM-HTTPD will both reside on the current host. If you select **Web Services and Database**, the PEM server installer lets you specify the Postgres server to use for the PEM server before checking for a PEM-HTTPD installation. + - Select **Web Services** to install PEM-HTTPD on the current host, while using a Postgres database server that resides on another host to host the PEM server and `pem` database. -- By default, the PEM server is installed in `C:\Program Files\edb\pem` on Windows. Accept the default location, or use the **Installation Directory** field to open a browser dialog box and select the directory to install the PEM server in. -- To install the PEM server and PEM-HTTPD on separate hosts, use the Advanced Options dialog box to specify the installation type (**Web Services** or **Database**). Select **Show advanced options** to include the Advanced Options dialog box in the installation process. + !!! Note + Before using the **Web Services** option to install PEM-HTTPD, you must complete the PEM server installation process on the host of the PEM server and `pem` backend database. Select **Database** on the Advanced Options dialog box and modify the connection properties of the `pg_hba.conf` file on the PEM server. -Select **Next**. + This option invokes the installation steps described in [Installing web services](#installing-web-services). -![PEM Server Wizard - Advanced Options dialog](../../images/pem_server_on_separate_host_web_services_and_database.png) + - Select **Database** to use an existing Postgres server (version 11 or later) or to install only the database server that's distributed with the PEM server installer. This option invokes the installation steps described in [Specifying a database host](#specifying-a-database-host). -Use the Advanced Options dialog box to specify the components that you want to install: - -- Select **Web Services and Database** to indicate that the Postgres server and PEM-HTTPD will both reside on the current host. If you select **Web Services and Database**, the PEM server installer lets you specify the Postgres server to use for the PEM server before checking for a PEM-HTTPD installation. -- Select **Web Services** to install PEM-HTTPD on the current host, while using a Postgres database server that resides on another host to host the PEM server and `pem` database. - -!!! Note - Before using the **Web Services** option to install PEM-HTTPD, you must complete the PEM server installation process on the host of the PEM server and `pem` backend database. Select **Database** on the Advanced Options dialog box and modify the connection properties of the `pg_hba.conf` file on the PEM server. - -This option invokes the installation steps described in [Installing web services](#installing-web-services). - -- Select **Database** to use an existing Postgres server (version 11 or later) or to install only the database server that's distributed with the PEM server installer. This option invokes the installation steps described in [Specifying a database host](#specifying-a-database-host). - -After selecting an installation option, select **Next**. +1. After selecting an installation option, select **Next**. ## Specifying a database host -Selecting **Database** on the Advanced Options dialog box allows you to specify connection information for the host where the PEM server backend database (named `pem`) will reside. - -![PEM Server Wizard - Advanced options - select database dialog](../../images/pem_server_on_separate_host_advanced_options_dialog_select_database.png) +1. Select **Database** on the Advanced Options dialog box to specify connection information for the host where the PEM server backend database (named `pem`) will reside. Select **Next**. -Select **Next**. +1. Use the list on the Database Server Selection dialog box to select a host for the PEM server backend database. You can: -![Selecting a database server](../../images/pem_server_on_separate_host_database_server_selection.png) + - Select a host from existing Postgres installations that reside on the current host. -Use the list on the Database Server Selection dialog box to select a host for the PEM server backend database. You can: + !!! Note + You might need to add the `sslutils` package to your installation. -- Select a host from existing Postgres installations that reside on the current host. + - Select **PostgreSQL <x>** to install the Postgres server that's distributed with the PEM server installer, where `` is the PostgreSQL database server version. If you decide to use the version of PostgreSQL that's bundled with the PEM server installer, the EnterpriseDB one-click PostgreSQL installer opens and walks you through the installation. + - Select **Other Database Server** to specify connection information for a Postgres server that wasn't installed using a one-click graphical installer from EnterpriseDB. For information about the software prerequisites for the PEM server database host, see [Preparing the Postgres server](pem_server_on_existing_pg_server/#preparing-the-postgres-server). -!!! Note - You might need to add the `sslutils` package to your installation. - -- Select **PostgreSQL <x>** to install the Postgres server that's distributed with the PEM server installer, where `` is the PostgreSQL database server version. If you decide to use the version of PostgreSQL that's bundled with the PEM server installer, the EnterpriseDB one-click PostgreSQL installer opens and walks you through the installation. -- Select **Other Database Server** to specify connection information for a Postgres server that wasn't installed using a one-click graphical installer from EnterpriseDB. For information about the software prerequisites for the PEM server database host, see [Preparing the Postgres server](pem_server_on_existing_pg_server/#preparing-the-postgres-server). - -Select **Next**. - -If the PEM server will reside on an existing Postgres server, the Database Server Installation Details dialog box opens. + - Select **Next**. -![PEM Server Wizard - Database Server Installation Details dialog](../../images/pem_server_on_separate_host_database_server_installation_details.png) + If the PEM server will reside on an existing Postgres server, the Database Server Installation Details dialog box opens. -The information required on the Database Server Installation Details dialog box can vary. The PEM server installer asks you to provide only the information about the selected installation that it can't locate: +1. The information required on the Database Server Installation Details dialog box can vary. The PEM server installer asks you to provide only the information about the selected installation that it can't locate: -- Specify the name of a Postgres database superuser in the **User** field. -- Specify the password associated with that user in the **Password** field. + - Specify the name of a Postgres database superuser in the **User** field. + - Specify the password associated with that user in the **Password** field. + - Select **Next**. -Select **Next**. +1. If prompted, provide the system password for the service account under which the PEM agent will run. Select **Next**. -If prompted, provide the system password for the service account under which the PEM agent will run. +1. Use the Network Details dialog box to specify the CIDR-style network address from which PEM agents will connect to the server (the client-side address). The specified address is added to the server's `pg_hba.conf` file. -![PEM Server Wizard - PEM Agent Service Account Password](../../images/pem_server_on_separate_pem_agent_service_account.png) + !!! Note + You can specify more network addresses by manually adding entries to the `pg_hba.conf` file on the PostgreSQL server. -Select **Next**. + Accept the default (specifying the localhost), or specify a **Network address** range. Select **Next**. -![PEM Server Wizard - Network Details dialog](../../images/pem_server_on_separate_host_network_details.png) - -Use the Network Details dialog box to specify the CIDR-style network address from which PEM agents will connect to the server (the client-side address). The specified address is added to the server's `pg_hba.conf` file. - -!!! Note - You can specify more network addresses by manually adding entries to the `pg_hba.conf` file on the PostgreSQL server. + The PEM server installer installs a PEM agent on the host on which the server resides to monitor the server and provide alert processing and garbage collection services. A certificate is also installed in the location specified in the **Agent certificate path** field. -Accept the default (specifying the localhost), or specify a **Network address** range. Select **Next**. +1. You can enter an alternate description or an alternate agent certificate path for the PEM agent or accept the defaults. Select **Next**. -The PEM server installer installs a PEM agent on the host on which the server resides to monitor the server and provide alert processing and garbage collection services. A certificate is also installed in the location specified in the **Agent certificate path** field. +1. The wizard is now ready to install the PEM server. Select **Next** to proceed with the installation. -![PEM Server Wizard - Agent Description and Certificate Path dialog](../../images/pem_server_on_separate_host_database_agent_details.png) + During the installation process, the installer copies files to the system and sets up the PEM server's backend database. A confirmation indicates that the `pem` database was created and configured. -You can enter an alternate description or an alternate agent certificate path for the PEM agent or accept the defaults. Select **Next**. +1. Select **OK** -![PEM Server Wizard - Ready to Install dialog](../../images/pem_server_on_separate_host_installation_begins.png) - -The wizard is now ready to install the PEM server. Select **Next** to proceed with the installation. - -![PEM Server Wizard - Installation in progress](../../images/pem_server_on_separate_host_installation_in_progress.png) - -During the installation process, the installer copies files to the system and sets up the PEM server's backend database. A confirmation indicates that the `pem` database was created and configured. Select **OK** - -![PEM Server Wizard - pem database created](../../images/pem_server_on_separate_host_pem_db_created.png) - -![PEM server Wizard - Finish Installation dialog](../../images/pem_server_on_separate_host_installation_complete.png) - -When the database portion of the PEM server installation is complete, you can invoke the PEM server on another host to install or upgrade PEM-HTTPD. + When the database portion of the PEM server installation is complete, you can invoke the PEM server on another host to install or upgrade PEM-HTTPD. ## Installing web services -Selecting **Web Services** on the Advanced Options dialog box either installs PEM-HTTPD on the current host or updates an existing PEM-HTTPD installation. - -![PEM Server Wizard - Advanced Options - Web Services option](../../images/pem_server_on_separate_host_installing_web_services_advanced_options.png) +Select **Web Services** on the Advanced Options dialog box to either install PEM-HTTPD on the current host or update an existing PEM-HTTPD installation. !!! Note The current host might not be the host of the PEM backing database. Before selecting this option, you must: -- Complete an installation of the PEM server installer on a host system, during which you specify a backing database for the PEM server. +- Install the PEM server installer on a host system, during which you specify a backing database for the PEM server. - Modify the `pg_hba.conf` file on the PEM server database host to allow connections from the PEM-HTTPD host. - Restart the database server. -When you select **Web Services** and select **Next**, the PEM server installer checks the current host for existing PEM-HTTPD and LanguagePack installations. - -If the installer doesn't locate the components, the installer informs you that one or more dependencies are missing. - -![PEM Server Wizard - Missing dependencies dialog](../../images/pem_server_on_separate_host_web_services_checking_components.png) - -Select **Next** to install the language pack. - -![PEM Server Wizard - Installing LanguagePack](../../images/pem_server_on_separate_host_installing_web_services_installing_missing_dependency_languagepack.png) - -After installing language pack, the installer invokes the PEM-HTTPD setup wizard. - -![PEM Server Wizard - Installing PEM-HTTPD wizard](../../images/pem_server_on_separate_host_PEM_httpd_installation_wizard.png) +1. Select **Web Services** and select **Next**. The PEM server installer checks the current host for existing PEM-HTTPD and LanguagePack installations. -Follow the onscreen instructions of the PEM-HTTPD Setup wizard. When the wizard completes the installation, select **Finish** to open the Database Server Installation Details dialog box. +1. If the installer doesn't locate the components, the installer informs you that one or more dependencies are missing. Select **Next** to install the language pack. After installing language pack, the installer invokes the PEM-HTTPD setup wizard. -![PEM Server Wizard - Database Server Installation Details dialog](../../images/pem_server_on_separate_host_webservices_installing_database_server.png) +1. Follow the onscreen instructions of the PEM-HTTPD Setup wizard. When the wizard completes the installation, select **Finish** to open the Database Server Installation Details dialog box. -Use the Database Server Installation Details dialog box to provide connection information for the Postgres installation that's hosting the PEM server installation: +1. Use the Database Server Installation Details dialog box to provide connection information for the Postgres installation that's hosting the PEM server installation: -- Enter the name or IP address of the PEM server host in the **Host** field. -- Enter the port number on which the Postgres server is listening in the **Port** field. -- Enter the name of a Postgres database superuser in the **User** field. -- Enter the password associated with the Postgres superuser in the **Password** field. + - Enter the name or IP address of the PEM server host in the **Host** field. + - Enter the port number on which the Postgres server is listening in the **Port** field. + - Enter the name of a Postgres database superuser in the **User** field. + - Enter the password associated with the Postgres superuser in the **Password** field. -Select **Next**. +1. Select **Next**. -Before completing the PEM server installation, the installer contacts the database host. For the installation to continue, the `pg_hba.conf` file on the PEM database host must be configured to accept connections from the host of the httpd server, and the firewall must allow a connection. The PEM server installer completes the PEM server installation, adding only those items that must reside on the host of the PEM-HTTPD server. + Before completing the PEM server installation, the installer contacts the database host. For the installation to continue, the `pg_hba.conf` file on the PEM database host must be configured to accept connections from the host of the httpd server, and the firewall must allow a connection. The PEM server installer completes the PEM server installation, adding only those items that must reside on the host of the PEM-HTTPD server. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_and_httpd_on_same_host.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_and_httpd_on_same_host.mdx index f0a9868fa9b..31ad14f4609 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_and_httpd_on_same_host.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_and_httpd_on_same_host.mdx @@ -8,74 +8,46 @@ legacyRedirectsGenerated: The easiest PEM server installation configuration consists of a PEM backend database server (hosted on a PostgreSQL database installed with the PEM server installer) and a PEM-HTTPD service that reside on the same host. In this configuration, the PEM server installer provides the prerequisite software for the backend host to register the service (on Windows). -To invoke the PEM server installer on a Windows system, right-click the installer icon and select **Run as Administrator**. The installer displays a Welcome screen. +1. Invoke the PEM server installer. On a Windows system, right-click the installer icon and select **Run as Administrator**. The installer displays a Welcome screen. Select **Next**. -![PEM Server Wizard - Welcome dialog](../../images/pem_server_on_same_host_welcome_wizard.png) +1. Review the license agreement before selecting the appropriate radio button and accepting the agreement. Select **Next**. -Select **Next**. +1. Use the Installation Directory dialog box to specify the location of the PEM server: -![PEM Server Wizard - License Agreement dialog](../../images/pem_server_on_same_host_license_agreement.png) + - By default, the PEM server is installed in `C:\Program Files\edb\pem` on Windows. Accept the default location, or use the **Installation Directory** button to open a dialog box and select the directory to install the PEM server in. + - Use the **Show advanced options** check box to open the Advanced Options dialog box during installation. Use the Advanced Options dialog box when installing the Postgres database server and the PEM-HTTPD on different hosts or if you want the PEM server to reside on an existing Postgres server installation. + - To install the PostgreSQL server package with the installer and PEM-HTTPD on the same host, clear **Show advanced options** and select **Next**. -Carefully review the license agreement before selecting the appropriate radio button and accepting the agreement. Select **Next**. + The PEM server installer performs a preinstallation check for PEM-HTTPD, Language Pack, and PostgreSQL 13. If the installer doesn't locate these packages, it informs you in the Dependency Missing dialog box. -![PEM Server Wizard - Installation directory dialog](../../images/pem_server_on_same_host_installation_directory.png) + !!! Note + By default EDB Language Pack is installed in `C:\edb\languagepack\v1`. -Use the Installation Directory dialog box to specify the location of the PEM server: +1. If the dependencies are missing, the PEM server installer launches the respective installation wizards. Follow the wizard's onscreen directions each package. -- By default, the PEM server is installed in `C:\Program Files\edb\pem` on Windows. Accept the default location, or use the **Installation Directory** button to open a dialog box and select the directory to install the PEM server in. -- Use the **Show advanced options** check box to open the Advanced Options dialog box. -- Use the Advanced Options dialog box when installing the Postgres database server and the PEM-HTTPD on different hosts or if you want the PEM server to reside on an existing Postgres server installation. + After installing any missing dependencies, the installation process continues by displaying the Database Server Installation Details dialog box. The information provided on the Database Server Installation Details dialog box enables the installer to connect to the PostgreSQL server. -To install the PostgreSQL server package with the installer and PEM-HTTPD on the same host, clear **Show advanced options** and select **Next**. +1. Provide the user name and password of a database superuser. After supplying the requested information, select **Next**. -The PEM server installer performs a preinstallation check for PEM-HTTPD, Language Pack, and PostgreSQL 13. If the installer doesn't locate these packages, it informs you in the Dependency Missing dialog box. +1. After providing the name and password of the Postgres database superuser, you might be prompted for the password to the user account under which the PEM agent will run. If prompted, provide the password, and select **Next**. -!!! Note - By default EDB Language Pack is installed in `C:\edb\languagepack\v1`. +1. Use the Network Details dialog box to specify the CIDR-style network address from which the PEM agents will connect to the server (the *client-side* address). -![PEM Server Wizard - Dependencies check dialog](../../images/pem_server_on_same_host_prerequisites_checks.png) + You can specify the address of a network host or a network address range. For example, if you want to monitor database servers with the addresses `192.168.10.23`, `192.168.10.76`, and `192.168.10.184`, enter `192.168.10.0/24` to allow connections with hosts in that network. -If the dependencies are missing, the PEM server installer launches the respective installation wizards. Follow the wizard's onscreen directions each package. + The specified address is added to the server's `pg_hba.conf` file. You can specify more network addresses by manually adding entries to the `pg_hba.conf` file on the PostgreSQL server. Use the first entry as a template. -After installing any missing dependencies, the installation process continues by displaying the Database Server Installation Details dialog box. + After you add the network address, select **Next**. -![PEM Server Wizard - Database Server Installation details dialog](../../images/pem_server_on_same_host_pgsql_credentials.png) + The PEM server installer installs a PEM agent on the host where the server resides to monitor the server and provide alert processing and garbage collection services. A certificate is also installed in the location specified in the **Agent certificate path** field. -The information provided on the Database Server Installation Details dialog box enables the installer to connect to the PostgreSQL server. Provide the user name and password of a database superuser. After supplying the requested information, select **Next**. +1. Enter an alternate description or select an alternate agent certificate path for the PEM agent, or accept the defaults. Select **Next**. -![PEM Server Wizard - pemAgent Service Account Password dialog](../../images/pem_server_on_same_host_pemagent_service_account_password.png) +1. The wizard is now ready to install the PEM server. Select **Next** to continue with the installation. -After providing the name and password of the Postgres database superuser, you might be prompted for the password to the user account under which the PEM agent will run. If prompted, provide the password, and selct **Next**. + During the installation process, the installer copies files to the system and sets up the database and web services required to run PEM. When the installation completes, a confirmation indicates that: + - The web service was configured. + - The web service is listening on port 8443. + - The `pem` database was created and configured. -![Supply the network address from which the agent will connect](../../images/pem_server_on_same_host_network_details.png) - -Use the Network Details dialog box to specify the CIDR-style network address from which the PEM agents will connect to the server (the *client-side* address). - -You can specify the address of a network host or a network address range. For example, if you want to monitor database servers with the addresses `192.168.10.23`, `192.168.10.76`, and `192.168.10.184`, enter `192.168.10.0/24` to allow connections with hosts in that network. - -The specified address is added to the server's `pg_hba.conf` file. You can specify more network addresses by manually adding entries to the `pg_hba.conf` file on the PostgreSQL server. Use the first entry as a template. - -After you add the network address, select **Next**. - -The PEM server installer installs a PEM agent on the host where the server resides to monitor the server and provide alert processing and garbage collection services. A certificate is also installed in the location specified in the **Agent certificate path** field. - -![PEM Server Wizard - Agent Description and Certificate Path dialog](../../images/pem_server_on_same_host_agent_details.png) - -Enter an alternate description or select an alternate agent certificate path for the PEM agent, or accept the defaults. Select **Next**. - -![PEM Server Wizard - Ready to Install dialog](../../images/pem_server_on_same_host_installation_begins.png) - -The wizard is now ready to install the PEM server. Select **Next** to continue with the installation. - -![PEM Server Wizard - Installation in progress](../../images/pem_server_on_same_host_installation_in_progress.png) - -During the installation process, the installer copies files to the system and sets up the database and web services required to run PEM. When the installation completes, a confirmation indicates that: -- The web service was configured. -- The web service is listening on port 8443. -- The `pem` database was created and configured. - -![PEM Server Wizard - pem database created](../../images/pem_server_on_same_host_db_pem_created.png) - -Select **OK**. - -![PEM server Wizard - Installation Finish dialog](../../images/pem_server_on_same_host_installation_complete.png) \ No newline at end of file +1. Select **OK**. \ No newline at end of file diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_on_existing_pg_server.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_on_existing_pg_server.mdx index 48abf86eb84..a83486c7269 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_on_existing_pg_server.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_windows/pem_server_on_existing_pg_server.mdx @@ -124,98 +124,69 @@ pem_server-7..-- Where `` is the major and minor versions of PEM, and `` is the platform. -The installer displays a Welcome screen. +Then, begin the installation: -![PEM server Wizard - Welcome dialog](../../images/pem_server_existing_pg_welcome_wizard.png) +1. The installer displays a Welcome screen. Select **Next**. -Select **Next**. +1. Review the license agreement before selecting the appropriate radio button and accepting the agreement. Select **Next**. -![PEM Server Wizard - License Agreement dialog](../../images/pem_server_existing_pg_license_agreement.png) +1. Use the Installation Directory dialog box to specify the location of the PEM server and access the Advanced Options dialog box: -Review the license agreement before selecting the appropriate radio button and accepting the agreement. Select **Next**. + - Use the **Installation Directory** field to open a browser dialog and select the directory to install the PEM server in. + - If you're installing the PEM server on an existing server, select **Show advanced options** to include the Advanced Options dialog box in the installation process. + - Select **Next**. -![PEM Server Wizard - Installation Directory dialog](../../images/pem_server_existing_pg_installation_directory.png) +1. Use the Advanced Options dialog box to specify an installation type. Select: -Use the Installation Directory dialog box to specify the location of the PEM server and access the Advanced Options dialog box: + - **Web Services and Database** if both the Postgres server and the PEM-HTTPD server will reside on the current host. This option is valid if you're using an existing Postgres server to host the PEM server or using the PEM server installer to install the Postgres server where the PEM server will reside. -- Use the **Installation Directory** field to open a browser dialog and select the directory to install the PEM server in. -- If you're installing the PEM server on an existing server, select **Show advanced options** to include the Advanced Options dialog box in the installation process. + If you select **Web Services and Database**, the PEM server installer checks the current host for a PEM-HTTPD installation and upgrades or installs PEM-HTTPD if necessary. -Select **Next**. + - **Web Services** if only the PEM-HTTPD server will reside on the current host. See [Installing web services](pem_server_and_httpd_on_diff_host/#installing-web-services) for more information about invoking this option. -![PEM Server Wizard - Advanced Options dialog](../../images/pem_server_existing_pg_advanced_options.png) + - **Database** if you're installing only the PEM server (and creating the `pem` backend database) on the current host. This option is valid if you're using an existing Postgres server to host the PEM server or using the PEM server installer to install the PostgreSQL server where PEM will reside. -Use the Advanced Options dialog box to specify an installation type. Select: + After selecting an installation option, select **Next**. -- **Web Services and Database** if both the Postgres server and the PEM-HTTPD server will reside on the current host. This option is valid if you're using an existing Postgres server to host the PEM server or using the PEM server installer to install the Postgres server where the PEM server will reside. +1. Use the list on the Database Server Selection dialog box to select a backend database for the PEM server: - If you select **Web Services and Database**, the PEM server installer checks the current host for a PEM-HTTPD installation and upgrades or installs PEM-HTTPD if necessary. + - Select the name of a Postgres server on the current host that was installed using a Postgres one-click installer or EDB Postgres Advanced Server installer. + - Select **PostgreSQL x (Packaged)** to install and use the PostgreSQL server that's packaged with the PEM server installer, where `x` is the version of the PostgreSQL database server. + - Select **Other Database Server** to to use a Postgres database that was installed from a source other than an EnterpriseDB installer (such as from an rpm or built from source). -- **Web Services** if only the PEM-HTTPD server will reside on the current host. See [Installing web services](pem_server_and_httpd_on_diff_host/#installing-web-services) for more information about invoking this option. + !!! Note + The selected database server must include an installation of the `sslutils` contrib module and a registered service (on Windows). -- **Database** if you're installing only the PEM server (and creating the `pem` backend database) on the current host. This option is valid if you're using an existing Postgres server to host the PEM server or using the PEM server installer to install the PostgreSQL server where PEM will reside. + For more information, see [Preparing the Postgres server](#preparing-the-postgres-server). -After selecting an installation option, select **Next**. + If you selected **Web Services and Database** on the Advanced Options dialog box, the installation wizard checks the current host for an existing PEM-HTTPD installation and upgrades or installs the service as needed. -![PEM Server Wizard - Database Server Selection dialog](../../images/pem_server_existing_pg_database_server_selection.png) + If you selected **Database** on the Advanced Options dialog box, the Database Server Installation Details dialog box opens. -Use the list on the Database Server Selection dialog box to select a backend database for the PEM server: +1. Use the fields on the Database Server Installation Details dialog box to describe the connection to the Postgres server that will host the PEM server: -- Select the name of a Postgres server on the current host that was installed using a Postgres one-click installer or EDB Postgres Advanced Server installer. -- Select **PostgreSQL x (Packaged)** to install and use the PostgreSQL server that's packaged with the PEM server installer, where `x` is the version of the PostgreSQL database server. -- Select **Other Database Server** to to use a Postgres database that was installed from a source other than an EnterpriseDB installer (such as from an rpm or built from source). + - Enter the name of a database superuser in the **User** field. + - Enter the password associated with the superuser in the **Password** field. -!!! Note - The selected database server must include an installation of the `sslutils` contrib module and a registered service (on Windows). - -For more information, see [Preparing the Postgres server](#preparing-the-postgres-server). - -If you selected **Web Services and Database** on the Advanced Options dialog box, the installation wizard checks the current host for an existing PEM-HTTPD installation and upgrades or installs the service as needed. - -If you selected **Database** on the Advanced Options dialog box, the Database Server Installation Details dialog box opens. - -![PEM Server Wizard - Database Server Installation Details dialog](../../images/pem_server_existing_pg_installation_db_server_details.png) - -Use the fields on the Database Server Installation Details dialog box to describe the connection to the Postgres server that will host the PEM server: - -- Enter the name of a database superuser in the **User** field. -- Enter the password associated with the superuser in the **Password** field. - -Select **Next**. - -![PEM Server Wizard - PEM Agent Service Account - Administrator's Password](../../images/pem_server_existing_pg_administrators_password.png) - -Provide the administrator password for the PEM agent service to run under. - -Select **Next**. - -![PEM Server Wizard - Network Details dialogsx](../../images/pem_server_existing_pg_network_details.png) - -Use the Network Details dialog box to specify the CIDR-style network address for the PEM agents to connect to the server (the `client-side` address). The specified address is added to the server's `pg_hba.conf file.` - -You can specify more network addresses by manually adding entries to the `pg_hba.conf` file on the PostgreSQL server. Use the first entry as a template. - -After you add the network address, select **Next**. - -The PEM server installer installs a PEM agent to the host where the server resides to monitor the server and provide alert processing and garbage collection services. A certificate is also installed in the location specified in the **Agent certificate path** field. + Select **Next**. -![PEM Server Wizard - Agent Description and Certificate Path dialog](../../images/pem_server_existing_pg_agent_details.png) +1. Provide the administrator password for the PEM agent service to run under. Select **Next**. -You can enter an alternate description or an alternate agent certificate path for the PEM agent or accept the defaults. Select **Next**. +1. Use the Network Details dialog box to specify the CIDR-style network address for the PEM agents to connect to the server (the `client-side` address). The specified address is added to the server's `pg_hba.conf file.` -![PEM Server Wizard - Ready to Install dialog](../../images/pem_server_existing_pg_installation_begins.png) + You can specify more network addresses by manually adding entries to the `pg_hba.conf` file on the PostgreSQL server. Use the first entry as a template. -The wizard is now ready to install the PEM server. Select **Next** to continue with the installation. + After you add the network address, select **Next**. -![PEM Server Wizard - Installation in progress](../../images/pem_server_existing_pg_installation_in_progress.png) + The PEM server installer installs a PEM agent to the host where the server resides to monitor the server and provide alert processing and garbage collection services. A certificate is also installed in the location specified in the **Agent certificate path** field. -During the installation process, the installer copies files to the system and sets up the PEM server's backend database. A confirmation indicates that the `pem` database was created and configured. +1. You can enter an alternate description or an alternate agent certificate path for the PEM agent or accept the defaults. Select **Next**. -![PEM Server Wizard - pem database created](../../images/pem_server_existing_pg_pem_db_created.png) +1. The wizard is now ready to install the PEM server. Select **Next** to continue with the installation. - Select **OK**. + During the installation process, the installer copies files to the system and sets up the PEM server's backend database. A confirmation indicates that the `pem` database was created and configured. -![PEM server Wizard - Finish Installation](../../images/pem_server_existing_pg_installation_complete.png) +1. Select **OK**. If you're using a PEM-HTTPD service that resides on a separate host, you must: diff --git a/product_docs/docs/pem/8/managing_bart.mdx b/product_docs/docs/pem/8/managing_bart.mdx index 379136b4291..20c449f700e 100644 --- a/product_docs/docs/pem/8/managing_bart.mdx +++ b/product_docs/docs/pem/8/managing_bart.mdx @@ -31,8 +31,6 @@ In PEM version 7.10 and later, you can manage a BART server and perform all the You can use the Create–BART Server dialog box to register an existing BART server with the PEM server. To open the dialog box, right-click the BART Servers node and select **Create-BART Server**. -![The Create-BART server dialog - General tab](images/create_BART_server_general.png) - Use the **General** tab to describe the general properties of the BART server: - Use the **Agent Name** field to select the agent that you want to use for the BART server. Only those PEM agents that are supported for BART are listed. @@ -57,8 +55,6 @@ Use the **General** tab to describe the general properties of the BART server: - Use the optional **Log file** field to specify the path to BART log file. -![The Create-BART server dialog - Misc tab](images/create_BART_server_misc.png) - Use the **Misc** tab to describe the backup-related properties of the BART server: - Use the **Scanner log file** field to specify the path to the Xlog/WAL scanner log file. BART creates a log scanner file only if you specify the path. @@ -91,8 +87,6 @@ After configuring the BART server, you must associate it with the database serve To map the BART server to a new PEM database server, right-click the PEM Server Directory node and select **Create > Server**. Enter the details on all the generic tabs and then enter the BART-specific details on the **BART** tab. -![The Create Server dialog (BART - General tab)](images/create_server_bart_general.png) - Use the **General** tab to describe the general properties of the BART Server that map to the PEM server: - Use the **BART server** field to select the BART server name. All the BART servers configured in the PEM console are listed. @@ -121,8 +115,6 @@ Use the **General** tab to describe the general properties of the BART Server th - Use the **Setup passwordless SSH?** switch to specify if you want to create SSH certificates to allow passwordless logins between the database server and the BART server. Be sure to bind a PEM agent before setting up the passwordless SSH authentication. Passwordless SSH doesn't work for a database server being remotely monitored by a PEM agent. -![The Create - Server dialog (BART - Misc tab)](images/create_server_bart_misc.png) - Use the fields on the **Misc** tab to describe the miscellaneous properties of the BART server: - Use the **Override default configuration?** switch to specify if you want to override the BART server configurations with the specific database server configurations. @@ -149,8 +141,6 @@ Use the fields on the **Misc** tab to describe the miscellaneous properties of t After associating the BART server with a database server, you can review the backup and restore details for that server on the PEM dashboard. You can also perform operations such as restoring or deleting a backup that's listed on the dashboard. -![The BART Backup Dashboard](images/bart_backup_dashboard.png) - When you select a monitored BART server, details of all the associated database servers along with their backups and restore activities are displayed as a chart on the dashboard in the Backup and Restore Activities panel. You can filter the list of backups on criteria specified in the filter boxes (database server, activity, or duration). The Managed Database Servers panel displays a list of all the database servers managed by a BART server along with their high-level details. @@ -169,9 +159,7 @@ You can delete all the obsolete backups by selecting **Delete Obsolete**. You ca ## Scheduling BART backups -To create or manage a backup, select **Tools > Schedule Backup**. The dialog box header displays general execution information about the backup. Select the plus sign (+) to add information about a scheduled backup. Enter the backup details in the schedule definition dialog: - -![The Schedule Backup dialog - General options](images/BART_backup_scheduler_general.png) +To create or manage a backup, select **Tools > Schedule Backup**. The dialog box header displays general execution information about the backup. Select the plus sign (+) to add information about a scheduled backup. Enter the backup details in the schedule definition dialog. Use the **General** tab to describe the general properties of the backup: @@ -197,8 +185,6 @@ Use the **General** tab to describe the general properties of the backup: - Use the **pg_basebackup** field to specify whether to use the pg_basebackup utility for the backup. Typically, you use the pg_basebackup utility only for backing up the replica servers since you can't use it for incremental backups. -![The Schedule Backup dialog - (Schedule : General)](images/BART_backup_scheduler_schedule_general.png) - Provide scheduling details for the backup on the **Schedule** tab: - Use the **Enabled?** switch to indicate whether to enable the schedule. @@ -207,8 +193,6 @@ Provide scheduling details for the backup on the **Schedule** tab: - Use the calendar selector in the **End** field to specify the ending date and time for the schedule. -![The Schedule Backup dialog - (Schedule : Repeat)](images/BART_backup_scheduler_schedule_repeat.png) - Use the **Repeat** tab to specify the details about the schedule in a cron-style format. The schedule executes on each date or time element selected on the **Repeat** tab. Click in a field to open a list of valid values for that field. Select a specific value to add that value to the list of selected values for the field. Use the fields in the **Days** box to specify the days when the schedule executes: @@ -225,8 +209,6 @@ Use the fields in the **Times** box to specify the times when the schedule execu - Use the **Minutes** field to select the minute when the schedule executes. -![The Schedule Backup dialog box - (Schedule : Notifications)](images/BART_backup_scheduler_schedule_notifications.png) - Use the **Notifications** tab to specify the email notification settings for a scheduled backup: - Use the **Send the notifications** field to specify when to send the email notifications. @@ -239,16 +221,12 @@ Use the Schedule Obsolete Backup Deletion dialog box to schedule or modify a BAR Use the context menu from the database server where BART was configured. -![Schedule Obsolete Backup dialog - General Tab](images/BART_obsolete_backup_scheduler_general.png) - Provide information on the **General** tab to describe the scheduling details: - Use the **Enabled?** switch to indicate whether to enable the schedule. - Use the calendar selector in the **Start** field to specify the starting date and time for the schedule. - Use the calendar selector in the **End** field to specify the ending date and time for the schedule. -![Schedule Obsolete Backup dialog - Repeat tab](images/BART_obsolete_backup_scheduler_repeat.png) - Use the **Repeat** tab to specify the details about the schedule in a cron-style format. The schedule executes on each date or time element selected on the **Repeat** tab. Click in a field to open a list of valid values. Select a value to add it to the list of selected values for the field. Use the fields in the **Days** box to specify the days when the schedule executes: @@ -268,8 +246,6 @@ You can restore the backups that you created earlier using BART server on a targ To restore a backup, select **Restore** next to the backup that you want to restore. -![The Restore Backup dialog - General](images/BART_backup_restore_general.png) - In the Restore Backup dialog box, provide information in the fields on the **General** tab: - Use the **Target agent** field name to specify the name of the agent where you want to restore the backup. @@ -286,8 +262,6 @@ In the Restore Backup dialog box, provide information in the fields on the **Gen - Use the **Setup passwordless SSH?** switch to specify if you want to create SSH certificates to allow passwordless logins between the BART server and the target host for restore. -![The Restore Backup dialog - Advanced](images/BART_backup_restore_advanced.png) - On the **Advanced** tab, specify your preferences for advanced options for restoring the backup: - Use the **Copy WALs to restore path?** switch to specify if you want to copy WAL files to the restore path. @@ -303,8 +277,6 @@ On the **Advanced** tab, specify your preferences for advanced options for resto !!! Note You can specify either **Transaction ID** or **Timestamp** for the point-in-time recovery. -![The Restore Backup dialog - Notifications](images/BART_backup_restore_notifications.png) - Use the **Notifications** tab to specify the email notification settings for restoring the backup: - Use the **Send the notifications** field to specify when you want to send the email notifications. diff --git a/product_docs/docs/pem/8/managing_database_server.mdx b/product_docs/docs/pem/8/managing_database_server.mdx index b3cb4c01fc5..61be6c593a8 100644 --- a/product_docs/docs/pem/8/managing_database_server.mdx +++ b/product_docs/docs/pem/8/managing_database_server.mdx @@ -25,8 +25,6 @@ PEM lets you start up and shut down managed server instances with the PEM client After connecting to the server, you can start or stop the server by selecting the server name in the tree and selecting **Tools > Queue Server Startup** or **Tools > Queue Server Shutdown**. -![The Tools menu of a managed server](images/pem_server_tools_menu_queue_server.png) - ## Modifying the pg_hba.conf file @@ -72,8 +70,6 @@ To create a database in PEM, right-click any managed server’s **Databases** no For example, to create a table, right-click a **Tables** node and select **Create > Table**. Specify the attributes of the table in the New Table dialog box. -![Create Table - General Tab](images/table_general.png) - PEM provides similar dialog boxes for creating and managing other database objects such as: - Tables diff --git a/product_docs/docs/pem/8/managing_pem_agent.mdx b/product_docs/docs/pem/8/managing_pem_agent.mdx index c0d932887fa..d0584b566e2 100644 --- a/product_docs/docs/pem/8/managing_pem_agent.mdx +++ b/product_docs/docs/pem/8/managing_pem_agent.mdx @@ -25,8 +25,6 @@ You can configure email notification settings at job level only for a custom age - For a new agent job, you can configure the email notification settings in the **Notification** tab of the Create Agent Job wizard while creating the job. - For an existing custom job, you can edit the properties of the job and configure the notification settings. -![Configure Job Notification - Job level](images/job_notifications_job_level.png) - Use the **Notifications** tab to configure the email notification settings on job level: - Use the **Send the notifications** field to specify when you want to send the email notifications. @@ -34,9 +32,7 @@ Use the **Notifications** tab to configure the email notification settings on jo ### Configuring job notifications at agent level -Select the agent in the tree view, right-click, and select **Properties**. In the Properties dialog box, select the **Job notifications** tab. - -![Configure Job Notification - Agent level](images/job_notifications_agent_level.png) +Select the agent in the tree view, right-click, and select **Properties**. In the Properties dialog box, select the **Job Notifications** tab. Use the Job notifications tab to configure the email notification settings at agent level: @@ -49,8 +45,6 @@ Use the Job notifications tab to configure the email notification settings at ag You can use the Server Configuration dialog box to provide information about your email notification configuration at PEM server level. To open the Server Configuration dialog box, select **Management > Server Configuration**. -![Configure Job Notification - Server level](images/job_notifications_server_level.png) - Four server configuration parameters specify information about your job notification preferences at PEM server level: - Use the **job_failure_notification** switch to specify if you want to send an email notification after each job failure. @@ -66,19 +60,13 @@ To create or manage a PEM scheduled job, use the PEM tree to browse to the PEM a Use the tabs on the Create - Agent Job dialog box to define the steps and schedule that make up a PEM scheduled job. -![Create Agent Job - General tab](images/create_pem_jobs_general.png) - Use the **General** tab to provide general information about a job: - Provide a name for the job in the **Name** field. - Set the **Enabled** switch to **Yes** to enable a job. Set it to **No** to disable a job. - Use the **Comment** field to store notes about the job. -![Create Agent Job - Steps tab](images/create_pem_jobs_steps.png) - -Use the **Steps** tab to define and manage the steps that the job performs. Select **Add** (+) to add a step. Then, select the compose icon, located at the left side of the header, to open the Step Definition dialog box: - -![Create Agent Job - Steps tab - General tab](images/create_pem_jobs_steps_definition.png) +Use the **Steps** tab to define and manage the steps that the job performs. Select **Add** (+) to add a step. Then, select the compose icon, located at the left side of the header, to open the Step Definition dialog box. Use the Step Definition dialog box to define the step: @@ -104,8 +92,6 @@ Use the Step Definition dialog box to define the step: - Use the **Comment** field to provide a comment about the step. -![Create Agent Job - Steps tab - Code tab](images/create_pem_jobs_steps_definition_code.png) - - Use the context-sensitive field on the Step Definition dialog box **Code** tab to provide the SQL code or batch script to execute during the step: - If the step invokes SQL code, provide one or more SQL statements in the **SQL query** field. @@ -120,9 +106,7 @@ After providing all the information required by the step, select **Save**. Select **Add** (+) to add each step, or select the **Schedules** tab to define the job schedule. -On the **Schedules** tab, select **Add** (+) to add a schedule for the job. Then select the compose icon located at the left side of the header to open the Schedule Definition dialog box: - -![Create Agent Job - Schedules tab - General tab](images/create_pem_jobs_schedules.png) +On the **Schedules** tab, select **Add** (+) to add a schedule for the job. Then select the compose icon located at the left side of the header to open the Schedule Definition dialog box. Use the **Schedules definition** tab to specify the days and times for the job to execute. @@ -134,8 +118,6 @@ Use the **Schedules definition** tab to specify the days and times for the job t Select the **Repeat** tab to define the days when the schedule executes in a cron-style format. The job executes on each date or time element selected on the **Repeat** tab. -![Create Agent Job - Schedules tab - Repeat tab](images/create_pem_jobs_schedules_repeat.png) - In each field, select a value to add it to the list of selected values for the field. To clear the values from a field, select the X located at the right-side of the field. - Use the fields in the **Days** box to specify the days when the job executes: @@ -146,8 +128,6 @@ In each field, select a value to add it to the list of selected values for the f Select the **Exceptions** tab to specify any days when you don't want the schedule to execute. For example, you might not want to run jobs on holidays. -![Create Agent Job - Schedules tab - Exceptions tab](images/create_pem_jobs_schedules_exceptions.png) - Select **Add** (+) to add a row to the exception table. Then: - In the **Date** column, open a calendar selector and select a date when you don't want the job to execute. Specify ****<Any>**** to indicate that you don't want the job to execute on any day at the time selected. @@ -155,15 +135,11 @@ Select **Add** (+) to add a row to the exception table. Then: Select the **Notifications** tab to configure the email notification settings on job level: -![Create Agent Job - Notifications tab](images/create_pem_jobs_notifications.png) - - Use the **Send the notifications** field to specify when you want to send the email notifications. - Use the **Email group** field to specify the email group to send the email notification to. When you finish defining the schedule, you can use the **SQL** tab to review the code that creates or modifies your job. -![Create Agent Job - SQL tab](images/create_pem_jobs_sql.png) - Select **Save** to save the job definition. After you save a job, the job is listed under the **Jobs** node of the PEM tree of the server on which it was defined. The **Properties** tab in the PEM console displays a high-level overview of the selected job, and the **Statistics** tab shows the details of each run of the job. To modify an existing job or to review detailed information about a job, right-click a job name, and select **Properties** from the context menu. @@ -299,8 +275,6 @@ The registry contains the entries shown in the table. The PEM Agent Properties dialog box provides information about the PEM agent from which the dialog box was opened. To open the dialog box, right-click an agent name in the PEM client tree and select **Properties** from the context menu. -![PEM Agent Properties dialog box - General tab](images/pem_agent_properties.png) - Use the PEM Agent Properties dialog box to review or modify information about the PEM agent: - The **Description** field displays a modifiable description of the PEM agent. This description is displayed in the tree of the PEM client. @@ -311,8 +285,6 @@ Use the PEM Agent Properties dialog box to review or modify information about th - The **Heartbeat interval** fields display the length of time that elapses between reports from the PEM agent to the PEM server. Use the selectors next to the **Minutes** or **Seconds** fields to modify the interval. - ![PEM Agent Properties dialog box - Job Notifications tab](images/pem_agent_job_notification_properties.png) - Use the **Job Notifications** tab to configure the email notification settings on agent level: - Use the **Override default configuration?** switch to specify if you want the agent level job notification settings to override the default job notification settings. Select **Yes** to enable the rest of the settings on this dialog box to define when and to whom to send the job notifications. @@ -320,8 +292,6 @@ Use the PEM Agent Properties dialog box to review or modify information about th - Use the **Email on a job failure?** switch to specify whether to send the job notification when the job fails. - Use the **Email group** field to specify the email group to send the job notification to. - ![PEM Agent Properties dialog box - Agent Configurations tab](images/pem_agent_configurations_properties.png) - The **Agent Configurations** tab displays all the current configurations and capabilities of an agent. - The **Parameter** column displays a list of parameters. diff --git a/product_docs/docs/pem/8/managing_pem_server.mdx b/product_docs/docs/pem/8/managing_pem_server.mdx index 016f9e468e9..70ea10fed32 100644 --- a/product_docs/docs/pem/8/managing_pem_server.mdx +++ b/product_docs/docs/pem/8/managing_pem_server.mdx @@ -28,8 +28,6 @@ The PEM agent is controlled by a service named pemagent. The Windows operating system includes a graphical service controller that displays the server status and offers interactive server control. You can access the Services utility through the Windows Control Panel. When the utility opens, navigate through the listed services and select the service name. -![The PEM service in the Windows Services window](images/pem_services_windows_server_agent.png) - Select **Stop**, **Pause**, **Start**, or **Restart** to control the state of the service. Any user or client application connected to the Postgres server is abruptly disconnected if you stop the service. For more information about controlling a service, see [EDB Postgres Advanced Server](/epas/latest/). @@ -75,8 +73,6 @@ Where `x` indicates the server version number. In the Windows Control Panel, open the Services utility to see the list of services. -![The Windows Services window](images/pem_services_windows_server_agent.png) - Select **Stop the service** to stop a service. Any user or client application connected to the server is abruptly disconnected if you stop the service. Select **Pause the service** to reload a service's configuration parameters. **Pause the service** is an effective way to reset parameters without disrupting user sessions for many of the configuration parameters. @@ -105,8 +101,6 @@ systemctl start httpd On Windows, you can use the Services applet to check the status of the PEM HTTPD service. After opening the Services applet, select the PEM HTTPD service from the list. -![The PEM HTTPD Windows service](images/pem_services_httpd.png) - The Status column displays the current state of the server. Select **Start** to start PEM HTTPD if the service isn't running. ## Managing PEM authentication @@ -143,8 +137,6 @@ For more information about the authentication methods supported by Postgres, see You can use the PEM client to manage the configuration parameters of the PEM server to enable features or modify default settings. To open the Server Configuration dialog box, select **Management > Server Configuration**. Then edit the parameter values as needed. -![The Server Configuration dialog](images/pem_server_config.png) - ## Managing security PEM provides an interface for managing your Postgres roles and servers. @@ -161,8 +153,6 @@ To use the Create – Login/Group Role dialog box to create a role: 1. Use the tabs of the Create – Login/Group Role dialog box to define the role. 1. After you finish defining the new role, select **Save** to create the role. -![Create Login Role - General tab](images/role_general.png) - To modify the properties of an existing login role, right-click the name of a login role in the tree and select **Properties** from the context menu. To delete a login role, right-click the name of the role and select **Delete/Drop** from the context menu. For more complete information about creating and managing a role, see the [PostgreSQL online documentation](http://www.postgresql.org/docs/current/sql-createrole.html). @@ -177,8 +167,6 @@ Use the **Group Roles** node (located beneath the name of each registered server You can use the Login/Group Role dialog box to allow a role with limited privileges to access PEM features such as the Audit Manager, Capacity Manager, or SQL Profiler. PEM predefined roles allow access to PEM functionality. Roles that are assigned membership in these roles can access the associated feature. -![Create Login Role - Membership tab](images/role_membership.png) - When defining a user, use the **Membership** tab to specify the roles in which the new user is a member. The new user shares the privileges associated with each role in which it is a member. For a user to have access to PEM extended functionality, the role must be a member of the pem_user role and the predefined role that grants access to the feature. Use the **Roles** field to select predefined role names from a list. The **SQL** tab displays the SQL command that the server executes when you select **Save**. diff --git a/product_docs/docs/pem/8/monitoring_barman.mdx b/product_docs/docs/pem/8/monitoring_barman.mdx index 75628398b45..bb0cead8a87 100644 --- a/product_docs/docs/pem/8/monitoring_barman.mdx +++ b/product_docs/docs/pem/8/monitoring_barman.mdx @@ -33,8 +33,6 @@ You can configure and edit your Barman server using: You can use the Create–BARMAN Server dialog box to register an existing Barman server with the PEM server. To open the dialog box, right-click the BARMAN Servers node and select **Create-BARMAN Server**. -![Create-BARMAN server dialog - General tab](images/create_barman_server_general.png) - Use the **General** tab to describe the general properties of the Barman server: - Use the **Name** field to specify a name for the server. The name identifies the server in the browser tree. @@ -43,8 +41,6 @@ Use the **General** tab to describe the general properties of the Barman server: - Use the **Team** field to specify a PostgreSQL role name. Only PEM users who are members of this role, who created the server initially, or have superuser privileges on the PEM server can see this server when they log on to PEM. If this field is left blank, all PEM users see the server. -![Create-BARMAN server dialog - PEM Agent tab](images/create_barman_server_pem_agent.png) - Use the **PEM Agent** tab to specify connection details for the PEM Agent: - Use the **Bound Agent** field to select the agent that you want to configure as a Barman server. Only those PEM agents that are supported for Barman are listed. @@ -60,16 +56,10 @@ Use the **PEM Agent** tab to specify connection details for the PEM Agent: To edit your Barman server, right-click the server from the browser tree and select **Properties**. -![BARMAN server properties - General tab](images/barman_server_properties_general.png) - - Use the **PEM Agent** tab to modify the bound agent, probe frequency, and heartbeat. Only the owner of the Barman server can modify the fields on the **PEM Agent** tab. -![BARMAN server properties - Information tab](images/barman_server_properties_information.png) - - Use the **Information** tab to view the detailed information about your Barman server. This tab gets populated whenever the Barman related probes are executed. -![BARMAN server properties - Configuration tab](images/barman_server_properties_configuration.png) - - Use the **Configuration** tab to view the configuration settings of your Barman server. This tab gets populated whenever the Barman related probes are executed. ### Using pemworker command line @@ -127,10 +117,6 @@ When you select a monitored Barman server, details of all the associated databas The Servers panel displays a list of all the database servers managed by that Barman server along with the active status. -![BARMAN dashboard - Servers panel](images/barman_dashboard_servers.png) - The Backups panel displays a list of all the database server backups managed by that Barman server. You can filter the list to display the details of any database server. You can also filter the list on any criteria that you specify in the filter box. Typically, this filter works with any kind of string value (excluding date, time, and size) listed under the columns. For example, you can enter `tar` to filter the list and display only those backups that are in tar format. Backup details include the Backup ID, Server, Mode, Start time, End time, Size, Error, and Status column. - -![BARMAN dashboard - Backups panel](images/barman_dashboard_backups.png) diff --git a/product_docs/docs/pem/8/monitoring_failover_manager.mdx b/product_docs/docs/pem/8/monitoring_failover_manager.mdx index 38996079def..f1ec787d33b 100644 --- a/product_docs/docs/pem/8/monitoring_failover_manager.mdx +++ b/product_docs/docs/pem/8/monitoring_failover_manager.mdx @@ -43,27 +43,16 @@ The Failover Manager Node Status table displays information about each node of t You can use the PEM client to replace the primary node of a Failover Manager cluster with a replica node. To start the failover process, select **Tools > Server > Replace Cluster Primary**. You are prompted to confirm that you want to replace the current primary node. -![Replacing the Primary node of a cluster](images/fm_replace_primary.png) - Select **Yes** to remove the current primary node from the Failover Manager cluster and promote a replica node to the role of read/write primary node in a Failover Manager cluster. The node with the highest promotion priority (defined in Failover Manager) becomes the new primary node. PEM reports the job status. -![Confirmation of the promotion](images/fm_job_result.png) - When the job completes and the Streaming Replication Analysis dashboard refreshes, you can review the Failover Manager Node Status table to confirm that a replica node was promoted to the role of primary in the Failover Manager cluster. ## Switchover EFM cluster -You can use the PEM client to replace the primary node of a Failover Manager cluster with a replica node. To start the switchover process, select **Tools > Switchover EFM Cluster**. You are prompted to confirm that you want to switch over EFM cluster. - -![Switchover EFM Cluster](images/fm_switchover_cluster.png) +You can use the PEM client to replace the primary node of a Failover Manager cluster with a replica node. To start the switchover process, select **Tools > Switchover EFM Cluster**. You are prompted to confirm that you want to switch over EFM cluster. Select **Yes** to: -Select **Yes** to: - Start the Failover Manager switchover. - Promote a replica node to the role of read/write primary node. - Reconfigure the primary database as a new replica in a Failover Manager cluster. -The node with the highest promotion priority (defined in Failover Manager) becomes the new primary node. PEM reports the job status. - -![Confirmation of the promotion](images/fm_switchover_job_result.png) - -When the job completes and the Streaming Replication Analysis dashboard refreshes, you can review the Failover Manager Node Status table to confirm that a switchover occurred. +The node with the highest promotion priority (defined in Failover Manager) becomes the new primary node. PEM reports the job status. When the job completes and the Streaming Replication Analysis dashboard refreshes, you can review the Failover Manager Node Status table to confirm that a switchover occurred. diff --git a/product_docs/docs/pem/8/monitoring_performance/alerts.mdx b/product_docs/docs/pem/8/monitoring_performance/alerts.mdx index afbd6ad7e2f..70e4286c53d 100644 --- a/product_docs/docs/pem/8/monitoring_performance/alerts.mdx +++ b/product_docs/docs/pem/8/monitoring_performance/alerts.mdx @@ -36,8 +36,6 @@ The Alert Errors table shows configuration-related errors, such as accidentally You can customize tables and charts that appear on the Alerts dashboard. To customize a table or chart, select **Settings** in the upper-right corner. -![Customizing a chart](../images/personalize_chart.png) - Use fields on the Personalize Chart Configuration dialog box to provide your display preferences: - Use the **Auto Refresh** field to specify the number of seconds between updates of the data displayed in the table or chart. @@ -70,16 +68,12 @@ An alert template is a prototype that defines the properties of an alert. An ale You can use the **Alert Templates** tab to define a custom alert template or view the definitions of existing alert templates. To open the **Alert Templates** tab, select **Management > Manage Alerts**. From the **Manage Alerts** tab, on the Quick Links toolbar, select **Alert Templates**. -![The Alert Templates tab](../images/pem_alert_templates_tab.png) - Use the **Show System Template** list to filter the alert templates that are displayed in the Alert Templates table. From the list, select a level of the PEM hierarchy to view all of the templates for that level. ### Defining a new alert template To define a new alert template, from the **Show System Template** list, select **None**. Then click the plus sign (+) in the upper-right corner of the alert template table. The alert template editor opens. -![The General tab](../images/pem_alert_templates_general.png) - Use fields on the **General** tab to specify general information about the template: - Use the **Template name** field to specify a name for the new alert template. @@ -107,16 +101,12 @@ Use fields on the **General** tab to specify general information about the templ - Use the **Check frequency** field to specify the default number of minutes between alert executions. This value specifies how often the server invokes the SQL code specified in the definition and compares the result to the threshold value specified in the template. -![The Probe Dependency tab of the Alert Templates dialog](../images/pem_alert_templates_pdtab.png) - Use the fields on the **Probe Dependency** tab to specify the names of probes referred to in the SQL query specified on the **SQL** tab: - Use the **Probes** list to select from a list of the available probes. - To add the probe to the list of probes used by the alert template, select a probe name and select **Add**. - To remove a probe from the selected probes list, select the probe name and select **Delete**. -![The Parameters tab of the Alert Templates dialog](../images/pem_alert_templates_paramtab.png) - - Use the **Parameters** tab to define the parameters to use in the SQL code specified on the **SQL** tab. Select the plus sign (+). Then: - Use the **Name** field to specify the parameter name. @@ -127,8 +117,6 @@ Use the fields on the **Probe Dependency** tab to specify the names of probes re - Use the **Code** field on the **SQL** tab to provide the text of the SQL query for the server to invoke when executing the alert. The SQL query provides the result against which to compare the threshold value. If the alert result deviates from the specified threshold value, an alert is raised. -![The SQL tab of the Alert Templates dialog](../images/pem_alert_templates_sqltab.png) - In the query, reference parameters defined on the **Parameters** tab sequentially by using the variable param\_`x`. The `x` indicates the position of the parameter definition in the parameter list. For example, param_1 refers to the first parameter in the parameter list, param_2 refers to the second parameter in the parameter list, and so on. The query can also include the following variables: @@ -162,38 +150,26 @@ To save the alert template definition and add the template name to the Alert Tem To export the alert template: 1. Select any alert template from the **Alert Templates** tab. 1. Select **Export** in the upper-right corner of the table. -1. Select the **Save File** option. +1. Select **Save File**. 1. To generate the JSON file, select **OK**. -![Alert Templates Export](../images/alert_template_export.png) - To import the Alert Template: 1. On the **Alert Templates** tab, select **Import** in the upper-right corner. - ![Alert Templates Import](../images/alert_template_import.png) - 1. To select the JSON file with the code import, select **Browse**, and then select **Import**. - ![Alert Templates Import Browse](../images/alert_template_import_browse.png) - 1. After selecting the file to import, you can select the following check boxes: - - **skip existing** — Skip the alert template if it already exists. - - - **skip existing dependent probe** — The alert templates depend on probes. Select this check box to skip the dependent probe if it already exists. + - **Skip existing** — Skip the alert template if it already exists. - If both the check boxes are selected and the alert template already exists, then it skips importing the alert template with this message: + - **Skip existing dependent probe** — The alert templates depend on probes. Select this check box to skip the dependent probe if it already exists. - ![Alert Templates Skip Both](../images/alert_template_skip_both.png) + If both the check boxes are selected and the alert template already exists, then it skips importing the alert template. - If the **skip existing** checkbox isn't selected, **skip dependent probe** is selected, and the alert template already exists, then it imports the alert template successfully: + If you don't select the **Skip existing** check box, select **Skip dependent probe**, and the alert template already exists, then the alert template imports successfully. - ![Alert Templates Skip Dependent Probe](../images/alert_template_skip_dependent_probe.png) - - If both the check boxes are cleared and the alert template doesn't exist, then it successfully imports the alert template: - - ![Alert Template Import Successful](../images/alert_template_import_successful.png) + If both the check boxes are cleared and the alert template doesn't exist, then it successfully imports the alert template. ### Modifying or deleting an alert template @@ -201,7 +177,7 @@ To view the definition of an existing template (including PEM predefined alert t Select a template name in the list, and select **Edit** at the left end of the row to review the template definition. -Use the tabs on the Alert Templates dialog box to view detailed information about the alert template: +Use the Alert Templates dialog box to view detailed information about the alert template: - The **General** tab displays general information. - The **Probe Dependency** tab lists the names of probes that provide data for the template. @@ -506,9 +482,7 @@ The **Manage Alerts** tab displays a table of alerts that are defined on the obj ![The Manage Alerts tab](../images/alerting_manage_alerts.png) -To open the alert editor and create an alert, select the plus sign (+) in the upper-right corner of the table. The editor opens. - -![The General tab of the alert editor](../images/alerting_define_new_alert.png) +To open the alert editor and create an alert, select the plus sign (+) in the upper-right of the table. The editor opens. Use the fields on the **General** tab to provide information about the alert: @@ -530,24 +504,18 @@ The Parameter Options table contains a list of parameters that are required by t PEM can send a notification or execute a script if an alert is triggered or if an alert is cleared. Use the **Notification** tab to specify how PEM behaves if an alert is raised. -![The alert editor Notification tab](../images/alerting_define_notification.png) - Use the **Email notification** box to specify the email group to receive an email notification if the alert is triggered at the specified level. Use the [Email Groups](notifications/#creating-an-email-group) tab to create an email group that contains the address of the users to notify when an alert is triggered. To access the **Email Groups** tab, select **Email Groups** located in the **Quick Links** menu of the **Manage Alerts** tab. - To instruct PEM to send an email when a specific alert level is reached, set the slider next to an alert level to **Yes**. Use the list to select the predefined user or group to notify. You must configure the PEM server to use an SMTP server to deliver email before PEM can send email notifications. -![The alert editor Notification webhook tab](../images/alerting_define_notification_webhook.png) - Use the **Webhook notification** box to specify one or multiple endpoints if the alert is triggered at the specified level. Use the [webhooks tab](notifications/#webhook) to create a webhook endpoint to receive the notifications when an alert is triggered. To access the **Webhooks** tab, select **Webhooks** located in the **Quick Links** menu of the **Manage Alerts** tab. - Set **Enable?** to **Yes** to send the alert notifictions to the webhook endpoint. - Set **Override default configuration?** to **Yes** to set the customized alert levels as per the requirement. Once it's set to **Yes**, all the alert levels are enabled to configure. - Use the list to select a predefined endpoint to send a notification to for **Low alerts?**, **Medium alerts?**, **High alerts?**, and **Cleared alerts?**. -![The alert editor Notification SNMP tab](../images/alerting_define_notification_snmp.png) - Use the **Trap notification** options to configure trap notifications for this alert: - Set **Send trap** to **Yes** to send SNMP trap notifications when the state of this alert changes. @@ -558,15 +526,11 @@ You must configure the PEM server to send notifications to an SNMP trap/notifica While sending SNMP v3 traps, the agent creates the `snmp_boot_counter` file. This file is created in the location mentioned by the `batch_script_dir` parameter in `agent.cfg`. If this parameter isn't configured or if the directory isn't accessible due to authentication restrictions, then the file is created in the operating system temporary directory. If that's also not possible, then the file is created in your home directory. -![The alert editor Notification Nagios tab](../images/alerting_define_notification_nagios.png) - Use the **Nagios notification** box to instruct the PEM server to notify Nagios network-alerting software when the alert is triggered or cleared. For more details, see [Using PEM with Nagios](notifications/#using-pem-with-nagios) -- Set the **Submit passive service check result to Nagios** switch to **Yes** to instruct the PEM server to notify Nagios when the alert is triggered or cleared. +- Set the **Submit passive service check result to Nagios** switch to **Yes** to notify Nagios when the alert is triggered or cleared. -![The alert editor script execution tab](../images/alerting_define_script_execution.png) - -Use the **Script execution** box to optionally define a script that executes if an alert is triggered and to specify details about the script execution. +- Use the **Script execution** box to optionally define a script that executes if an alert is triggered and to specify details about the script execution. - Set the **Execute script** slider to **Yes** to instruct PEM to execute the provided script if an alert is triggered. @@ -628,8 +592,6 @@ To discard your changes, select **Refresh**. A message prompts you to confirm th Use the Alerts table to manage an existing alert or create a new alert. Select an object in the PEM client tree to view the alerts that monitor that object. -![The Alerts table](../images/alerting_manage_alerts_table.png) - You can modify some properties of an alert in the Alerts table: - The Alert name column displays the name of the alert. To change the alert name, replace the name in the table and select **Save**. @@ -642,16 +604,12 @@ After modifying an alert, select **Save** (located in the upper-right corner of To modify other alert attributes, select **Edit** to the left of an alert name to open an editor. The editor provides access to the complete alert definition. -![The Alert details dialog](../images/alert_details.png) - Use the Alert Details dialog box to modify the definition of the selected alert. After you modify the alert definition, select **Save**. ## Deleting an alert To mark an alert for deletion, select the alert name in the Alerts table. Then select **Delete** to the left of the name. The alert remains in the list in red strike-through font. -![Deleting an alert](../images/alerting_manage_alerts_delete.png) - **Delete** is a toggle. You can undo the deletion by selecting it a second time. To permanenetly dete the alert defintion, select **Save**. ## Copying an alert @@ -660,8 +618,6 @@ To speed up the deployment of alerts in the PEM system, you can copy alert defin To copy alerts from an object, select the object in the PEM client tree on the main PEM window. Then, select **Management > Copy Alerts**. On the **Manage Alerts** tab, from the Quick Links toolbar, select **Copy Alerts**. -![The Copy Alert Configuration dialog](../images/alert_copy.png) - The Copy Alert Configuration dialog box copies all alerts from the object selected in the PEM client tree to the objects selected on the dialog box. Expand the tree to select nodes to specify as the target objects. The tree displays a red warning indicator next to the source object. To copy alerts to multiple objects at once, select a parent node of the targets. For example, to copy the alerts from one table to all tables in a schema, select the check box next to the schema. PEM copies alerts only to targets that are the same type as the source object. @@ -676,13 +632,9 @@ You can use the **Management > Schedule Alert Blackout** to schedule an alert bl To schedule an alert blackout, select **Management > Schedule Alert Blackout**. -![PEM Management Menu](../images/pem_management_menu.png) - -In the Schedule Alert Blackout dialog box, use the tabs to define the blackout period for servers and agents. On the **Server**, to add a row, select the plus sign (+) at the top-right corner. +In the Schedule Alert Blackout dialog box, use the tabs to define the blackout period for servers and agents. On the **Server** tab, to add a row, select the plus sign (+) at the top-right corner. -![Schedule Alert Blackout - Server tab](../images/pem_alert_blackout_server_tab.png) - -Use the **Server** tab to provide information about an alert blackout period. After you save the blackout period, you cannot edit it. +Use the **Server** tab to provide information about an alert blackout period. After you save the blackout period, you can't edit it. - Use the **Start time** field to provide the date and time to start the alert blackout. - Use the **Duration** field to provide the interval for which you want to black out the alerts. @@ -692,8 +644,6 @@ After providing details, select **Save**. The alerts don't appear on the Alerts You can also schedule a blackout period for PEM agents using the **Agent** tab on the dialog box. To add a row, on the **Agent** tab, select the plus sign (+) at the top-right corner. -![Schedule Alert Blackout - Agent tab](../images/pem_alert_blackout_agent_tab.png) - Use the **Agent** tab to provide the information about an alert blackout period. After you save the blackout period, you can't edit it. - Use the **Start time** field to provide the date and time to start the alert blackout. @@ -706,8 +656,6 @@ You can select **Clone** from the top-right corner of the dialog box to clone th Select **Delete** from the top-right corner of the dialog box to remove a scheduled alert blackout. Select the servers or agents and then select **Delete**. -![Schedule Alert Blackout - Select servers](../images/pem_alert_blackout_select_servers.png) - Select a server for which you want to delete the scheduled alert backout, and then select **Delete**. The server prompts for confirmation before deleting that row. You can select **Reset** to reset the details on the Alert Blackout dialog box to the default settings. Saved blackouts aren't affected. diff --git a/product_docs/docs/pem/8/monitoring_performance/audit_manager.mdx b/product_docs/docs/pem/8/monitoring_performance/audit_manager.mdx index 55825f4b653..3947fe4b234 100644 --- a/product_docs/docs/pem/8/monitoring_performance/audit_manager.mdx +++ b/product_docs/docs/pem/8/monitoring_performance/audit_manager.mdx @@ -39,8 +39,6 @@ Before adding a service name to an existing, registered and connected server, yo 1. Right-click the server name and select **Properties** from the context menu. 1. Select the **Advanced** tab, and add a service name to the **Service ID** field. -![The Service ID of the Advanced Server instance](../images/EPAS_instance.png) - The Service ID field allows the PEM server to stop and start the service. - The name of the EDB Postgres Advanced Server 11 service script is `edb-as-12`. @@ -56,118 +54,98 @@ The Service ID field allows the PEM server to stop and start the service. Before configuring audit logging of EDB Postgres Advanced Server servers, you must ensure that the EDB Audit Configuration probe is enabled. To open the **Manage Probes** tab and check the status of the probe, right-click the name of a registered EDB Postgres Advanced Server server in the tree, and select **Management > Manage Probes**. -Ensure that the Enabled column in the Probe Configuration dialog box is set to **Yes** for the EDB Audit Configuration probe. - -![The EDB Audit Configuration probe](../images/EDB_audit_config_probe.png) - -If EDB Audit Configuration isn't enabled, use the **Enabled?** switch on the **Manage Probes** tab to enable it. +Ensure that the Enabled column in the Probe Configuration dialog box is set to **Yes** for the EDB Audit Configuration probe. If EDB Audit Configuration isn't enabled, use the **Enabled?** switch on the **Manage Probes** tab to enable it. ## Configuring audit logging with the Audit Manager -To open the Audit Manager wizard, select **Management > Audit Manager**. The Audit Manager - Welcome dialog box opens. - -![The Audit Manager Welcome dialog](../images/audit_manager_intro.png) - -Select **Next** to continue. - -![Select the servers you wish to configure for auditing](../images/audit_manager_servers.png) - -Use the Select Servers tree to specify the servers to which to apply the auditing configuration. To make a server available in the tree, you must provide the Service ID on the **Advanced** tab of the Create – Server dialog box when registering a server for monitoring by PEM. Only EDB Postgres Advanced Server supports auditing. PostgreSQL servers don't appear in the tree. +1. To open the Audit Manager wizard, select **Management > Audit Manager**. The Audit Manager - Welcome dialog box opens. Select **Next** to continue. -Select **Next** to continue. +1. Use the Select Servers tree to specify the servers to which to apply the auditing configuration. To make a server available in the tree, you must provide the Service ID on the **Advanced** tab of the Create Server dialog box when registering a server for monitoring by PEM. Only EDB Postgres Advanced Server supports auditing. PostgreSQL servers don't appear in the tree. -The Auditing Parameters Configuration dialog box lets you enable or disable auditing and choose how often log records are collected into PEM. + Select **Next** to continue. -![The Auditing Parameters Configuration dialog](../images/audit_manager_config1.png) +1. The Auditing Parameters Configuration dialog box lets you enable or disable auditing and choose how often log records are collected into PEM. Use the Auditing Parameters Configuration dialog box to specify auditing preferences: -Use the Auditing Parameters Configuration dialog box to specify auditing preferences: + - Use the **Auditing** switch to enable or disable auditing on the specified servers. -- Use the **Auditing** switch to enable or disable auditing on the specified servers. + - Use the **Audit destination** list to select a destination for the audit logs. Select **File** or **Syslog**. This feature is supported only on EDB Postgres Advanced Server 10 and later releases. -- Use the **Audit destination** list to select a destination for the audit logs. Select **File** or **Syslog**. This feature is supported only on EDB Postgres Advanced Server 10 and later releases. + - Use the **Import logs to PEM** switch to periodically import log records from each server to the PEM Server. Set the switch to **Yes** to import log files. The default is **No**. -- Use the **Import logs to PEM** switch to periodically import log records from each server to the PEM Server. Set the switch to **Yes** to import log files. The default is **No**. + - Use the **Collection frequency** list to specify how often PEM collects log records from monitored servers when log collection is enabled. -- Use the **Collection frequency** list to specify how often PEM collects log records from monitored servers when log collection is enabled. + - Use the **Log format** list to select the raw log format to write on each server. If log collection is enabled, the PEM server uses CSV format. -- Use the **Log format** list to select the raw log format to write on each server. If log collection is enabled, the PEM server uses CSV format. + - Use the **File name** field to specify the format used when generating log file names. By default, the format is set to `audit-%Y-%m-%d_%H%M%S` where: -- Use the **File name** field to specify the format used when generating log file names. By default, the format is set to `audit-%Y-%m-%d_%H%M%S` where: + `audit` is the file name specified in the Audit Directory Name field + `Y` is the year that the log was stored + `m` is the month that the log was stored + `d` is the day that the log was stored + `H` is the hour that the log was stored + `M` is the minute that the log was stored + `S` is the second that the log was stored - `audit` is the file name specified in the Audit Directory Name field - `Y` is the year that the log was stored - `m` is the month that the log was stored - `d` is the day that the log was stored - `H` is the hour that the log was stored - `M` is the minute that the log was stored - `S` is the second that the log was stored + - Select **Change Log Directory for selected servers?** and use the **Audit Directory Name** field to specify a directory name to which to write the audit logs. The directory resides beneath the data directory on the PEM server. -- Select **Change Log Directory for selected servers?** and use the **Audit Directory Name** field to specify a directory name to which to write the audit logs. The directory resides beneath the data directory on the PEM server. + - Use the **Log directory** box to specify information about the directory in which the log files are saved: -- Use the **Log directory** box to specify information about the directory in which the log files are saved: + - Move the **Change log directory for selected servers?** switch to **Yes** to enable the **Directory name** field. - - Move the **Change log directory for selected servers?** switch to **Yes** to enable the **Directory name** field. + - Use the **Directory name** field to specify the name of the directory on each server to write audit logs to. The directory specified is created as a subdirectory of the data directory on the server. - - Use the **Directory name** field to specify the name of the directory on each server to write audit logs to. The directory specified is created as a subdirectory of the data directory on the server. + Select **Next** to continue. -Select **Next** to continue. +1. The Audit log configuration dialog box is available only if you enabled auditing on the Auditing Parameters Configuration dialog box. Use the Audit Log Configuration dialog box to specify log configuration details to apply to each server: -The Audit log configuration dialog box is available only if you enabled auditing on the Auditing Parameters Configuration dialog box. + - Use the **Connection attempts** switch to specify whether to log connection attempts. Specify: -![The Audit Log Configuration dialog](../images/audit_manager_config2.png) + **None** to disable connection logging -Use the Audit Log Configuration dialog box to specify log configuration details to apply to each server: + **All** to indicate that all connection attempts are logged -- Use the **Connection attempts** switch to specify whether to log connection attempts. Specify: + **Failed** to log any connection attempts that fail - **None** to disable connection logging + - Use the **Disconnection attempts** switch to specify whether to log disconnections. Specify: - **All** to indicate that all connection attempts are logged + **None** if you don't want to log disconnections - **Failed** to log any connection attempts that fail + **All** to enable disconnection logging -- Use the **Disconnection attempts** switch to specify whether to log disconnections. Specify: + - Use the **Log statements** field to specify the statement types that are logged. Select from: - **None** if you don't want to log disconnections + **Select** — Log all statements that include the `SELECT` keyword. - **All** to enable disconnection logging + **Error** — Log all statements that result in an error. -- Use the **Log statements** field to specify the statement types that are logged. Select from: + **DML** — Log all DML (data modification anguage) statements. - **Select** — Log all statements that include the `SELECT` keyword. - - **Error** — Log all statements that result in an error. - - **DML** — Log all DML (data modification anguage) statements. - - **DDL** — Log all DDL (data definition language) statements, that is, those that add, delete or alter data. + **DDL** — Log all DDL (data definition language) statements, that is, those that add, delete or alter data. - Select **Select All** to select all statement types. - - Select **Unselect All** to clear all statement types. + Select **Select All** to select all statement types. -- Use the **Audit tag** field to specify a tracking tag for the collected logs. Audit tagging functionality is available only for supported versions of EDB Postgres Advanced Server. + Select **Unselect All** to clear all statement types. -- Use the **Log rotation** box to specify how to manage the log files on each server: + - Use the **Audit tag** field to specify a tracking tag for the collected logs. Audit tagging functionality is available only for supported versions of EDB Postgres Advanced Server. - Use the **Enable?** switch to rotate log files. Use a new log file periodically to prevent a single file from becoming too large. + - Use the **Log rotation** box to specify how to manage the log files on each server: - Use the **Day** list to select days on which to rotate the log file. + Use the **Enable?** switch to rotate log files. Use a new log file periodically to prevent a single file from becoming too large. - Use the **Size (MB)** field to specify a size in megabytes at which to rotate the log file. + Use the **Day** list to select days on which to rotate the log file. - Use the **Time (seconds)** field to specify the number of seconds between log file rotations. + Use the **Size (MB)** field to specify a size in megabytes at which to rotate the log file. -Select **Next** to continue: + Use the **Time (seconds)** field to specify the number of seconds between log file rotations. -![The Schedule Auditing Changes dialog](../images/audit_manager_finish.png) + Select **Next** to continue: -Use the Schedule Auditing Changes dialog box to determine when auditing configuration changes take effect. +1. Use the Schedule Auditing Changes dialog box to determine when auditing configuration changes take effect. -- Select **Configure logging now?** if you want the auditing configuration changes to take place immediately. The affected database servers restart so the auditing changes can take effect. -- Use the **Time?** selector to schedule the auditing configuration changes to take place at some point in the future. Select the desired date and time from the lists. The affected database servers restart at the specified date and time to put the auditing changes into effect. + - Select **Configure logging now?** if you want the auditing configuration changes to take place immediately. The affected database servers restart so the auditing changes can take effect. + - Use the **Time?** selector to schedule the auditing configuration changes to take place at some point in the future. Select the desired date and time from the lists. The affected database servers restart at the specified date and time to put the auditing changes into effect. -Select **Finish** to complete the auditing configuration process. + Select **Finish** to complete the auditing configuration process. Audit Manager schedules a job to apply the configuration to each server. The job consists of two tasks: one to update the audit logging configuration on the server and one to restart the server with the new configuration. @@ -177,17 +155,11 @@ You can use the **Scheduled Tasks** tab to review a list of scheduled jobs. To o Use the Audit Log dashboard to view the audit log from EDB Postgres Advanced Server database instances. -To open the Audit Log dashboard, right-click a server or agent node and select **Audit Log Analysis** from the **Dashboards** menu. You can also open the Audit Log dashboard by navigating through the **Management > Dashboards** menu. +To open the Audit Log dashboard, right-click a server or agent node and select **Audit Log Analysis** from the **Dashboards** menu. The Audit Log dashboard displays the audit records in reverse chronological order. ![The Audit Log dashboard](../images/audit_log_analysis_dashboard.png) -The Audit Log dashboard displays the audit records in reverse chronological order. - -You can use filtering to limit the number of audit records that are displayed. Select **Show Filters** to expose the filters panel. - -![The Audit Log dashboard filters panel](../images/audit_log_analysis_filter.png) - -Use the filters panel to provide selection criteria for the audit records you want to display. +You can use filtering to limit the number of audit records that are displayed. Select **Show Filters** to expose the filters panel. Use the filters panel to provide selection criteria for the audit records you want to display. - Use the **Start** field to specify a start date for the report. - Use the **End** field to specify an end date for the report. diff --git a/product_docs/docs/pem/8/monitoring_performance/capacity_manager.mdx b/product_docs/docs/pem/8/monitoring_performance/capacity_manager.mdx index 5bea4d132e6..a1ae06e604a 100644 --- a/product_docs/docs/pem/8/monitoring_performance/capacity_manager.mdx +++ b/product_docs/docs/pem/8/monitoring_performance/capacity_manager.mdx @@ -18,13 +18,7 @@ You can tailor the content of the Capacity Manager report by choosing: You can also specify a start and end date for the Capacity Manager report. If the end date of the report specifies a time in the future, Capacity Manager analyzes the historical usage of the selected object to extrapolate the projected object usage in the future. -To open Capacity Manager, in the PEM client, select **Management > Capacity Manager**. The Capacity Manager wizard opens, displaying a tree on the **Metrics** tab. - -![Capacity Manager dialog](../images/capacity_manager_opens.png) - -On the **Metrics** tab, expand the tree to review the metrics for the node that you want to analyze. Select the metric to include it in your report. - -![Capacity Manager dialog - Metrics selection list](../images/capacity_manager_metrics.png) +To open Capacity Manager, in the PEM client, select **Management > Capacity Manager**. The Capacity Manager wizard opens, displaying a tree on the **Metrics** tab. On the **Metrics** tab, expand the tree to review the metrics for the node that you want to analyze. Select the metric to include it in your report. Capacity Manager uses the aggregation method specified with the **Aggregation** list. Capacity Manager uses the aggregation method to evaluate and plot the metric values. Select from: @@ -39,8 +33,6 @@ Move the slider next to **Graph/chart metrics individually?** to **Yes** to prod Select **Generate** to display the report onscreen (accepting the default configuration options), or use the **Options** tab to customize sampling boundaries, report type, and report destination. The times displayed on the **Options** tab are from the time zone where the PEM client resides. -![Specify the time period, type, and destination of the report](../images/capacity_manager_options.png) - Use the fields in the **Time Period** box to define the boundaries of the Capacity Manager report: - Use the **Period** list to select the type of time period to use for the report. You can select: @@ -79,8 +71,6 @@ Use the **Report destination** options to set where to display or save the repor After you specify the report boundaries and select the type and destination of the Capacity Manager report, select **Generate** to create the report. -![The Capacity Manager report](../images/capacity_manager_report.png) - 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. ## Capacity Manager templates @@ -88,12 +78,9 @@ Reports saved to file are stored as HTML. You can review a Capacity Manager repo After defining a report, you can save the definition as a template for future reports. All PEM users can access Capacity Manager report templates. To save a report definition as a template: 1. Use the **Metrics** and **Options** tabs to define your report. -2. Select **Save**. - -![Saving a Capacity Manager Template](../images/save_capacity_manager_template.png) - +1. Select **Save**. 1. In the **Save Template** dialog box, Provide a report name in the **Title** field and select a location to store the template in the tree. -2. Select **OK**. +1. Select **OK**. When creating a report, you can use **Load Template** to browse and open an existing template. Once opened, you can modify the report definition and save it again, either as a new template or by overwriting the original template. diff --git a/product_docs/docs/pem/8/monitoring_performance/charts.mdx b/product_docs/docs/pem/8/monitoring_performance/charts.mdx index 2f1ffa72d1b..f2a5669a921 100644 --- a/product_docs/docs/pem/8/monitoring_performance/charts.mdx +++ b/product_docs/docs/pem/8/monitoring_performance/charts.mdx @@ -6,21 +6,13 @@ redirects: You can use the **Manage Charts** tab to create or modify a custom line chart or table or to import a Capacity Manager template to use in a custom chart. After defining a chart, you can display the chart on a custom dashboard. -To open the **Manage Charts** tab, in the PEM client, select **Management > Manage Charts**. - -![The Manage Charts tab](../images/pem_manage_charts.png) - -The **Manage Charts** tab provides a Quick Links menu for accessing dialog boxes to: +To open the **Manage Charts** tab, in the PEM client, select **Management > Manage Charts**. The **Manage Charts** tab provides a Quick Links menu for accessing dialog boxes to: - Create a new chart for use on a custom dashboard. - Import a Capacity Manager template to use as a template for creating a custom chart. - Access online help. -The Custom Charts table displays a list of charts you defined. When a chart is new, the font is green. When you add a chart or refresh the screen, the font is black. - -![The Custom Charts table](../images/pem_manage_charts_custom_chart.png) - -Use the search box in the upper-right corner of the Custom Charts table to search through your custom charts. Specify: +The Custom Charts table displays a list of charts you defined. When a chart is new, the font is green. When you add a chart or refresh the screen, the font is black. Use the search box in the upper-right of the Custom Charts table to search through your custom charts. Specify: - Chart name - Type @@ -34,118 +26,100 @@ Use icons to the left of a chart name in the Custom Charts table to manage a cha ### Creating a custom chart -Select **Create New Chart** in the Quick Links section of the **Manage Charts** tab to open the Create Chart wizard. The wizard takes you through the steps required to define a new chart. - -![Specifying general information about the chart](../images/pem_create_new_chart_conf_chart.png) - -Use the fields on the Configure Chart dialog box to specify general information about the chart: - -- Specify the name of the chart in the **Name** field. -- Use the list in the **Category** field to specify the category in which to display this chart. When adding a custom chart to a custom dashboard, you can select the chart from the category specified. -- Use the **Type** field to specify if the chart is a line chart or a table. -- Provide a description of the chart in the **Description** field. The description is displayed on a custom dashboard when the user selects the information icon next to the chart. +Select **Create New Chart** in the Quick Links section of the **Manage Charts** tab to open the Create Chart wizard. The wizard takes you through the steps required to define a new chart. -After you complete the fields on the Configure Chart dialog box, select **Next**. +1. Use the Configure Chart dialog box to specify general information about the chart: -![Specifying the metrics to display](../images/pem_create_new_chart_select_metrics.png) + - Specify the name of the chart in the **Name** field. + - Use the list in the **Category** field to specify the category in which to display this chart. When adding a custom chart to a custom dashboard, you can select the chart from the category specified. + - Use the **Type** field to specify if the chart is a line chart or a table. + - Provide a description of the chart in the **Description** field. The description is displayed on a custom dashboard when the user selects the information icon next to the chart. -Use the fields on the Select Metrics dialog box to select the metrics to display on the chart. + After you complete the fields on the Configure Chart dialog box, select **Next**. -- Use the **Metric level** list to specify the level of the PEM hierarchy from which you want to select metrics. You can specify **Agent**, **Database**, or **Server**. Each level offers access to a unique set of probes and metrics. +1. Use the Select Metrics dialog box to select the metrics to display on the chart. -- Use the tree in the **Available metrics** box to select the metrics to display on the chart. + - Use the **Metric level** list to specify the level of the PEM hierarchy from which you want to select metrics. You can specify **Agent**, **Database**, or **Server**. Each level offers access to a unique set of probes and metrics. - If you're creating a table, you can select metrics from only one probe. Each node of the tree lists the metrics returned by a single probe. Expand a node of the tree and select the check box next to a metric name to include that metric data in the table. + - Use the tree in the **Available metrics** box to select the metrics to display on the chart. - If you're creating a line chart, expand the nodes of the tree and double-click each metric that you want to include in the chart. + If you're creating a table, you can select metrics from only one probe. Each node of the tree lists the metrics returned by a single probe. Expand a node of the tree and select the check box next to a metric name to include that metric data in the table. -- Use the Selected Metrics panel to specify how the metric data appears in your chart. The selection panel displays the name of the metric in the nonmodifiable Metric \[Probe] column. You can: + If you're creating a line chart, expand the nodes of the tree and double-click each metric that you want to include in the chart. - - Select the trash can to delete a metric from the list of selected metrics. - - Use the lists in the Selection Criteria column to specify the order of the data displayed. - - Use the **Limit** field to specify the number of rows in a table or lines in a chart: up to 32 lines and 100 rows. + - Use the Selected Metrics panel to specify how the metric data appears in your chart. The selection panel displays the name of the metric in the nonmodifiable Metric \[Probe] column. You can: -- If you're creating a line chart, PEM supports comparisons of cross-hierarchy metrics. + - Select the trash can to delete a metric from the list of selected metrics. + - Use the lists in the Selection Criteria column to specify the order of the data displayed. + - Use the **Limit** field to specify the number of rows in a table or lines in a chart: up to 32 lines and 100 rows. - - Select **Compare** to select one or more probe-specific attributes (such as CPUs, interfaces, and databases) to compare in the chart. - - Select **Copy** to apply your selections to all of the metrics for the same probe. + - If you're creating a line chart, PEM supports comparisons of cross-hierarchy metrics. -After you complete the fields on the Select Metrics dialog box, select **Next**. + - Select **Compare** to select one or more probe-specific attributes (such as CPUs, interfaces, and databases) to compare in the chart. + - Select **Copy** to apply your selections to all of the metrics for the same probe. -![Specifying chart options](../images/pem_create_new_chart_set_options.png) + After you complete the fields on the Select Metrics dialog box, select **Next**. -Use the Set Options dialog box to specify display options for your chart: +1. Use the Set Options dialog box to specify display options for your chart: -- Use the **Auto Refresh** field to specify the number of minutes between chart updates. Choose a value from 1 to 120. The default auto refresh rate is 2 minutes. + - Use the **Auto Refresh** field to specify the number of minutes between chart updates. Choose a value from 1 to 120. The default auto refresh rate is 2 minutes. -Use fields under **Line chart options** to specify display preferences for a line chart: + - Use fields under **Line chart options** to specify display preferences for a line chart: -- Use the **Points to plot** field to specify the maximum number of points to plot on the chart. -- Use the fields to the right of **Historical span** to specify how much historical data to display on the chart in days, hours, and minutes. + - Use the **Points to plot** field to specify the maximum number of points to plot on the chart. + - Use the fields to the right of **Historical span** to specify how much historical data to display on the chart in days, hours, and minutes. -Use the fields in the **Data extrapolation** box to specify whether PEM generates extrapolated data based on historical data: + - Use the fields in the **Data extrapolation** box to specify whether PEM generates extrapolated data based on historical data: -- Select **No Extrapolation** to omit extrapolated data from the chart. -- Select **Span** to use the **Days** and **Hours** selectors to specify the period of time spanned by the metrics on the chart. -- Select **Threshold** to use threshold selectors to specify a maximum or minimum value for the chart. + - Select **No Extrapolation** to omit extrapolated data from the chart. + - Select **Span** to use the **Days** and **Hours** selectors to specify the period of time spanned by the metrics on the chart. + - Select **Threshold** to use threshold selectors to specify a maximum or minimum value for the chart. -After you complete the fields in the Set Options dialog box, select **Next**. + After you complete the fields in the Set Options dialog box, select **Next**. -![Specifying access permissions](../images/pem_create_new_chart_set_options.png) +1. Use the Set Permissions dialog box to specify display options for your chart. -Use the Set Permissions dialog box to specify display options for your chart. + - Set the **Share with all** slider to **Yes** to make the chart available to all authorized users. Select **No** to restrict access to the users or groups specified in the **Access permissions** field. + - Use the **Access permissions** field to select the groups you want to give access to the chart to. -- Set the **Share with all** slider to **Yes** to make the chart available to all authorized users. Select **No** to restrict access to the users or groups specified in the **Access permissions** field. -- Use the **Access permissions** field to select the groups you want to give access to the chart to. - -![The chart definition is displayed on the Manage Charts tab](../images/pem_manage_charts_completed.png) - -After you finish defining the chart, select **Finish** to save your edits and add your chart to the list on the **Manage Charts** tab. + After you finish defining the chart, select **Finish** to save your edits and add your chart to the list on the **Manage Charts** tab. ### Importing a Capacity Manager template Select **Import Capacity Manager Template** in the Quick Links section of the **Manage Charts** tab to open the Create Chart dialog box and use a Capacity Manager template as a starting point for a chart or table. -![Importing a Capacity Manager template](../images/pem_manage_charts_imported_template.png) - -When the Create Chart dialog box opens, provide information about the custom chart: - -- Use the **Import capacity template** list to select the name of the template on which the chart is based. -- Specify the name of the chart in the **Name** field. -- Use the **Category** list to specify the category in which to display this chart. When adding a custom chart to a custom dashboard, you can select the chart from this category. -- Use the **Type** field to specify if the chart is a line chart or a table. -- Provide a description of the chart in the **Description** field. The description is displayed on the custom dashboard when user selects the information icon next to the chart. - -Select **Next**. - -![The template metrics](../images/pem_manage_charts_imported_metrics.png) +1. When the Create Chart dialog box opens, provide information about the custom chart: -The Select Metrics window allows you to review the metrics specified by the selected template. The bottom panel of the chart editor displays the metrics to include in the chart. You can't modify the metrics included in the chart using the chart editor. To modify the metrics, use the Capacity Manager utility to update the template. + - Use the **Import capacity template** list to select the name of the template on which the chart is based. + - Specify the name of the chart in the **Name** field. + - Use the **Category** list to specify the category in which to display this chart. When adding a custom chart to a custom dashboard, you can select the chart from this category. + - Use the **Type** field to specify if the chart is a line chart or a table. + - Provide a description of the chart in the **Description** field. The description is displayed on the custom dashboard when user selects the information icon next to the chart. -After you review the metrics, select **Next**. + Select **Next**. -![Selecting chart options](../images/pem_manage_charts_imported_options.png) +1. The Select Metrics window allows you to review the metrics specified by the selected template. The bottom panel of the chart editor displays the metrics to include in the chart. You can't modify the metrics included in the chart using the chart editor. To modify the metrics, use the Capacity Manager utility to update the template. -Use the Set Options window to specify display options for your chart: + After you review the metrics, select **Next**. -- Use the **Auto Refresh** field to specify the number of minutes between chart updates. Choose a value from 1 to 120. The default auto refresh rate is 2 minutes. +1. Use the Set Options window to specify display options for your chart: -Use the **Data extrapolation** box to specify the time period covered by the chart. You can either: + - Use the **Auto Refresh** field to specify the number of minutes between chart updates. Choose a value from 1 to 120. The default auto refresh rate is 2 minutes. -- Select **Historical days and extrapolated days** and provide: - - The number of days of historical data to chart in the **Historical** field. - - The number of projected days to chart in the **Extrapolated** field. -- Select **Historical days and threshold** and provide: - - The number of days of historical data to chart in the **Historical** field. - - The threshold value at which the chart ends. + - Use the **Data extrapolation** box to specify the time period covered by the chart. You can either: -After you complete the Set Options window, select **Next**. + - Select **Historical days and extrapolated days** and provide: + - The number of days of historical data to chart in the **Historical** field. + - The number of projected days to chart in the **Extrapolated** field. + - Select **Historical days and threshold** and provide: + - The number of days of historical data to chart in the **Historical** field. + - The threshold value at which the chart ends. -![Selecting permissions for the chart](../images/pem_manage_charts_imported_permissions.png) + After you complete the Set Options window, select **Next**. -Use the Set Permissions window to specify display options for your chart: +1. Use the Set Permissions window to specify display options for your chart: -- Set the **Share with all slider** to **Yes** to make the chart available to all authorized users. Set it to **No** to restrict access to the users or groups specified in the **Access permissions** field. -- Use the **Access permissions** field to select the groups to give access to the chart to. + - Set the **Share with all slider** to **Yes** to make the chart available to all authorized users. Set it to **No** to restrict access to the users or groups specified in the **Access permissions** field. + - Use the **Access permissions** field to select the groups to give access to the chart to. -After you finish defining the chart, select **Finish** to save your edits and add your chart to the list on the **Manage Charts** tab. + After you finish defining the chart, select **Finish** to save your edits and add your chart to the list on the **Manage Charts** tab. diff --git a/product_docs/docs/pem/8/monitoring_performance/dashboards.mdx b/product_docs/docs/pem/8/monitoring_performance/dashboards.mdx index 8493a6f9e01..c2bac628537 100644 --- a/product_docs/docs/pem/8/monitoring_performance/dashboards.mdx +++ b/product_docs/docs/pem/8/monitoring_performance/dashboards.mdx @@ -97,8 +97,6 @@ The Streaming Replication Analysis dashboard displays statistical information ab Options on the Dashboard Configuration dialog box allow you to link the timelines of all of the line graphs on the dashboard. To open the Dashboard Configuration dialog box, select **Settings** in the dashboard header. -![The Dashboard Configuration dialog](../images/dashboard_configuration.png) - Use the Dashboard Configuration dialog box to control attributes of the charts displayed on the dashboard: - Set **Link timelines of all the line charts** to **Enable** to apply the specified timeline to line graphs displayed on the dashboard. If set to **Disable**, your preferences are preserved for later use but don't modify the amount of data displayed. @@ -112,8 +110,6 @@ Settings specified on the Dashboard Configuration dialog box are applied only to PEM displays performance statistics through a number of system-defined dashboards. Each dashboard contains a series of summary views that contain charts, graphs, and tables that display statistics related to the selected object. You can use the **Manage Dashboards** tab to create and manage custom dashboards that display the information that's most relevant to your system. -![The Manage Dashboards tab](../images/manage_dashboard_tab.png) - To create a custom dashboard, select **Create New Dashboard** located in the Quick Links section of the **Manage Dashboards** tab. To modify an existing dashboard, select **Edit** next to the dashboard name. The dashboard editor opens, displaying the definition of the dashboard. After you finish modifying the dashboard's definition, select **Save**. @@ -124,8 +120,6 @@ To delete a dashboard, select **Delete** next to the dashboard name. You can use the PEM dashboard editor to create or modify a custom dashboard. The custom dashboard can include predefined charts, custom charts, or a mix of predefined and custom charts. -![The Create Dashboard editor](../images/pem_custom_dashboard_configure_dashboard.png) - Use the **Configure** section to specify general information about the dashboard: - Specify a name for the dashboard in the **Name** field. @@ -146,16 +140,10 @@ Use the **Permissions** box to specify the users who can view the new dashboard: After you complete the **Configure Dashboard** section, select the arrow in the upper-right corner to close the section and access the **Dashboard Layout Design** section. -![Modifying a Section Header](../images/pem_custom_dashboard_add_section_name.png) - Select **Edit** in a section header to specify a section name. Then, select the plus sign (+) to add a chart to the section. -![Adding a Chart](../images/pem_custom_dashboard_add_chart.png) - Use the arrows to the right of each chart category to display the charts available and select a chart. -![Specifying placement details for a chart](../images/pem_custom_dashboard_chart_details.png) - Use the chart detail selectors to specify placement details for the chart: - Use the **Chart width** selector to indicate the width of the chart. Select **50%** to display the chart in half of the dashboard or **100%** to use the whole dashboard width. @@ -172,8 +160,6 @@ To add another chart to your dashboard, select the plus sign (+) in the section You can use the PEM dashboard editor to create a custom dashboard formatted for display on an Ops monitor. An Ops dashboard displays the specified charts and graphs while omitting header information and minimizing extra banners, titles, and borders. -![Ops dashboard options](../images/define_ops_dashboard.png) - To create an Ops dashboard, provide detailed information about the Ops display in the **Ops dashboard options** section of the Create Dashboard dialog box. - Set **Ops Dashboard?** to **Yes** to create a dashboard that's formatted for display on an Ops monitor. diff --git a/product_docs/docs/pem/8/monitoring_performance/log_manager.mdx b/product_docs/docs/pem/8/monitoring_performance/log_manager.mdx index a2411e40906..2ee2556b0a7 100644 --- a/product_docs/docs/pem/8/monitoring_performance/log_manager.mdx +++ b/product_docs/docs/pem/8/monitoring_performance/log_manager.mdx @@ -18,155 +18,136 @@ You can use the PEM Log Manager to simplify server log configuration for Postgre To configure logging for a Postgres instance, you must register the server as a PEM-managed server, and the registration information must include the name of a service script. -To open Log Manager, in the PEM client, select **Management > Log Manager**. The wizard opens and welcome message appears. +1. To open Log Manager, in the PEM client, select **Management > Log Manager**. The wizard opens and welcome message appears. Select **Next**. -![The Log Manager welcome dialog](../images/lm_welcome.png) +1. The Server Selection dialog box displays a list of the server connections monitored by PEM. Select the check boxes next to the names of servers to which you want the Log Manager wizard to apply the specified configuration. Log Manager is disabled for any server displaying a red exclamation mark to the left of its name in the Server selection tree. A server might not be enabled for several reasons: -Select **Next**. + - Log Manager can configure only a server that specifies a service ID on the **Advanced** tab of the Properties dialog box. To provide a service ID: + 1. In the tree, right-click the server name and select **Disconnect Server** from the context menu. + 1. If prompted, provide a password. + 1. From the context menu for the server, select **Properties**. + 1. On the **Advanced** tab, enter the name of the service in the **Service ID** field. + 1. Select **Save**. -![The Log Manager Server selection dialog](../images/lm_server_select.png) + - If the PEM agent bound to the server doesn't have enough privileges to restart the server, the server is disabled. + - If the PEM agent bound to the server is an older version than the associated PEM server, the server is disabled. -The Server selection dialog box displays a list of the server connections monitored by PEM. Select the check boxes next to the names of servers to which you want the Log Manager wizard to apply the specified configuration. Log Manager is disabled for any server displaying a red exclamation mark to the left of its name in the Server selection tree. A server might not be enabled for several reasons: + Select **Next**. -- Log Manager can configure only a server that specifies a service ID on the **Advanced** tab of the Properties dialog box. +1. Use the Log configuration dialog box to specify how often to import log files to PEM and to specify log rotation details. - To provide a service ID: - 1. In the tree, right-click the server name and select **Disconnect Server** from the context menu. - 1. If prompted, provide a password. - 1. From the context menu for the server, select **Properties**. - 1. On the **Advanced** tab, enter the name of the service in the **Service ID** field. - 1. Select **Save**. + Options in the **Import Logs** box specify how often to import the log files to PEM: -- If the PEM agent bound to the server doesn't have enough privileges to restart the server, the server is disabled. + - Use the switch next to **Import logs to PEM** to specify whether to import the log files to PEM and to display them on the Server Log Analysis dashboard. + - Use the **Import Frequency** list to specify how often to import log files to PEM. -- If the PEM agent bound to the server is an older version than the associated PEM server, the server is disabled. + Use the **Log rotation configuration** box to specify the maximum length (lifespan or size) of a log file: -Select **Next**. + - Use the **Rotation Size** field to specify the maximum size of a log file in megabytes. The default value is 10 MB. Set to 0 if you don't want to place a limit on the maximum size of a log file. + - Use the **Rotation Time** field to specify the number of whole days to store in each log file. The default value is 1 day. -![The Log Manager Log configuration dialog](../images/lm_import_rotation.png) + Use the **Truncation on Rotation** switch to specify server behavior for time-based log file rotation: -Use the options on the Log configuration dialog box to specify how often to import log files to PEM and to specify log rotation details. + - Select **On** to overwrite any existing log file that has the same name as a new file. + - Select **Off** to append any new log file entries to an existing log file with the same name as a new log file. This is the default behavior. -Options in the **Import Logs** box specify how often to import the log files to PEM: + Select **Next**. -- Use the switch next to **Import logs to PEM** to specify whether to import the log files to PEM and to display them on the Server Log Analysis dashboard. -- Use the **Import Frequency** list to specify how often to import log files to PEM. +1. Use the Where to Log dialog box to specify where to write log files: -Use the fields in the **Log rotation configuration** box to specify the maximum length (lifespan or size) of a log file: + - Select an option from the **Log Destination** box to specify a destination for the server log output: + - Set the **stderr** switch to **Yes** to write log files to stderr. + - Set the **csvlog** switch to **Yes** to write log files in a comma-separated value format. This option is enabled and not editable if you select **Import logs to PEM** on the Schedule dialog box. If you aren't importing server log files to PEM, you can edit this option. + - Set the **syslog** switch to **Yes** to write log files to the system log files. + - On Windows, set the **eventlog** switch to **Yes** to write log files to the event log. -- Use the **Rotation Size** field to specify the maximum size of a log file in megabytes. The default value is 10 MB. Set to 0 if you don't want to place a limit on the maximum size of a log file. -- Use the **Rotation Time** field to specify the number of whole days to store in each log file. The default value is 1 day. + - Use the **Log collection** box to specify your collection preferences: + - Set the **Log Collector** switch to **Enable** to redirect captured log messages (directed to stderr) into log files. + - Set the **Log Silent Mode** switch to **Enable** to run the server silently in the background, disassociated from the controlling terminal. -Use the **Truncation on Rotation** switch to specify server behavior for time-based log file rotation: + - Use the **Log Directory** box to specify log file location preferences: + - Set the **Change log directory for selected servers?** switch to **Yes** to maintain each set of log files in a separate directory. + - Use the **Directory name** field to specify the directory to which to write log files. The directory resides beneath the `pg_log` directory under the installation directory of the monitored server. -- Select **On** to overwrite any existing log file that has the same name as a new file. -- Select **Off** to append any new log file entries to an existing log file with the same name as a new log file. This is the default behavior. + - Use the **Log File Name** field to specify a format for the log file name. If set to **Default**, the format is `enterprisedb-%Y-%m-%d_%H%M%S`, where: + - `enterprisedb` is the file name prefix + - `Y` is the year that the log was stored + - `m` is the month that the log was store + - `d` is the day that the log was stored + - `H` is the hour that the log was stored + - `M` is the minute that the log was store + - `S` is the second that the log was stored -Select **Next**. + - When logging to syslog is enabled: -![The Where to Log dialog](../images/lm_where_to_log.png) + - Use the **Syslog Facility** list to specify the syslog facility to use. + - Use the **Syslog Ident** field to specify the program name that identifies EDB Postgres Advanced Server entries in system logs. -Use the Where to Log dialog box to specify where to write log files: + Select **Next**. -- Select an option from the **Log Destination** box to specify a destination for the server log output: - - Set the **stderr** switch to **Yes** to write log files to stderr. - - Set the **csvlog** switch to **Yes** to write log files in a comma-separated value format. This option is enabled and not editable if you select **Import logs to PEM** on the Schedule dialog box. If you aren't importing server log files to PEM, you can edit this option. - - Set the **syslog** switch to **Yes** to write log files to the system log files. - - On Windows, set the **eventlog** switch to **Yes** to write log files to the event log. +1. Use the When to Log dialog box to specify the events that initiate a log file entry. The severity levels in order of severity, from most severe to least severe, are: -- Use the options in the **Log collection** box to specify your collection preferences: - - Set the **Log Collector** switch to **Enable** to redirect captured log messages (directed to stderr) into log files. - - Set the **Log Silent Mode** switch to **Enable** to run the server silently in the background, disassociated from the controlling terminal. + - **panic** — Errors that cause all database sessions to abort. + - **fatal** — Errors that cause a session to abort. + - **log** — Information messages of interest to administrators. + - **error** — Errors that cause a command to abort. + - **warning** — Error conditions in which a command completes but might not perform as expected. + - **notice** — Items of interest to users. This is the default. + - **info** — Information implicitly requested by the user. + - **debug5** through **debug1** — Detailed debugging information useful to developers. + - Use the **Client min messages** list to specify the lowest severity level of message sent to the client application. + - Use the **Log min messages** list to specify the lowest severity level to write to the server log. + - By default, when an error message is written to the server log, the text of the SQL statement that initiated the log entry isn't included. Use the **Log min error statement** list to specify a severity level that triggers SQL statement logging. If a message is of the specified severity or higher, the SQL statement that produced the message is written to the server log. + - Use the **Log min duration statement** list to specify a statement duration, in milliseconds. Any statements that exceed the specified number of milliseconds are written to the server log. A value of **-1** disables all duration-based logging. A value of **0** logs all statements and their duration. + - Use the **Log temp files** field to specify a file size, in kilobytes. When a temporary file reaches the specified size, it's logged. Specify a value of **-1** (the default) to disable this functionality. + - Use the **Log autoVacuum min duration** field to specify a time length, in milliseconds. If auto-vacuuming exceeds the length of time specified, the activity is logged. Specify a value of **-1** (the default) to disable this functionality. -- Use options in the **Log Directory** box to specify log file location preferences: - - Set the **Change log directory for selected servers?** switch to **Yes** to maintain each set of log files in a separate directory. - - Use the **Directory name** field to specify the directory to which to write log files. The directory resides beneath the `pg_log` directory under the installation directory of the monitored server. + Select **Next**. -- Use the **Log File Name** field to specify a format for the log file name. If set to **Default**, the format is `enterprisedb-%Y-%m-%d_%H%M%S`, where: - - `enterprisedb` is the file name prefix - - `Y` is the year that the log was stored - - `m` is the month that the log was store - - `d` is the day that the log was stored - - `H` is the hour that the log was stored - - `M` is the minute that the log was store - - `S` is the second that the log was stored +1. Use the What to Log dialog box to specify log entry options that are useful for debugging and auditing. -- When logging to syslog is enabled: + The switches in the **Debug options** box instruct the server to include information in the log files related to query execution that might be of interest to a developer: - - Use the **Syslog Facility** list to specify the syslog facility to use. - - Use the **Syslog Ident** field to specify the program name that identifies EDB Postgres Advanced Server entries in system logs. + - Set the **Parse tree** switch to **Yes** to include the parse tree in the log file. + - Set the **Rewriter output** switch to **Yes** to include query rewriter output in the log file. + - Set the **Execution plan** switch to **Yes** to include the execution plan for each executed query in the log file. -Select **Next**. + When the **Indent Debug Options Output in Log** switch is set to **Yes**, the server indents each line that contains a parse tree entry, a query rewriter entry, or query execution plan entry. While indentation makes the resulting log file more readable, it results in a longer log file. -![The Log Manager When to Log dialog](../images/lm_when_to_log.png) + Use the switches in the **General Options** box to include auditing information in the log file: -Use the When to Log dialog box to specify the events that initiate a log file entry. The severity levels in order of severity, from most severe to least severe, are: + - Set the **Checkpoints** switch to **Yes** to include checkpoints and restartpoints in the server log. + - Set the **Connections** switch to **Yes** to include each attempted connection to the server as well as successfully authenticated connections in the server log. + - Set the **Disconnections** switch to **Yes** to include a server log entry for each terminated session that provides the session information and session duration. + - Set the **Duration** switch to **Yes** to include the amount of time required to execute each logged statement in the server log. + - Set the **Hostname** switch to **Yes** to include both the IP address and host name in each server log entry. By default, only the IP address is logged. This might cause a performance penalty. + - Set the **Lock Waits** switch to **Yes** to write a log entry for any session that waits longer than the time specified in the `deadlock_timeout` parameter to acquire a lock. This is useful when trying to determine if lock waits are the cause of poor performance. -- **panic** — Errors that cause all database sessions to abort. -- **fatal** — Errors that cause a session to abort. -- **log** — Information messages of interest to administrators. -- **error** — Errors that cause a command to abort. -- **warning** — Error conditions in which a command completes but might not perform as expected. -- **notice** — Items of interest to users. This is the default. -- **info** — Information implicitly requested by the user. -- **debug5** through **debug1** — Detailed debugging information useful to developers. -- Use the **Client min messages** list to specify the lowest severity level of message sent to the client application. -- Use the **Log min messages** list to specify the lowest severity level to write to the server log. -- By default, when an error message is written to the server log, the text of the SQL statement that initiated the log entry isn't included. Use the **Log min error statement** list to specify a severity level that triggers SQL statement logging. If a message is of the specified severity or higher, the SQL statement that produced the message is written to the server log. -- Use the **Log min duration statement** list to specify a statement duration, in milliseconds. Any statements that exceed the specified number of milliseconds are written to the server log. A value of **-1** disables all duration-based logging. A value of **0** logs all statements and their duration. -- Use the **Log temp files** field to specify a file size, in kilobytes. When a temporary file reaches the specified size, it's logged. Specify a value of **-1** (the default) to disable this functionality. -- Use the **Log autoVacuum min duration** field to specify a time length, in milliseconds. If auto-vacuuming exceeds the length of time specified, the activity is logged. Specify a value of **-1** (the default) to disable this functionality. + Use the **Error verbosity** list to specify the detail written to each entry in the server log: -Select **Next**. + - Select **default** to include the error message, DETAIL, HINT, QUERY, and CONTEXT in each server log entry. + - Select **terse** to log only the error message. + - Select **verbose** to include the error message, the DETAIL, HINT, QUERY, and CONTEXT error information, SQLSTATE error code and source code file name, the function name, and the line number that generated the error. -![The Log Manager What to Log dialog](../images/lm_what_to_log.png) + Use the **Prefix string** field to specify a printf-style string that is written at the beginning of each log file entry. For information about the options supported, see the log_line_prefix documentation in the [Postgres core documentation](http://www.postgresql.org/docs/current/static/runtime-config-logging.html). -Use the fields on the What to Log dialog box to specify log entry options that are useful for debugging and auditing. + Use the **Statements** list to specify the SQL statements to include in the server log: -The switches in the **Debug options** box instruct the server to include information in the log files related to query execution that might be of interest to a developer: + - Specify **none** (the default) to disable logging of SQL statements. + - Specify **ddl** to instruct to log ddl (data definition language) statements, such as CREATE, ALTER, and DROP. + - Specify **mod** to log all ddl statements as well as all dml (data modification language) statements, such as INSERT, UPDATE, DELETE, TRUNCATE, and COPY FROM. + - Specify **all** to log all SQL statements. -- Set the **Parse tree** switch to **Yes** to include the parse tree in the log file. -- Set the **Rewriter output** switch to **Yes** to include query rewriter output in the log file. -- Set the **Execution plan** switch to **Yes** to include the execution plan for each executed query in the log file. + Select **Next**. -When the **Indent Debug Options Output in Log** switch is set to **Yes**, the server indents each line that contains a parse tree entry, a query rewriter entry, or query execution plan entry. While indentation makes the resulting log file more readable, it results in a longer log file. +1. Use the Schedule Logging Changes dialog box to specify when logging applies configuration changes: -Use the switches in the **General Options** box to include auditing information in the log file: + - Set the **Configure logging now** switch to **Yes** to enable your configuration preferences. The server restarts when you complete the Log Manager wizard. + - Set **Configure logging now** to **No** to use the **Schedule it for some other time** calendar selector to specify a convenient time to apply logging configuration preferences and for the server to restart. -- Set the **Checkpoints** switch to **Yes** to include checkpoints and restartpoints in the server log. -- Set the **Connections** switch to **Yes** to include each attempted connection to the server as well as successfully authenticated connections in the server log. -- Set the **Disconnections** switch to **Yes** to include a server log entry for each terminated session that provides the session information and session duration. -- Set the **Duration** switch to **Yes** to include the amount of time required to execute each logged statement in the server log. -- Set the **Hostname** switch to **Yes** to include both the IP address and host name in each server log entry. By default, only the IP address is logged. This might cause a performance penalty. -- Set the **Lock Waits** switch to **Yes** to write a log entry for any session that waits longer than the time specified in the `deadlock_timeout` parameter to acquire a lock. This is useful when trying to determine if lock waits are the cause of poor performance. + When you apply the configuration changes specified by the Log Manager wizard, the server restarts, temporarily interrupting use of the database server for users. -Use the **Error verbosity** list to specify the detail written to each entry in the server log: - -- Select **default** to include the error message, DETAIL, HINT, QUERY, and CONTEXT in each server log entry. -- Select **terse** to log only the error message. -- Select **verbose** to include the error message, the DETAIL, HINT, QUERY, and CONTEXT error information, SQLSTATE error code and source code file name, the function name, and the line number that generated the error. - -Use the **Prefix string** field to specify a printf-style string that is written at the beginning of each log file entry. For information about the options supported, see the log_line_prefix documentation in the [Postgres core documentation](http://www.postgresql.org/docs/current/static/runtime-config-logging.html). - -Use the **Statements** list to specify the SQL statements to include in the server log: - -- Specify **none** (the default) to disable logging of SQL statements. -- Specify **ddl** to instruct to log ddl (data definition language) statements, such as CREATE, ALTER, and DROP. -- Specify **mod** to log all ddl statements as well as all dml (data modification language) statements, such as INSERT, UPDATE, DELETE, TRUNCATE, and COPY FROM. -- Specify **all** to log all SQL statements. - -Select **Next**. - -![The Schedule Logging Changes dialog](../images/lm_scheduling.png) - -Use options on the Schedule logging changes dialog box to specify when logging applies configuration changes: - -- Set the **Configure logging now** switch to **Yes** to enable your configuration preferences. The server restarts when you complete the Log Manager wizard. -- Set **Configure logging now** to **No** to use the **Schedule it for some other time** calendar selector to specify a convenient time to apply logging configuration preferences and for the server to restart. - -When you apply the configuration changes specified by the Log Manager wizard, the server restarts, temporarily interrupting use of the database server for users. - -Select **Finish** to exit the wizard. Either restart the server or schedule the server restart for the time specified on the scheduling dialog box. +1. Select **Finish** to exit the wizard. Either restart the server or schedule the server restart for the time specified on the scheduling dialog box. ## Reviewing the Server Log Analysis dashboard @@ -180,11 +161,7 @@ Entries in the Server Log table appear in chronological order, with the most rec Headings at the top of the server log table identify the information stored in each column. Hover over a column heading to view a tooltip that contains a description of the content of each column. -You can use filtering to limit the number of server log records that are displayed. Select **Show Filters** to open the filters panel and define a filter. - -![Defining a Server Log filter](../images/server_log_analysis_filter.png) - -Use the fields in the **filter definition** box to describe the selection criteria for selecting a subset of a report to display: +You can use filtering to limit the number of server log records that are displayed. Select **Show Filters** to open the filters panel and define a filter. Use the **filter definition** box to describe the selection criteria for selecting a subset of a report to display: - Use the **From** field to specify a starting date for the displayed server log. - Use the **To** field to specify an ending date for the displayed server log. @@ -200,44 +177,34 @@ The PEM Log Analysis Expert analyzes the log files of servers that are registere Before using the PEM Log Analysis Expert, you must specify a **Service ID** value on the **Advanced** tab of the Server Properties dialog box. You must also use the Log Manager wizard to enable log collection by the PEM server. -To open the Postgres Log Analysis Expert wizard, in the PEM client, select **Management > Postgres Log Analysis Expert**. In the wizard's Welcome screen, select **Next**. - -![The Log Analysis Expert Welcome dialog](../images/pem_log_analysis_expert_welcome.png) - -The wizard's Analyzer selection dialog box displays a list of analyzers from which you can select. Each analyzer generates a corresponding table, chart, or graph that contains information gleaned from the log files. - -![The Analyzer selection dialog](../images/pem_log_analysis_expert_select_analyzers.png) - -Select the check box next to an analyzer to specify for the Log Analysis Expert to prepare the corresponding table, chart, or graph. After making your selections, select **Next** to continue to the Server selection tree. - -![The Server selection dialog](../images/pem_log_analysis_expert_select_servers.png) +1. To open the Postgres Log Analysis Expert wizard, in the PEM client, select **Management > Postgres Log Analysis Expert**. In the wizard's Welcome screen, select **Next**. -Use the tree to specify the servers you want the Postgres Log Analysis Expert to analyze. If you select multiple servers, the resulting report contains the corresponding result set for each server in a separate but continuous list. Select **Next** to continue to the Report options dialog box. + The wizard's Analyzer selection dialog box displays a list of analyzers from which you can select. Each analyzer generates a corresponding table, chart, or graph that contains information gleaned from the log files. -![The Report options dialog](../images/pem_log_analysis_expert_report_options.png) +1. Select the check box next to an analyzer to specify for the Log Analysis Expert to prepare the corresponding table, chart, or graph. After making your selections, select **Next** to continue to the Server selection tree. -Use the **Options** section to specify the analysis method and the maximum length of any resulting tables: + Use the tree to specify the servers you want the Postgres Log Analysis Expert to analyze. If you select multiple servers, the resulting report contains the corresponding result set for each server in a separate but continuous list. Select **Next** to continue to the Report options dialog box. -- Use the **Aggregate method** list to select the method used by the Log Analysis Expert to consolidate data for the selected time span: - - **SUM** calculates a value that is the sum of the collected values for the specified time span. - - **AVG** calculates a value that is the average of the collected values for the specified time span. - - **MAX** uses the maximum value that occurs in a specified time span. - - **MIN** uses the minimum value that occurs in a specified time span. -- Use the **Time span** field to specify the number of minutes that the analyzer incorporates into each calculation for a point on a graph. For example, if the time span is five minutes, and the aggregate method is **AVG**, each point on the given graph contains the average value of the activity that occurred in a five-minute time span. -- Use the **Rows limit** field to specify the maximum number of rows to include in a table. + Use the **Options** section to specify the analysis method and the maximum length of any resulting tables: -Use the **Time Intervals** section to specify the time range for the Log Analysis Expert to analyze: + - Use the **Aggregate method** list to select the method used by the Log Analysis Expert to consolidate data for the selected time span: + - **SUM** calculates a value that is the sum of the collected values for the specified time span. + - **AVG** calculates a value that is the average of the collected values for the specified time span. + - **MAX** uses the maximum value that occurs in a specified time span. + - **MIN** uses the minimum value that occurs in a specified time span. + - Use the **Time span** field to specify the number of minutes that the analyzer incorporates into each calculation for a point on a graph. For example, if the time span is five minutes, and the aggregate method is **AVG**, each point on the given graph contains the average value of the activity that occurred in a five-minute time span. + - Use the **Rows limit** field to specify the maximum number of rows to include in a table. -- Set **Relative days** to **Yes** to enable the **(+/-) From date** field and specify the number of days before or after the date and time selected in the **From** field. -- Use the **From** field to specify the starting date and time for the analysis. -- Use the **To** field to specify the ending date and time for the analysis. -- Use the **(+/-) From date** selector to specify the number of days before or after the **From** date to include in the analysis. + Use the **Time Intervals** section to specify the time range for the Log Analysis Expert to analyze: -After you specify the report options, select **Next** to continue to the Report destination dialog box. + - Set **Relative days** to **Yes** to enable the **(+/-) From date** field and specify the number of days before or after the date and time selected in the **From** field. + - Use the **From** field to specify the starting date and time for the analysis. + - Use the **To** field to specify the ending date and time for the analysis. + - Use the **(+/-) From date** selector to specify the number of days before or after the **From** date to include in the analysis. -![The Report destination dialog](../images/pem_log_analysis_expert_report_finish.png) + After you specify the report options, select **Next** to continue to the Report destination dialog box. -You can select the default option and select **Finish** to view the Log Analysis Expert report in the PEM client's tabbed browser. Or select **Download the report** to save a copy of the report to an HTML file for later use. +1. You can select the default option and select **Finish** to view the Log Analysis Expert report in the PEM client's tabbed browser. Or select **Download the report** to save a copy of the report to an HTML file for later use. ## Reviewing the Postgres Log Analysis Expert report @@ -248,8 +215,8 @@ If you choose to review the report immediately, the Postgres Log Analysis Expert The name of the server for which information is displayed appears at the start of each section of the report. -The report displays the tables, graphs, and charts selected in the Log Analysis Expert wizard. Select **Jump To**, located in the lower-right corner of the screen, to navigate to a specific graphic. +The report displays the tables, graphs, and charts selected in the Log Analysis Expert wizard. Select **Jump To**, located in the lower-right corner of the screen, to navigate to a specific graphic. ![The Postgres Log Analysis Expert Report](../images/pem_log_analysis_expert_report.png) -If the report contains an analysis of more than one monitored server, charts and tables are displayed in sets. First the graphs, tables, and charts that display statistics for one server appear. Tthen the graphics for the next server in the report appear. +If the report contains an analysis of more than one monitored server, charts and tables are displayed in sets. First the graphs, tables, and charts that display statistics for one server appear. Then the graphics for the next server in the report appear. diff --git a/product_docs/docs/pem/8/monitoring_performance/notifications.mdx b/product_docs/docs/pem/8/monitoring_performance/notifications.mdx index dbd14e9ae8f..5e366eff0ff 100644 --- a/product_docs/docs/pem/8/monitoring_performance/notifications.mdx +++ b/product_docs/docs/pem/8/monitoring_performance/notifications.mdx @@ -23,15 +23,9 @@ PEM monitors your system for conditions that require attention. You can use an e Use the **Email Groups** tab to configure groups of SMTP email recipients. To open the **Email Groups** tab, in the PEM client, select **Management > Manage Alerts**. When the **Manage Alerts** tab opens, select **Email Groups** from the Quick Links toolbar. -![The Email Groups tab](../images/email_groups_tab.png) - The **Email Groups** tab displays a list of the currently defined email groups. To modify an existing group, select a group name and select **Edit** at the far left end of the row. -To define a new email group, select the plus sign (+) in the upper-right corner of the **Email Groups** table. - -![Adding an email group](../images/email_group_add.png) - -Use the Email Group dialog box to define an email group and its members. +To define a new email group, select the plus sign (+) in the upper-right corner of the **Email Groups** table. Use the Email Groups dialog box to define an email group and its members. Each row in the email group definition associates a set of email addresses with a specific time period. When an alert is triggered, the server evaluates the times specified in each row and sends the message to those group members whose definitions are associated with the time that the alert triggered. @@ -58,8 +52,6 @@ After creating the email group, you can use the **Manage Alerts** tab to set up To delete an email group, in the Email Group table, select the name of the group and select **Delete**, located to the left of the group name. -![Deleting an email group](../images/email_group_delete.png) - The group name appears in the Email Group table in red. Select **Save** to permanently remove the group from the table. ## Webhook @@ -72,15 +64,9 @@ PEM monitors your system for conditions that require user attention. You can use Use the **Webhooks** tab to configure endpoint recipients. To open the **Webhooks** tab, select **Management > Manage Alerts**. From the **Manage Alerts** tab, on the Quick Links toolbar, select **Webhooks**. -![Webhooks tab](../images/webhooks_tab.png) - The **Webhooks** tab displays a list of the currently defined recipient applications as endpoints. Select an endpoint and select **Edit** at the far left end of the row to modify an existing endpoint. -To define a new webhook, select the plus sign (+) in the upper-right corner of the table. - -![Webhooks - Add New Webhook - General Tab](../images/webhook_add.png) - -Use the **General** tab to define the basic details of the webhook: +To define a new webhook, select the plus sign (+) in the upper-right corner of the table. You can then use the **General** tab to define the basic details of the webhook: - Provide a name for the webhook in the **Name** field. - Specify a webhook URL to delever all the notifications to in the **URL** field. @@ -102,8 +88,6 @@ You can define the webhook SSL parameters in the respective agent configuration ![Example - Webhook SSL Parameters in windows registry](../images/webhook_ssl_config_windows.png) -![Webhooks - Add New Webhook - HTTP Headers Tab](../images/webhook_add_headers.png) - Use the **HTTP Headers** tab to define the header parameters to pass while calling the webhook endpoints: - Specify all the values as a key and value pair. @@ -112,8 +96,6 @@ Use the **HTTP Headers** tab to define the header parameters to pass while calli - To delete HTTP headers, select **Delete** to the left of **Key**. The header remains in the list but in strike-through font. Select **Save** to permanently delete the headers. - To edit the HTTP headers, select **Edit** to the left of **Key**. -![Webhooks - Add New Webhook - Payload Tab](../images/webhook_add_payload.png) - Use the **Payload** tab to define the JSON data to send to the endpoint when an alert is triggered: - **Type** specifies data to send in the format type, that is, JSON. @@ -144,8 +126,6 @@ Use the **Payload** tab to define the JSON data to send to the endpoint when an - Select **Test Connection** to test notification delivery to the mentioned endpoint. -![Webhooks - Add New Webhook - Notifications Tab](../images/webhook_add_notification.png) - Use the **Notifications** tab to specify an alert level for webhook endpoints: - Set **All alerts** to **Yes** to enable all alert levels to send notifications. @@ -155,8 +135,6 @@ Use the **Notifications** tab to specify an alert level for webhook endpoints: To mark a webhook for deletion, in the Webhooks table, select the webhook name and select **Delete** to the left of the name. The alert remains in the list but in strike-through font. -![Webhooks - Delete an existing webhook](../images/webhook_delete.png) - **Delete** is a toggle. You can undo the deletion by selecting **Delete** a second time. Select **Save** to permanently delete the webhook definition. ## SNMP @@ -230,16 +208,12 @@ The PEM server maintains a unique set of notification properties for each enable To modify the notification properties of an alert, right-click the name of the object monitored by the alert, and select **Management > Manage Alerts**. On the **Manage Alerts** tab, select **Edit** to the left of the alert name in the Alerts list. When the edit pane opens, select the **Notification** tab. -![The Notification tab](../images/nagios_alert_notification.png) - To enable Nagios notification, move the slider next to **Submit passive service check result to Nagios** to **Yes**. Then select **Save**. ### Configuring Nagios-related behavior of the PEM Server You can use the Server Configuration dialog box to provide information about your Nagios configuration to the PEM server. To open dialog box, select **Management > Server Configuration**. -![Specify Nagios properties in the Server Configuration dialog](../images/nagios_server_configuration.png) - Four server configuration parameters specify information about your Nagios installation and PEM server behavior related to Nagios: - Use the `nagios_cmd_file_name` parameter to specify the location of the Nagios pipeline file that receives passive check alerts from PEM. The default value of this parameter is `/usr/local/nagios/var/rw/nagios.cmd`. If your `nagios.cmd` file resides elsewhere, specify the file location in the **Value** field. diff --git a/product_docs/docs/pem/8/monitoring_performance/probes.mdx b/product_docs/docs/pem/8/monitoring_performance/probes.mdx index c26fd5bef8d..982b6cd4789 100644 --- a/product_docs/docs/pem/8/monitoring_performance/probes.mdx +++ b/product_docs/docs/pem/8/monitoring_performance/probes.mdx @@ -78,11 +78,7 @@ To monitor the BDR group using BDR dashboards, you must enable the following pro !!! Note Prior to version 8.4, all these probes are available at the server level. -![BDR Probes](../images/bdr_probes.png) - -The user with bdr_superuser can view information from all the following probes. - -All the following probes works with BDR Enterprise Edition. +The user with bdr_superuser can view information from all the following probes. All these probes works with BDR Enterprise Edition. | Probe name | Information monitored by probe | `bdr_monitor` role required? | Works with BDR SE? | | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ------------------ | @@ -105,11 +101,7 @@ All the following probes works with BDR Enterprise Edition. A probe is a scheduled task that returns a set of performance metrics about a specific monitored object. A probe retrieves statistics from a monitored server, database, operating system, or agent. You can use the **Manage Probes** tab to override the default configuration and customize the behavior of each probe. -To open the **Manage Probes** tab, select **Management > Manage Probes**. - -![The Manage Probes tab](../images/pem_manage_probes_tab.png) - -The **Manage Probes** tab provides a set of icons that you can use to create and manage probes: +To open the **Manage Probes** tab, select **Management > Manage Probes**. The **Manage Probes** tab provides a set of icons that you can use to create and manage probes: - Select **Manage Custom Probes** to open the **Custom Probes** tab and create or modify a custom probe. - Select **Copy Probes** to open the Copy Probe dialog box and copy the probe configurations from the currently selected object to one or more monitored objects. @@ -135,8 +127,6 @@ The **Manage Probes** tab might display information about probes that you can't You can use the **PEM Custom Probes** tab to create a new probe or modify an existing custom probe. To open the **Custom Probes** tab, from the **Manage Probes** tab, select **Manage Custom Probes**. -![The Custom Probes dialog](../images/custom_probes.png) - Use the **Show System Probes?** switch to show or hide the system probes on the **Custom Probes** tab. You can use the **Custom Probes** tab to create a probe or modify an existing one. To create a probe: @@ -144,9 +134,7 @@ You can use the **Custom Probes** tab to create a probe or modify an existing on 1. Provide a name for the new probe in the Probe Name column. 1. Select **Edit** (located to the left of the probe name) to review or add the probe definition. -![Defining a custom probe – the General tab](../images/custom_probes_general.png) - -Use the fields on the **General** tab to modify the definition of an existing probe or to specify the properties of a new probe: +Use the **General** tab to modify the definition of an existing probe or to specify the properties of a new probe: - Use the **Probe Name** field to provide a name for a new probe. @@ -182,8 +170,6 @@ Use the fields on the **General** tab to modify the definition of an existing pr - Use the switch next to **Discard from history** to specify if the server creates a history table for the probe. Select **Yes** to discard probe history or **No** to retain the probe history in a table. - Use the **Platform** list to specify the type of platform that the probe monitors. This field is enabled only when the **Collection** method is **Batch**. -![The Columns tab of the Custom Probes dialog](../images/custom_probes_columns.png) - Use the **Columns** tab to define the columns in which to store the probe data. To define a new column: 1. Navigate to the **Columns** tab and select **Add** in the upper-right corner. 1. Provide a column name in the **Name** field. @@ -209,8 +195,6 @@ Use the **Columns** tab to define the columns in which to store the probe data. PEM allows you to store point-in time-values of cumulative metrics as well. PEM subtracts the last collected value of a cumulative metric from the current value and stores the difference as a point-in-time value. -![The Code tab of the Custom Probes dialog](../images/custom_probes_code.png) - Use the **Code** tab to specify the default code for the propbe to execute: - If the probe is a SQL probe, you must specify the **SQL SELECT** statement invoked by the probe on the **Code** tab. The column names returned by the query must match the **Internal Name** specified on the **Columns** tab. The number of columns returned by the query, as well as the column name, data type, and so on, must match the information specified on the **Columns** tab. @@ -223,8 +207,6 @@ Use the **Code** tab to specify the default code for the propbe to execute: - If the probe is a WMI probe, you must specify the WMI query as a **SELECT WMI** query. The column name referenced in the **SELECT** statement must be same as the name of the corresponding column specified on the **Column** tab. The column names returned by the query must match the **Internal Name** specified on the **Columns** tab. The number of columns returned by the query, as well as the column name, data type, and so on, must match the information specified on the **Columns** tab. -![The Alternate Code tab of the Custom Probes dialog](../images/custom_probes_alt_code.png) - Use the **Alternate Code** tab to provide code to invoke if the probe fires on a specific version of the server. To provide version-specific code, move the **Applies to any server version?** switch to **No** and select **Add**. Then, use the **Database Version(s)** list to select a version, and select **Edit** (to the left of the version name) to provide the code to execute when the probe fires. If you select a database version and leave the Probe Code column blank, PEM invokes the code specified on the **Code** tab when the probe executes on a server that matches that version. @@ -238,33 +220,19 @@ When you've finished defining the probe, select **Save** (in the corner of the * To export the probe, select any probes from the **Manage Custom Probes** tab, and then select **Export** in the upper-right corner of the table. To generate the JSON file, select **Save File** and then select **OK**. -![Custom Probes - Export](../images/custom_probes_export.png) - -To import the probe, on the **Manage Custom Probes** tab, select **Import** in the upper-right corner of the table. +To import the probe, on the **Manage Custom Probes** tab, select **Import** in the upper-right corner of the table. Select **Browse** to select the JSON file with the probe code to import, and then select **Import**. -![Custom Probes Import](../images/custom_probes_import.png) +After selecting the file to import, you can select the **Skip existing** check box. This option skips the probe if it already exists and displays a message letting you know that the import was skipped. -Select **Browse** to select the JSON file with the probe code to import, and then select **Import**. +- If you don't select the check box and the probe already exists, then it doesn't import the probe and an error message is reported. -![Custom Probes - Import Browse](../images/custom_probes_import_browse.png) + !!! Note + **Import** can't overwrite the existing probe as it might be configured to retain historical data as per the configured retention policy. -After selecting the file to import, you can select the **skip existing** check box. This option skips the probe if it already exists and displays the following message: - -![Custom Probes - Import Skipped Message](../images/custom_probes_import_skip_msg.png) - -If the check box isn't selected and the probe already exists, then it doesn't import the probe. The following error appears: - -![Custom Probes - Import Error](../images/custom_probes_import_error.png) +- If you don't select the check box and the probe doesn't exist but the corresponding table in the `pem` schema does, then it imports the probe successfully using the same table. !!! Note - **Import** can't overwrite the existing probe as it might be configured to retain historical data as per the configured retention policy. - -If the check box isn't selected and the probe doesn't exist but the corresponding table in the `pem` schema does, then it imports the probe successfully using the same table. - -![Custom Probes Import Successful](../images/custom_probes_import_successful.png) - -!!! Note - It's possible that the probe is deleted and not listed on **Manage Custom Probe** tab and for the table holding the data of that probe to exist in the `pem` schema. + It's possible for the probe to be deleted and not listed on **Manage Custom Probe** tab and for the table holding the data of that probe to exist in the `pem` schema. ### Deleting a probe @@ -272,8 +240,6 @@ You can delete only custom probes. To delete a probe, select the probe name in t System probes are the built-in probes provided by PEM and are part of the PEM schema. You can only modify system probes. If you attempt to delete a system probe, PEM reports an error. -![Attempting to delete a system probe](../images/delete_system_probe.png) - ### Copying a probe You can use the Copy Probe Configuration dialog box to copy probe definitions from one monitored object to one or more monitored objects of the same type. To open the Copy Probe Configuration dialog box: @@ -282,8 +248,6 @@ You can use the Copy Probe Configuration dialog box to copy probe definitions fr 1. Select **Management > Manage Probes**. 1. From the **Manage Probes** tab, select **Copy Probe**. -![The Copy Probe Configuration tree](../images/copy_probe_config.png) - The dialog box copies the probe definitions from the object from which you opened the Copy Probe Configuration dialog box to the locations selected on the tree control. If you specify a parent node in the **Copy Probe Configuration** tree, PEM copies the probe configurations to each object of the same type that resides under that node in the tree. For example, to copy the probe definitions from one schema to all schemas that reside in a database, select only the parent database of the target schemas. A red warning symbol is displayed to the left of the name of a listed target object if that object is the source of the probe that's being copied. diff --git a/product_docs/docs/pem/8/monitoring_xdb_replication_cluster.mdx b/product_docs/docs/pem/8/monitoring_xdb_replication_cluster.mdx index 14fa74effcb..283eece2f82 100644 --- a/product_docs/docs/pem/8/monitoring_xdb_replication_cluster.mdx +++ b/product_docs/docs/pem/8/monitoring_xdb_replication_cluster.mdx @@ -12,8 +12,6 @@ Before configuring PEM to retrieve statistics from an EDB Postgres Advanced Serv The PEM xDB Replication probe monitors lag data for clusters that use xDB multi-primary or single-primary replication that have an EDB Postgres Advanced Server or PostgreSQL publication database. If you configured replication between other proprietary database hosts (that is, Oracle or SQL Server) and EDB Postgres Advanced Server or PostgreSQL, the probe can't return lag information. -![The Manage Probes tab](images/pem_manage_probes_tab.png) - By default, the xDB Replication probe is disabled. To enable the xDB Replication probe: 1. Right-click the name of the server and select **Connect** from the context menu. 1. If prompted, provide authentication information. diff --git a/product_docs/docs/pem/8/pem_erd_tool.mdx b/product_docs/docs/pem/8/pem_erd_tool.mdx index a112e1c8105..5579aec57c2 100644 --- a/product_docs/docs/pem/8/pem_erd_tool.mdx +++ b/product_docs/docs/pem/8/pem_erd_tool.mdx @@ -24,9 +24,7 @@ You can open multiple copies of the ERD tool in individual tabs simultaneously. ## Toolbar -The ERD Tool toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. When an icon is enabled, it appears highlighted. When an icon is disabled, it appears grayed-out. - -![ERD Tool - Toolbar](images/erd_tool_toolbar.png) +The ERD Tool toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. ## File options @@ -77,8 +75,6 @@ The ERD Tool toolbar uses context-sensitive icons that provide shortcuts to freq ## Table dialog -![ERD Tool - Table Dialog](images/erd_table_dialog.png) - The table dialog box allows you to: - Change the table structure details. @@ -87,8 +83,6 @@ The table dialog box allows you to: ## Table node -![ERD Tool - Table Node](images/erd_table_node.png) - The table node shows table details in a graphical representation: - On the top bar: @@ -116,8 +110,6 @@ The one-to-many link dialog box allows you to: ## Many-to-many link dialog box -![ERD Tool - Many-to-Many Dialog box](images/erd_mm_dialog.png) - The many-to-many link dialog box allows you to: - Add a many-to-many relationship between two tables. @@ -140,9 +132,9 @@ The table link shows the relationship between tables: ## Table notes -![ERD Tool - Table Notes](images/erd_table_note.png) +To add a note to a table: + +1. On the toolbar, select **Add/Edit note**. +1. In the window, enter your note. -- To add a note to a table: - 1. On the toolbar, select **Add/Edit note**. - 1. In the window, enter your note. -- When a note is added to a table, **Note** becomes enabled on the Table node. To check or update notes, select **Note**. +When a note is added to a table, **Note** becomes enabled on the Table node. To check or update notes, select **Note**. diff --git a/product_docs/docs/pem/8/pem_query_tool.mdx b/product_docs/docs/pem/8/pem_query_tool.mdx index 7ceb18cb8a8..3a64e6cd150 100644 --- a/product_docs/docs/pem/8/pem_query_tool.mdx +++ b/product_docs/docs/pem/8/pem_query_tool.mdx @@ -21,8 +21,6 @@ You can access the Query tool by selecting **Tools > Query tool** or through the - Review the execution plan of a SQL statement in either text, graphical, or table format (similar to ). - View analytical information about a SQL statement. -![Query tool tab](images/query_tool.png) - The Query tool features two panels: - The upper panel displays the SQL editor. You can use the panel to enter, edit, or execute a query. It also shows the **History** tab, which you can use to view the queries that ran in the session. You can use the scratch pad to hold text snippets during editing. @@ -38,7 +36,6 @@ The Query tool features two panels: The toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. -![Query tool toolbar](images/query_toolbar.png) | Icon | Behavior | Shortcut | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | @@ -66,20 +63,12 @@ The toolbar uses context-sensitive icons that provide shortcuts to frequently pe The SQL editor panel is a workspace where you can manually provide a query, copy a query from another source, or read a query from a file. The SQL editor features syntax coloring and auto-completion. -![Query tool - Query Editor tab](images/query_sql_editor.png) - To use auto-complete, begin typing your query. When you want the editor to suggest object names or commands that might be next in your query, press **Control+Space**. For example, type `\*SELECT \* FROM\*` (with a trailing space), and then press **Control+Space** to select from a menu of auto-complete options. -![Query tool - Query Editor tab](images/query_autocomplete.png) - After entering a query, select **Execute/Refresh** from the toolbar. The database server receives the complete contents of the SQL editor panel to execute. To execute only a section of the code that's displayed in the SQL editor, select the text that you want the server to execute, and select **Execute/Refresh**. -![Query tool - Query Editor tab - Autocomplete feature](images/query_execute_section.png) - The message returned by the server when a command executes is displayed on the **Messages** tab. If the command is successful, the **Messages** tab displays execution details. -![Query tool - Query Editor - Message tab](images/query_tool_message.png) - The **Edit** menu helps with code formatting and commenting: - Use auto-indent to indent text to the same depth as the previous line by pressing **Return**. @@ -92,8 +81,6 @@ You can also drag certain objects from the tree to save time spent typing long o The Data Output panel displays data and statistics generated by the most recently executed query. -![Query tool - Data output tab](images/query_output_data.png) - ### Data Output tab The **Data Output** tab displays the result set of the query in a table format. You can: @@ -115,8 +102,6 @@ Any columns that are renamed or selected more than once are also read-only. Editable and read-only columns are identified using pencil and lock icons in the column headers. -![Query tool - Editable and Read-only columns](images/query_tool_editable_columns.png) - An updatable result set is similar to the data grid in View/Edit Data mode, and you can modify it in the same way. If auto-commit is off, data changes are made as part of the ongoing transaction. If no transaction is ongoing, a new one is started. The data changes aren't committed to the database unless the transaction is committed. @@ -131,8 +116,6 @@ To generate the Explain or Explain Analyze plan of a query, select **Explain** o You can select more options related to **Explain** and **Explain Analyze** from the menu. -![Query tool - Toolbar Explain button](images/query_toolbar_explain.png) - !!! Note PEM generates the Explain Analyze plan in JSON format. @@ -142,8 +125,6 @@ On successful generation of an Explain plan, three tabs/panels appear under the To download the plan as an SVG file, select **Download** in the top-left corner of the Explain canvas. **Download as SVG** isn't supported on Internet Explorer. -![Query tool - Explain tab - Graphical plan tab](images/query_output_explain_details.png) - The query plan that accompanies **Explain Analyze** is available on the **Data Output** tab. ### Analysis tab @@ -166,8 +147,6 @@ If the planner has misestimated the number of rows (actual verse planned) by: - 1000 times, red appears -![Query tool - Explain tab - Analysis tab](images/query_explain_analyze_table.png) - ### Statistics tab The **Statistics** tab displays information in two tables: @@ -175,17 +154,9 @@ The **Statistics** tab displays information in two tables: - Statistics per Node Type tells you how many times each node type was referenced. - Statistics per Table tells you how many times each table was referenced by the query. -![Query tool - Explain plan tab - Statistics tab](images/query_explain_analyze_statistics.png) - ### Messages tab -Use the **Messages** tab to view information about the most recently executed query: - -![Query tool - Output error](images/query_output_error.png) - -If the server returns an error, the error message appears on the **Messages** tab, and the syntax that caused the error is underlined in the SQL editor. If a query succeeds, the **Messages** tab shows how long the query took to complete and how many rows were retrieved: - -![Query tool - Messages tab](images/query_output_messages.png) +Use the **Messages** tab to view information about the most recently executed query. If the server returns an error, the error message appears on the **Messages** tab, and the syntax that caused the error is underlined in the SQL editor. If a query succeeds, the **Messages** tab shows how long the query took to complete and how many rows were retrieved. ### Notifications tab @@ -209,11 +180,7 @@ For example: ## Query History panel -Use the **Query History** tab to review activity for the current session. - -![Query tool - Query History tab](images/query_output_history.png) - -The **Query History** tab displays information about recent commands including: +Use the **Query History** tab to review activity for the current session. The **Query History** tab displays information about recent commands including: - The date and time that a query was invoked. - The text of the query. @@ -230,7 +197,7 @@ Query history is maintained across sessions for each database on a per-user basi ## Connection status -Use **Connection Status** to view the current connection and transaction status by selecting the status in the Query tool: +Use **Connection Status** to view the current connection and transaction status by selecting the status in the Query tool. ![Query tool - Connection Status button](images/query_tool_connection_status.png) @@ -238,8 +205,6 @@ Use **Connection Status** to view the current connection and transaction status Query tool macros enable you to execute predefined SQL queries by pressing a single key. Predefined queries can contain the placeholder `$SELECTION$`. When the macro executes, the placeholder is replaced with the currently selected text in the Query Editor pane of the Query tool. -![Query tool - Connection Status button](images/query_tool_manage_macros.png) - To create a macro: 1. In the Query tool, select **Macros > Manage Macros**. @@ -247,12 +212,8 @@ To create a macro: 3. Optionally, include the selection placeholder. 4. Select **Save**. -![Query tool - Connection Status button](images/query_tool_manage_macros_dialog.png) - To clear a macro, in the Manage Macros dialog box, select the macro and select **Clear**. Respond **Yes** to the prompt. To clear all macros, select **Clear** next to **Key**. Respond **Yes** to the prompt. -To execute a macro, select the shortcut keys, or select it from the **Macros** menu. - -![Query tool - Connection Status button](images/query_tool_macros_execution.png) +To execute a macro, select the shortcut keys, or select it from the **Macros** menu. \ No newline at end of file diff --git a/product_docs/docs/pem/8/pem_schema_diff_tool.mdx b/product_docs/docs/pem/8/pem_schema_diff_tool.mdx index 736fecde50c..c7363ded52f 100644 --- a/product_docs/docs/pem/8/pem_schema_diff_tool.mdx +++ b/product_docs/docs/pem/8/pem_schema_diff_tool.mdx @@ -23,11 +23,7 @@ To open the selection panel, select **Tools > Schema Diff**. Select the source a !!! Note The source and target databases must use the same major version. -You can open multiple copies of Schema Diff in individual tabs. To close a tab, select **X** in the upper-right corner of the tab bar. - -![Schema Diff dialog](images/schema_diff_dialog.png) - -To specify whether to open Schema Diff in a new browser tab, select the Preferences dialog box. Set **Open in new browser tab** to **true**. +You can open multiple copies of Schema Diff in individual tabs. To specify whether to open Schema Diff in a new browser tab, select the Preferences dialog box. Set **Open in new browser tab** to **true**. The Schema Diff panel is divided into two panels: an Object Comparison panel and a DDL Comparison panel. @@ -39,12 +35,8 @@ Select the databases to compare. The databases can be the same or different, and Select the source and target schemas to compare. -![Schema Diff dialog - Compare button](images/schema_diff_compare_button.png) - After you select servers, databases, and schemas, select **Compare** to get the comparison results. -![Schema Diff dialog - Comparison Results](images/schema_diff_comparison_results.png) - Use the lists of **Functions**, **Materialized Views**, **Tables**, **Trigger Functions**, **Procedures**, and **Views** to view the DDL statements of all the schema objects. To filter the schema objects, select **Filter** in the upper-right corner of the Object Comparison panel. Filter the schema objects according to these criteria: @@ -54,8 +46,6 @@ To filter the schema objects, select **Filter** in the upper-right corner of the - **Source Only** — If the object is found only in source schema and not in target schema, then the comparison result is source only. - **Target Only** — If the object is found only in target schema and not in source schema, then the comparison result is target only. -![Schema Diff dialog - Filter option](images/schema_diff_filter_option.png) - Select any of the schema objects in the Object Comparison panel to display the DDL statements for that object in the DDL Comparison panel. ## Schema Diff DDL Comparison panel @@ -66,24 +56,18 @@ The DDL Comparison panel displays three columns: - The second column displays the DDL statement of the object from the target schema. - The third column displays the difference in the SQL statement of the target schema object. -![Schema Diff dialog - DDL Comparison panel](images/schema_diff_DDL_comparison.png) - To check for differences in the SQL statements, review the DDL statements of all the schema objects. The Schema Diff tool can generate a SQL script with the differences found in the target schema object. The SQL script compares the target schema object to the SQL statement of the source schema object. To generate the script: 1. In the Object Comparison panel, select the check boxes of the schema objects. 1. Select **Generate Script**. -![Schema Diff dialog - Generate Script button](images/schema_diff_generate_script.png) - To open the Query tool in a new tab and display the differences in the SQL statement in the Query Editor: 1. Select the schema objects. 1. Select **Generate Script**. If you select the schema object to check the difference generated in the DDL Comparison panel but don't select the check box of the schema object, then PEM opens the Query tool in a new tab. The Query tool displays the differences in the SQL statements in the Query Editor. -![Schema Diff dialog - Generate Script - Query Editor](images/schema_diff_generate_script_query_editor.png) - To copy the difference generated in the DDL Comparison panel, select **Copy**. Apply the SQL Statement in the target schema to synchronize the schemas. diff --git a/product_docs/docs/pem/8/pem_upgrade/moving_pem_server.mdx b/product_docs/docs/pem/8/pem_upgrade/moving_pem_server.mdx index 4f59c17c5e5..09bfca9c144 100644 --- a/product_docs/docs/pem/8/pem_upgrade/moving_pem_server.mdx +++ b/product_docs/docs/pem/8/pem_upgrade/moving_pem_server.mdx @@ -7,29 +7,25 @@ redirects: - /pem/latest/pem_upgrade/03_moving_pem_server/ --- -The steps in this section describe how to move a PEM server from one host machine to a new host machine. The PEM server on the new host (the target) must be installed with the same version of the PEM server installer as the original host (the source). Please note that if you do not use the same installer version, you may encounter a schema-mismatch error. +You can move a PEM server from one host machine to a new host machine. The PEM server on the new host (the target) must be installed with the same version of the PEM server installer as the original host (the source). If you don't use the same installer version, you might encounter a schema-mismatch error. -The backend database of the target server (either PostgreSQL or Advanced Server) may be of the same type and version, or a different type and version than the backend database of the source PEM server. A PEM server that resides on a PostgreSQL host can be migrated to an Advanced Server host, or vice versa. +The backend database of the target server (either PostgreSQL or EDB Postgres Advanced Server) can have the same type and version or a different type and version from the backend database of the source PEM server. You can migrate a PEM server that resides on a PostgreSQL host to an EDB Postgres Advanced Server host and vice versa. -Before starting the server migration, you should ensure that the firewalls between the source host, the target host, and the host of any PEM Agent will allow connections between the services. +Before starting the server migration, make sure that the firewalls between the source host, the target host, and the host of any PEM agent allows connections between the services. -1. Prepare the Target Host +1. Prepare the target host. - Invoke the installer for the PEM server on the target host. Please note that you must use the same version of the PEM server installer that you used when installing the source PEM server. + Invoke the installer for the PEM server on the target host. You must use the same version of the PEM server installer that you used when installing the source PEM server. - The backend database of the target server may be a different version or type than the backend database of the source. If the new PEM server does *not* reside on the same type of backend database as the original server, you must ensure that the same version of the `sslutils` extension is installed on the new server host. The version of `sslutils` that is distributed with the PEM installers is freely available for download from the EDB website at: + The backend database of the target server can have a different version or type from the backend database of the source. If the new PEM server doesn't reside on the same type of backend database as the original server, you must ensure that the same version of the sslutils extension is installed on the new server host. The version of sslutils that's distributed with the PEM installers is freely available for download from the [EDB website](https://www.enterprisedb.com/downloads/modified-gpl-source-code). - + For information about installing the PEM server or the sslutils extension, see the [PEM installation steps](/pem/latest/). - For information about installing the PEM server or the `sslutils` extension, please refer to the `PEM Installation Steps `, available at: +2. Drop existing schemas from the new PEM server. - + The migration process re-creates the `pem`, `pemdata`, and `pemhistory` schemas from the source PEM server on the target PEM server. To prepare for the move, use the psql client to delete these schemas from the `pem` database on the target host. You can open the psql client at the command line or by selecting **Postgres Enterprise Manager > SQL Shell (psql)**. -2. Drop Existing Schemas from the New PEM Server - - The migration process re-creates the `pem`, `pemdata`, and `pemhistory` schemas from the source PEM server on the target PEM server. In preparation for the move, use the `psql` client to delete these schemas from the `pem` database on the target host. You can open the `psql` client at the command line, or by selecting `SQL Shell (psql)` from the `Postgres Enterprise Manager` menu. - - When the `psql` client opens, connect to the `pem` backend database as the database superuser. After connecting to the `pem` database on the target host, use the following commands to drop the schemas: + When the psql client opens, connect to the `pem` backend database as the database superuser. After connecting to the `pem` database on the target host, drop the schemas: ```sql DROP SCHEMA pem CASCADE; @@ -39,25 +35,25 @@ Before starting the server migration, you should ensure that the firewalls betwe DROP SCHEMA pemhistory CASCADE; ``` - When dropping the schemas, you must include the `CASCADE` keyword, instructing the server to delete all dependent objects. When executing the command, the `psql` client displays a list of the dependent objects; the client confirms each the schema is removed by displaying `DROP SCHEMA`. + When dropping the schemas, you must include the `CASCADE` keyword, instructing the server to delete all dependent objects. When executing the command, the psql client displays a list of the dependent objects. The client confirms each the schema is removed by displaying `DROP SCHEMA`. -3. Prepare the PEM Agents on the New PEM Server +3. Prepare the PEM agents on the new PEM server. - Before moving the PEM server, you must identify the number of Agents that are monitored by the source PEM server, and create identities for that number of Agents (less one) on the target server. To discover the total number of `PEM` Agents monitored by the PEM server, connect to the pem database on the source host with the `psql` client, and query the `pem.agent` table. + Before moving the PEM server, you must identify the number of agents that are monitored by the source PEM server and create identities for that number of agents, less one, on the target server. To discover the total number of PEM agents monitored by the PEM server, connect to the `pem` database on the source host with the psql client, and query the `pem.agent` table. ```sql SELECT id FROM pem.agent WHERE active = true; ``` - You must manually create the number of Agents that reside on the original PEM server, less one; the PEM server installer has already created one Agent on the target host. For example, if the source server contains three Agents, you must manually create two additional Agents. Open a `psql` session with the `pem` database on the target server, and create the required Agents. Use the command: + You must manually create the number of gents that reside on the original PEM server, less one. (The PEM server installer creates one agent on the target host.) For example, if the source server contains three agents, you must manually create two more agents. Open a psql session with the `pem` database on the target server, and create the required agents: ```sql CREATE USER agent; ``` - Where `` specifies an Agent number. Remember, `agent1` is created on the target host by the PEM Server installer. + Where `` specifies an agent number. `agent1` is created on the target host by the PEM server installer. - Then, use the `GRANT` command to assign each Agent that resides on the target PEM Server `pem_agent` permissions: + Then, use the `GRANT` command to assign each agent that resides on the target PEM server `pem_agent` permissions: ```sql GRANT pem_agent TO agent; @@ -65,9 +61,9 @@ Before starting the server migration, you should ensure that the firewalls betwe Where `` specifies an agent number. -4. Generate a Backup Script of the Source PEM Server +4. Generate a backup script of the source PEM server. - You can use the `pg_dump` utility to generate a script that contains the commands required to recreate the `pem` database on the target host. By default, `pg_dump` is installed in the `bin` directory under your Postgres installation. To invoke `pg_dump`, open a command line, navigate to the `bin` directory, and enter: + You can use the pg_dump utility to generate a script that contains the commands required to re-create the `pem` database on the target host. By default, pg_dump is installed in the `bin` directory under your Postgres installation. To invoke pg_dump, in the `bin` directory, enter: ```shell pg_dump -U > @@ -79,16 +75,16 @@ Before starting the server migration, you should ensure that the firewalls betwe - `` specifies the name of the PEM backend database. - `` specifies the name of the script generated by pg_dump. - When prompted, provide the password associated with the user specified. + When prompted, provide the password associated with the user specified. - The command shown instructs `pg_dump` to generate a script that (when executed) will re-create the `pem` database. The script will be named `backup.sql`, and will be created in the `tmp` directory. `pg_dump` is connecting to the server using the credentials of the user, `postgres`. + The command shown instructs pg_dump to generate a script that, when executed, re-creates the `pem` database. The script is named `backup.sql` and is created in the `tmp` directory. pg_dump is connecting to the server using the credentials of the user postgres. - Note that invoking the `pg_dump` utility will not interrupt current database users. + Invoking the pg_dump utility doesn't interrupt current database users. !!! Note - If the source PEM Server is lower than the 7.16 version, then you need to replace the following functions before you run `pg_dump` to take backup: + If the source PEM server is earlier than the 7.16 version, then you need to replace the following functions before you run pg_dump to take backup: - - The `abstime`, `reltime`, and `tinterval` datatypes are deprecated from Postgres version 12 or later, hence to replace those dataypes with `timestamptz` data type use below command: + - The `abstime`, `reltime`, and `tinterval` datatypes are deprecated from Postgres version 12 or later. To replace those dataypes with `timestamptz` data type, use this command: ```sql DO @@ -116,7 +112,7 @@ Before starting the server migration, you should ensure that the firewalls betwe $$ LANGUAGE ‘plpgsql’; ``` - - Replace the below function to avoid any alert errors: + - Replace the this function to avoid any alert errors: ```sql CREATE OR REPLACE FUNCTION pem.check_alert_params_array_size( @@ -163,13 +159,13 @@ Before starting the server migration, you should ensure that the firewalls betwe ``` -5. Move the Backup to the Target Host +5. Move the backup to the target host. - Move the script generated by the `pg_dump` utility to the target host of the PEM server. + Move the script generated by the pg_dump utility to the target host of the PEM server. -6. Restore the Backup on the Target Host +6. Restore the backup on the target host. - Open a command line on the target host and navigate into the `bin` directory (under the Postgres backend database installation directory). Start `psql`, executing the script generated by the `pg_dump` utility: + On the target host, in the `bin` directory under the Postgres backend database installation directory, start psql, executing the script generated by the pg_dump utility: ```shell psql -U -d pem -f @@ -182,21 +178,21 @@ Before starting the server migration, you should ensure that the firewalls betwe When prompted, provide the password associated with the database superuser. - The example shown uses the `psql` client to invoke a script named `backup.sql` to recreate the `pem` database. The script is invoked using the privileges associated with the database superuser, `postgres`. + The example shown uses the psql client to invoke a script named `backup.sql` to recreate the `pem` database. The script is invoked using the privileges associated with the database superuser postgres. -7. Stop the Database Server on the Target Host +7. Stop the database server on the target host. - To stop the PEM Server on CentOS or RHEL 7.x or 8.x, use the command: + To stop the PEM server on CentOS or RHEL 7.x or 8.x, use the command: ```shell systemctl stop ``` - Where `` specifies the name of the backend database server. For a PostgreSQL backend database, the service name is `postgresql-`, and for an Advanced Server backend database, the service name is `edb-as-`, where `` specifies the version number. + Where `` specifies the name of the backend database server. For a PostgreSQL backend database, the service name is `postgresql-`. For an EDB Postgres Advanced Server backend database, the service name is `edb-as-`, where `` specifies the version number. - If you are using Windows, you can use the `Services` dialog to control the service. To open the `Services` dialog, navigate through the `Control Panel` to the `System and Security` menu. Select `Administrative Tools`, and then double-click the `Services` icon. When the `Services` dialog opens, highlight the service name in the list, and use the option provided on the dialog to Stop the service. + If you're using Windows, you can use the Services dialog box to control the service. To open the Services dialog box, from the Control Panel, select **System and Security > Administrative Tools**. Double-click the **Services** icon. In the Services dialog box, select the service name in the list, and select **Stop**. -8. Copy the Certificate Files to the Target Host +8. Copy the certificate files to the target host. You must replace the certificate files that are created when the target host is installed with the certificate files of the source host. Copy the following files from the source PEM server to the target PEM server: @@ -225,11 +221,11 @@ Before starting the server migration, you should ensure that the firewalls betwe `` specifies the version of PostgresSQL on your system. - The files will already exist on the target cluster; delete the existing files before performing the copy, or overwrite the existing files with the files from the source server. Once in place on the target server, the files should have the (platform-specific) permissions described in the sections that follow. + The files already exist on the target cluster. Delete the existing files before performing the copy, or overwrite the existing files with the files from the source server. Once in place on the target server, the files must have the platform-specific permissions shown. - **Permissions and Ownership on Linux** + **On Linux** - | **File Name** | **Owner** | **Permissions** | + | File name | Owner | Permissions | | ------------------ | --------- | --------------- | | ca_certificate.crt | postgres | -rw------- | | ca_key.key | postgres | -rw------- | @@ -238,7 +234,7 @@ Before starting the server migration, you should ensure that the firewalls betwe | server.key | postgres | -rw------- | | server.crt | postgres | -rw-r--r-- | - On Linux, the certificate files must be owned by postgres. You can use the following command at the command line to modify the ownership of the files: + On Linux, the certificate files must be owned by postgres. Use the following command to modify the ownership of the files: ```shell chown postgres @@ -246,13 +242,13 @@ Before starting the server migration, you should ensure that the firewalls betwe Where `file_name` specifies the name of the certificate file. - The server.crt file may only be modified by the owner of the file, but may be read by any user. You can use the following command to set the file permissions for the server.crt file: + Only the owner of the `server.crt` file can modify the file, but any user can read it. Use the following command to set the file permissions for the `server.crt` file: ```shell chmod 644 server.crt ``` - The other certificate files may only be modified or read by the owner of the file. You can use the following command to set the file permissions: + Only the owner of the other certificate files can modify or read the files. Use the following command to set the file permissions: ```shell chmod 600 @@ -260,29 +256,23 @@ Before starting the server migration, you should ensure that the firewalls betwe Where `file_name` specifies the name of the file. - Permissions and Ownership on Windows - - On Windows, the certificate files moved from the source host must be owned by the service account that performed the PEM server and backend database installation on the target host. If you invoked the PEM server and Postgres installer using the `Run as Administrator` option (selected from the context menu of the installer), the owner of the certificate files will be `Administrators`. - - To review and modify file permissions on Windows, right-click on the file name, and select `Properties`. - - ![The Permissions tab](../images/move_server_windows_permission.png) - ** The Permissions tab ** + **On Windows** - Navigate to the `Security` tab and highlight a `Group or user name` to view the assigned permissions. Select `Edit` or `Advanced` to access dialogs that allow you to modify the permissions associated with the selected user. + On Windows, the service account that performed the PEM server and backend database installation on the target host must own the certificate files moved from the source host. If you invoked the PEM server and Postgres installer using **Run as Administrator** from the installer context menu, the owner of the certificate files is Administrators. + To review and modify file permissions on Windows, right-click the file name and select **Properties**. On the **Security** tab, select a group or user name to view the assigned permissions. Select **Edit** or **Advanced** to open dialog boxes that allow you to modify the permissions associated with the selected user. -9. Move the PEM Agent Certificate Files to the PEM Server Host +9. Move the PEM agent certificate files to the PEM server host. - You must move the certificate files used by the PEM Agent of the source PEM server to the target host. This step is platform-specific. + You must move the certificate files used by the PEM agent of the source PEM server to the target host. This step is platform specific. **On Linux** - Copy the `agent1.key` and `agent1.crt` files from the source host to the target host. By default, on Linux, the files are installed in `/root/.pem`; copy the files to the same directory on the target host. + Copy the `agent1.key` and `agent1.crt` files from the source host to the target host. By default, on Linux, the files are installed in `/root/.pem`. Copy the files to the same directory on the target host. File ownership and permissions of the files must be set to: - | **File Name** | **Owner** | **Permissions** | + | File name | Owner | Permissions | | ------------- | --------- | --------------- | | agent1.key | root | -rw------- | | agent1.crt | root | -rw-r--r-- | @@ -313,15 +303,15 @@ Before starting the server migration, you should ensure that the firewalls betwe Where `user_name` is the name of the user that invoked the PEM installer. - The ownership and permissions associated with the certificate files on the target machine should match the ownership and permissions of the certificate files on the source machine. If you invoked the PEM server and Postgres installer using the `Run as Administrator` option (selected from the context menu of the installer), the owner of the Agent certificate files will be `Administrators`. + The ownership and permissions associated with the certificate files on the target machine must match the ownership and permissions of the certificate files on the source machine. If you invoked the PEM server and Postgres installer using **Run as Administrator** on the installer context menu, the owner of the agent certificate files is Administrators. - To review and modify file permissions on Windows, right-click on the file name, and select `Properties`. Navigate to the `Security` tab and highlight a `Group or user name` to view the assigned permissions. Select `Edit` or `Advanced` to access dialogs that allow you to modify the permissions associated with the selected user. + To review and modify file permissions on Windows, right-click the file name and select **Properties**. On the **Security** tab, select a group or user name to view the assigned permissions. Select **Edit** or **Advanced** to open dialog boxes that allow you to modify the permissions associated with the selected user. -10. Update the `pg_hba.conf` Files on the Target Host +10. Update the `pg_hba.conf` files on the target host. - Modify the `pg_hba.conf` file on the target host to allow connections from each PEM Agent. By default, the `pg_hba.conf` file is located in the data directory under your Postgres installation. + Modify the `pg_hba.conf` file on the target host to allow connections from each PEM agent. By default, the `pg_hba.conf` file is located in the data directory under your Postgres installation. -11. Start the Server on the Target Host +11. Start the server on the target host. After modifying the `pg_hba.conf` file, you must restart the server for the changes to take effect. @@ -333,19 +323,19 @@ Before starting the server migration, you should ensure that the firewalls betwe Where `service_name` is the name of the backend database server. - If you are using Windows, you can use the `Services` dialog to control the service. To open the `Services` dialog, navigate through the `Control Panel` to the `System and Security` menu. Select `Administrative Tools`, and then double-click the `Services` icon. When the `Services` dialog opens, highlight the service name in the list, and use the option provided on the dialog to Start the service. + On Windows, you can use the Services dialog box to control the service. To open the Services dialog box, on the Control Panel, select **System and Security > Administrative Tools**. Double-click the **Services** icon. When the Services dialog box opens, select the service name in the list, and start the service. -12. Connecting Monitored Agents to the New PEM Server Host +12. Connecting monitored agents to the new PEM server host. - To instruct existing PEM Agents to connect to the new PEM server host, you must: + To instruct existing PEM agents to connect to the new PEM server host, you must: - - Ensure that the PEM Agent host can connect to the new PEM server host. - - Modify the registry (on each Windows host with a PEM Agent) or the Agent configuration files (on each Linux host with a PEM Agent), specifying the IP address and port of the new PEM server. - - Restart the PEM Agent's service. These steps are platform-specific: + - Ensure that the PEM agent host can connect to the new PEM server host. + - Modify the registry on each Windows host with a PEM agent or the agent configuration files on each Linux host with a PEM agent, specifying the IP address and port of the new PEM server. + - Restart the PEM agent's service. These steps are platform specific: - [On Linux](#if-the-pem-agent-resides-on-linux) - [On Windows](#if-the-pem-agent-resides-on-windows) - #### If the PEM Agent Resides on Linux + ### If the PEM agent resides on Linux Use your choice of editor to modify the `agent.cfg` file, specifying the new IP address and port number of the PEM server in the `pem_host` and `pem_port` parameters. @@ -355,34 +345,26 @@ Before starting the server migration, you should ensure that the firewalls betwe ![The agent.cfg file](../images/move_pem_server_agent_cfg.png) - After modifying the `agent.cfg` file, you must restart the PEM Agent service; you can use the `pemagent` service script on the Linux command line to restart the service: + After modifying the `agent.cfg` file, you must restart the PEM agent service. You can use the `pemagent` service script on the Linux command line to restart the service: ```shell /etc/init.d/pemagent restart ``` - #### If the PEM Agent Resides on Windows + ### If the PEM agent resides on Windows - Before modifying the Windows registry on the monitored node, confirm that the firewall on the host of the PEM Agent will allow connections to the PEM server. After confirming that the PEM Agent host can connect to the PEM server host, you can use the Windows `Registry Editor` to review and edit the `PEM_HOST` and `PEM_PORT` entries to ensure that they correctly identify the host and port used by the PEM server. To open the `Registry Editor`, enter `regedit` in the Windows `Run` dialog or in the Windows start menu search box. Navigate through the registry tree control to view or modify registry entries. + Before modifying the Windows registry on the monitored node, confirm that the firewall on the host of the PEM agent allows connections to the PEM server. After confirming that the PEM agent host can connect to the PEM server host, you can use the Windows Registry Editor to review and edit the `PEM_HOST` and `PEM_PORT` entries to ensure that they correctly identify the host and port used by the PEM server. To open the Registry Editor, enter `regedit` in the Windows Run dialog box or in the Windows start menu search box. Navigate through the registry tree control to view or modify registry entries. - On 64-bit Windows, the PEM Agent registry entries are located: + On 64-bit Windows, the PEM agent registry entries are located at: `HKEY_LOCAL_MACHINE SOFTWARE wow6432Mode EnterpriseDB PEM Agent` - On 32-bit Windows, the PEM Agent registry entries are located: + On 32-bit Windows, the PEM agent registry entries are located at: `HKEY_LOCAL_MACHINE SOFTWARE EnterpriseDB PEM Agent` - ![The Windows Registry Editor](../images/move_pem_server_windows_registry.png) - - The `PEM_HOST` and `PEM_PORT` entries must specify the address and port number of the new PEM server on the target host. To modify a registry entry, right click on the entry `Name`, and select `Modify` from the context menu to open the `Edit String` dialog. - - ![The Windows Registry Editor](../images/move_pem_server_windows_registry_edit.png) - - Use the `Edit String` dialog to make any changes to the value of the entry. When you're finished, click `OK` to save your changes, or `Cancel` to exit without saving. - - After modifying the registry, you must restart the PEM Agent's service; you can use the `Services` dialog (accessed through the Windows `Control Panel`) to restart the `Postgres Enterprise Manager - pemagent` service . + The `PEM_HOST` and `PEM_PORT` entries must specify the address and port number of the new PEM server on the target host. To modify a registry entry, right-click the entry name and select **Modify** from the context menu. Then use the Edit String dialog box to make any changes to the value of the entry. After you finish, select **OK**. - ![Restarting the PEM Agent service](../images/move_pem_server_restart_agent.png) + After modifying the registry, you must restart the PEM agent's service. You can use the Services dialog box, accessed through the Windows Control Panel, to restart the `Postgres Enterprise Manager - pemagent` service. - After moving the server, change the connection properties in any installed PEM clients to connect to the new host of the PEM server, Agents, and monitored servers. + After moving the server, change the connection properties in any installed PEM clients to connect to the new host of the PEM server, agents, and monitored servers. diff --git a/product_docs/docs/pem/8/pem_upgrade/upgrading_backend_database.mdx b/product_docs/docs/pem/8/pem_upgrade/upgrading_backend_database.mdx index f89d7242d04..d8f1b696b1f 100644 --- a/product_docs/docs/pem/8/pem_upgrade/upgrading_backend_database.mdx +++ b/product_docs/docs/pem/8/pem_upgrade/upgrading_backend_database.mdx @@ -7,7 +7,7 @@ redirects: - /pem/latest/pem_upgrade/02_upgrading_backend_database/ --- -If you're updating PEM components and the PEM backend database, perform PEM component updates (the server and agent) before updating the backend database. For more information about updating PEM component software, see [Upgrading a PEM installation](upgrading_pem_installation/). +If you're updating PEM components and the PEM backend database, perform PEM component updates on the server and agent before updating the backend database. For more information about updating PEM component software, see [Upgrading a PEM installation](upgrading_pem_installation/). !!! Note From PEM version 8.0 and later, the PostgreSQL or EDB Postgres version 11 or later are supported only as a backend database server. If your backend database server is earlier than version 11, then first you need to upgrade your backend database server. Then upgrade the PEM components. @@ -334,15 +334,13 @@ You can find more information about using pg_upgrade at [pg_upgrade](http://www. Where `file_name` specifies the name of the file. - **Permissions and Ownership on Windows** + **Permissions and ownership on Windows** - On Windows, the service account that performed the PEM server and backend database installation on the target host must owned the certificate files moved from the source host. If you invoked the PEM server and Postgres installer using the **Run as Administrator** from the context menu of the installer, the owner of the certificate files is Administrators. + On Windows, the service account that performed the PEM server and backend database installation on the target host must own the certificate files moved from the source host. If you invoked the PEM server and Postgres installer using **Run as Administrator** from the context menu of the installer, the owner of the certificate files is Administrators. - To review and modify file permissions on Windows, right-click on the file name, and select **Properties**. + To review and modify file permissions on Windows, right-click the file name and select **Properties**. - ![The Security tab](../images/upgrade_backendDB_permission_Windows_security.png) - - On the **Security** tab select a group or user name to view the assigned permissions. Select **Edit** or **Advanced** to open dialog box that allow you to modify the permissions associated with the selected user. + On the **Security** tab select a group or user name to view the assigned permissions. Select **Edit** or **Advanced** to open dialog boxes that allow you to modify the permissions associated with the selected user. 6. The `postgresql.conf` file contains parameter settings that specify server behavior. Modify the `postgresql.conf` file on the new server to match the configuration specified in the `postgresql.conf` file of the old server. @@ -411,6 +409,7 @@ You can find more information about using pg_upgrade at [pg_upgrade](http://www. Where `service_name` is the name of the backend database server. If you're using Windows, you can use the **Services** dialog box to control the service: + 1. In the Control Panel, select **System and Security > Administrative Tools**. 1. Double-click the **Services** icon. 1. In the Services dialog box, select the service name and start the service. diff --git a/product_docs/docs/pem/8/pem_upgrade/upgrading_pem_installation/upgrading_pem_installation_windows.mdx b/product_docs/docs/pem/8/pem_upgrade/upgrading_pem_installation/upgrading_pem_installation_windows.mdx index 7a364e744e0..6852aab8937 100644 --- a/product_docs/docs/pem/8/pem_upgrade/upgrading_pem_installation/upgrading_pem_installation_windows.mdx +++ b/product_docs/docs/pem/8/pem_upgrade/upgrading_pem_installation/upgrading_pem_installation_windows.mdx @@ -18,78 +18,52 @@ During an installation, the component installer automatically detects an existin To upgrade a system that is currently monitored by a PEM agent to a more recent PEM agent, download and invoke a newer version of the PEM Agent installer on the system that the agent is monitoring. -To invoke the installer, right-click the downloaded installer icon and select **Run as Administrator**. The PEM Agent Setup wizard opens, welcoming you. +1. To invoke the installer, right-click the downloaded installer icon and select **Run as Administrator**. The PEM Agent Setup wizard opens, welcoming you. -![The PEM Agent Installer - Welcome Window](../../images/pem_upgrade_agent_welcome.png) +1. Read and accept the license agreement and then select **Next**. -Read and accept the license agreement and then select **Next**. +1. The setup wizard automatically detects an existing agent and upgrades the installed version. Select **Next**. -![The PEM Agent Installer - License Agreement](../../images/pem_upgrade_agent_license.png) +1. The pemAgent Service Account dialog box might prompt you for the password of the account under which the PEM agent service runs. If prompted, provide the password, and select **Next**. -The setup wizard automatically detects an existing agent and upgrades the installed version. Select **Next**. +1. When the Ready to Install dialog box informs you that the installation is about to begin, select **Next**. The wizard upgrades your PEM agent to the latest version. -![The PEM Agent Installer - Existing Installation Location](../../images/pem_upgrade_agent_existing_installation.png) +1. The PEM Agent Setup wizard informs you when the installation completes. Select **Finish**. -The pemAgent Service Account dialog box might prompt you for the password of the account under which the PEM agent service runs. If prompted, provide the password, and select **Next**. - -![The PEM Agent Installer - pemAgent Service Account password](../../images/pem_upgrade_agent_pemAgent_service_account.png) - -When the Ready to Install dialog box informs you that the installation is about to begin, select **Next**. The wizard upgrades your PEM agent to the latest version. - -![The PEM Agent Installer - Ready to Install](../../images/pem_upgrade_agent_ready_install.png) - -The PEM Agent Setup wizard informs you when the installation completes. Select **Finish**. - -After the installation completes, you are prompted to restart the machine. Select **Yes** to restart the machine and the PEM agent. - -![The PEM Agent Installer - Restart pop-up](../../images/pem_upgrade_agent_restart_pop_up.png) +1. After the installation completes, you're prompted to restart the machine. Select **Yes** to restart the machine and the PEM agent. ## Upgrading the PEM server on a Windows host The PEM server installer enables you to upgrade between major versions of the PEM server. You can upgrade from version 5.0 to version 7.16 without first upgrading to version 6.0. -To invoke the installer, right-click the downloaded installer, and select **Run as Administrator**. - -![The PEM Server Installer - Welcome Window](../../images/pem_upgrade_server_welcome.png) +1. To invoke the installer, right-click the downloaded installer, and select **Run as Administrator**. -The PEM Server Setup wizard welcomes you. Select **Next**. +1. The PEM Server Setup wizard welcomes you. Select **Next**. -The PEM Server Setup wizard prompts you to accept the license agreement. After reviewing the license agreement, select **I accept the agreement** and select **Next**. +1. The PEM Server Setup wizard prompts you to accept the license agreement. After reviewing the license agreement, select **I accept the agreement** and select **Next**. -![The PEM Server Installer - License Agreement](../../images/pem_upgrade_server_license.png) +1. The wizard checks the PEM server host for an existing PEM server installation. If the wizard locates an installation, it performs an upgrade. Select **Next**. -The wizard checks the PEM server host for an existing PEM server installation. If the wizard locates an installation, it performs an upgrade. Select **Next**. + Before upgrading the PEM server, the wizard confirms that the requirements of the new PEM server are present. If any supporting components are missing or are at a version that doesn't support the new PEM installation, the wizard informs you that it must upgrade the dependencies. It then invokes the required installers. -![The PEM Server Installer - Existing PEM Server Location](../../images/pem_upgrade_server_existing_installation.png) +1. When the installation wizards completes the dependency upgrades, you're prompted to restart the machine. Select **No** to continue the upgrade process. -Before upgrading the PEM server, the wizard confirms that the requirements of the new PEM server are present. If any supporting components are missing or are at a version that doesn't support the new PEM installation, the wizard informs you that it must upgrade the dependencies. It then invokes the required installers. +1. The wizard then opens the Database Server Installation Details dialog box, prompting you for connection credentials for the database superuser of the PEM backend database. Provide: -![The PEM Server Installater - Missing Dependencies](../../images/pem_upgrade_server_dependency_missing.png) + - The name of the database superuser in the **User** field. + - The password associated with the database superuser in the **Password** field. -When the installation wizards completes the dependency upgrades, you're prompted to restart the machine. Select **No** to continue the upgrade process. + Select **Next**. -The wizard then opens the Database Server Installation Details dialog box, prompting you for connection credentials for the database superuser of the PEM backend database. Provide: +1. The pemAgent Service Account dialog box might prompt you for the password of the account under which the PEM agent service runs. If prompted, provide the password, and select **Next**. -- The name of the database superuser in the **User** field. -- The password associated with the database superuser in the **Password** field. +1. The Ready to Install dialog box informs you that the setup wizard is ready to perform the installation. Select **Next** to start the installation. -Select **Next**. + After upgrading the PEM server (and the agent that resides on the same host as the PEM server) and configuring the web service, the PEM setup wizard notifies you of the port on which the service is listening. Use this port number when connecting to the PEM server with the PEM client. -![The PEM Server Installer - Database Server Installation Details](../../images/pem_upgrade_server_DB_installation.png) +1. Select **OK**. The PEM server setup wizard informs you that the installation is complete. -The pemAgent Service Account dialog box might prompt you for the password of the account under which the PEM agent service runs. If prompted, provide the password, and select **Next**. - -![The PEM Server Installer - Ready to Install](../../images/pem_upgrade_server_ready_install.png) - -The Ready to Install dialog box informs you that the setup wizard is ready to perform the installation. Select **Next** to start the installation. - -After upgrading the PEM server (and the agent that resides on the same host as the PEM server) and configuring the web service, the PEM setup wizard notifies you of the port on which the service is listening. Use this port number when connecting to the PEM server with the PEM client. - -![The PEM Server Installer - the PEM Web Service configured](../../images/pem_upgrade_server_webservice_configure.png) - -Click **OK**. The PEM server setup wizard informs you that the installation is complete. - -If you're prompted to restart the machine, select **Yes** to restart the machine and the httpd service. +1. If you're prompted to restart the machine, select **Yes** to restart the machine and the httpd service. If you installed the PEM backend database server and PEM-HTTPD on different hosts, then you must run the PEM server installer twice: once on each host. Extract the language pack installer, and install it on the host of PEM-HTTPD before invoking the PEM installer. Include the following keywords when invoking the installer to extract the language pack: @@ -100,8 +74,6 @@ Where `` specifies an existing path for extracting the language pack insta !!! Note By default EDB Language Pack is installed in `C:\edb\languagepack\v1`. -If you're upgrading the PEM Server using StackBuilder Plus, then you might see an error. After displaying the error, PEM reports that installation is completed. However, the installation is not complete. You need to do the installation by invoking the installer file from the location where it is downloaded. - -![The PEM Server upgrade error](../../images/pem_upgrade_server_error.png) +If you're upgrading the PEM Server using StackBuilder Plus, then you might see an error. After displaying the error, PEM reports that installation is completed. However, the installation isn't complete. You need to do the installation by invoking the installer file from the location where it is downloaded. -After upgrading the PEM server, you might wish to upgrade the backend database to a more recent version. For information, see [Upgrading the Backend Postgres Database](../upgrading_backend_database/). \ No newline at end of file +After upgrading the PEM server, you might want to upgrade the backend database to a more recent version. For information, see [Upgrading the backend Postgres database](../upgrading_backend_database/). \ No newline at end of file diff --git a/product_docs/docs/pem/8/pem_web_interface.mdx b/product_docs/docs/pem/8/pem_web_interface.mdx index d00c83fcebb..962f1edfee7 100644 --- a/product_docs/docs/pem/8/pem_web_interface.mdx +++ b/product_docs/docs/pem/8/pem_web_interface.mdx @@ -18,8 +18,6 @@ After the server installation completes, you can open the PEM interface in your `ip_address_of_PEM_host` specifies the IP address of the host of the PEM server. -![The PEM Web Login page](images/pem_logon.png) - Use the fields on the Postgres Enterprise Manager Login window to authenticate yourself with the PEM server: - Provide the name of a `pem` database user in the **Username** field. For the first user connecting, this is the name provided when installing the PEM server. @@ -59,8 +57,6 @@ Context-sensitive menus across the top of the PEM web interface allow you to cus ### The File menu -![The File Menu](images/pem_file_menu.png) - Use the **File** menu to access the following options. | Option | Action | @@ -72,8 +68,6 @@ Use the **File** menu to access the following options. ### The Object menu -![The Object Menu](images/pem_object_menu.png) - The **Object** menu is context sensitive. Use the **Object** menu to access the following options. | Option | Action | @@ -96,8 +90,6 @@ The **Object** menu is context sensitive. Use the **Object** menu to access the ### The Management menu -![The Management Menu](images/pem_management_menu.png) - Use the **Management** menu to access the following PEM features. | Option | Action | @@ -118,8 +110,6 @@ Use the **Management** menu to access the following PEM features. ### The Dashboards menu -![The Dashboards menu](images/pem_dashboards_menu.png) - Use the context-sensitive **Dashboards** menu to access dashboards. | Option | Action | @@ -143,8 +133,6 @@ Use the context-sensitive **Dashboards** menu to access dashboards. ### The Tools menu -![The Tools menu](images/pem_tool_menu.png) - Use the options on the **Tools** menu to access the following features. | Option | Action | @@ -167,8 +155,6 @@ Use the options on the **Tools** menu to access the following features. ### The Help menu -![The Help menu](images/pem_help_menu.png) - Use the options on the **Help** menu to access the online help documents or to review information about the PEM installation. | Option | Action | @@ -182,8 +168,6 @@ Use the options on the **Help** menu to access the online help documents or to r Use the icons in the upper-right corner of each graphic on a dashboard to control and customize the charts, graphs, and tables displayed in the PEM client for your current user session. -![The PEM Client chart control icons](images/chart_icons.png) - The following table gives the information about icons. | Icons | Information | @@ -196,4 +180,3 @@ The following table gives the information about icons. | ![icon2](images/lgfullscreen.png) | Expand the chart or graph to full-screen. | For more information about customizing the graphics displayed on the PEM dashboards, see the PEM client online help. - diff --git a/product_docs/docs/pem/8/profiling_workloads/pem_sqlprofiler/installing_the_sql_profiler_plugin.mdx b/product_docs/docs/pem/8/profiling_workloads/pem_sqlprofiler/installing_the_sql_profiler_plugin.mdx index 69ad2dee782..e8aa7323d22 100644 --- a/product_docs/docs/pem/8/profiling_workloads/pem_sqlprofiler/installing_the_sql_profiler_plugin.mdx +++ b/product_docs/docs/pem/8/profiling_workloads/pem_sqlprofiler/installing_the_sql_profiler_plugin.mdx @@ -15,29 +15,15 @@ You can use the graphical installer to install any version of SQL Profiler on th ## Installing SQL Profiler on Windows -To invoke the SQL Profiler graphical installer, assume Administrator privileges, navigate to the directory that contains the installer, and double-click the installer icon. The SQL Profiler installer welcomes you to the Setup Wizard. +1. To invoke the SQL Profiler graphical installer, assume Administrator privileges, navigate to the directory that contains the installer, and double-click the installer icon. The SQL Profiler installer welcomes you to the Setup Wizard. -![The SQL Profiler Installer Welcome dialog](../../images/installing_pem_sql_profiler_plugin_windows_welcome.png) +1. Select **Next** to continue to the license agreement. -Select **Next** to continue to the license agreement. +1. Review the license agreement before selecting the appropriate radio button and accepting the agreement. Select **Next**. -![The SQL Profiler License Agreement](../../images/installing_pem_sql_profiler_plugin_windows_license_agreement.png) +1. Specify an alternative location for the installation directory, or accept the default location and select **Next**. -Carefully review the license agreement before selecting the appropriate radio button and accepting the agreement. Select **Next** to continue to the Installation Directory dialog box. - -![The PostgreSQL Installation Directory](../../images/installing_pem_sql_profiler_plugin_windows_installation_directory.png) - -Specify an alternative location for the installation directory, or accept the default location and select **Next**. - -![Ready to Install](../../images/installing_pem_sql_plugin_windows_ready_to_install.png) - -The wizard is now ready to install the SQL Profiler plugin. Select **Next**. - -![Installing the SQL Profiler plugin](../../images/installing_pem_sql_profiler_plugin_windows_in_progress.png) - -The SQL Profiler plugin installer displays progress bars as it copies files to your system. - -![The SQL Profiler installation is complete](../../images/installing_pem_sql_profiler_plugin_windows_finish.png) +1. The wizard is now ready to install the SQL Profiler plugin. Select **Next**. When the installation is complete, the SQL Profiler plugin is ready to configure. @@ -109,13 +95,9 @@ To enable the plugin: After configuring SQL Profiler, it's ready to use with all databases that reside on the server. -![Creating a new trace](../../images/sp_create_new_trace.png) - To access SQL Profiler functionality, select the monitored Server/database in the PEM Browser tree. Select **Tools > Server > SQL Profiler**. Then select: - **Create trace** to define a new trace. - **Open trace** to open an existing trace. - **Delete trace(s)** to delete one or more traces. - **View scheduled trace(s)** to review a list of scheduled traces. - - ![Server > SQL Profiler menu](../../images/sql_profiler.png) diff --git a/product_docs/docs/pem/8/profiling_workloads/pem_sqlprofiler/using_sql_profiler.mdx b/product_docs/docs/pem/8/profiling_workloads/pem_sqlprofiler/using_sql_profiler.mdx index 566b6ded3da..219477e7af6 100644 --- a/product_docs/docs/pem/8/profiling_workloads/pem_sqlprofiler/using_sql_profiler.mdx +++ b/product_docs/docs/pem/8/profiling_workloads/pem_sqlprofiler/using_sql_profiler.mdx @@ -39,8 +39,6 @@ SQL Profiler captures and displays a specific SQL workload for analysis in a SQL You can use the Create Trace dialog box to define a SQL trace for any database on which SQL Profiler was installed and configured. To open the dialog box, select the database in the PEM client tree an select **Management > SQL Profiler > Create trace**. -![The Trace options tab](../../images/sp_create_new_trace.png) - Use the **Trace options** tab to specify details about the new trace: - Provide a name for the trace in the **Name** field. @@ -49,16 +47,12 @@ Use the **Trace options** tab to specify details about the new trace: - Specify a trace size in the **Maximum Trace File Size** field. SQL Profiler terminates the trace when it reaches approximately the size specified. - Select **Yes** in the **Run Now** field to start the trace when you select **Create**. Select **No** to enable fields on the **Schedule** tab. -![The Create trace Schedule tab](../../images/sp_create_new_trace_schedule.png) - Use the **Schedule** tab to specify scheduling details for the new trace: - Use the **Start time** field to specify the starting time for the trace. - Use the **End time** field to specify the ending time for the trace. - Select **Yes** in the **Repeat?** field to repeat the trace every day at the times specified. Select **No** to enable fields on the **Periodic job options** tab. -![The Create trace Periodic job options tab](../../images/sp_create_new_trace_periodic_job.png) - Use the **Periodic job options** tab to specify scheduing details about a recurring trace. Use the **Days** section to specify the days when the job executes: - Use the **Week days** field to select the days of the week for the trace to execute. @@ -69,16 +63,12 @@ Use the **Times** section to specify a schedule for the trace execution. Use the After you complete the Create Trace dialog box, select **Create** to start the trace or to schedule the trace. -![The SQL Profiler tab, displaying the trace results](../../images/sp_create_new_trace_executed.png) - If you execute the trace immediately, the trace results appear in the PEM client. ### Opening an existing trace To view a previous trace, select the profiled database in the PEM client tree and select **Management > SQL Profiler > Open trace**. The Open Trace dialog box opens. -![Opening an existing trace](../../images/sp_open_existing_trace.png) - Select an entry in the trace list and select **Open** to open the selected trace in the **SQL Profiler** tab. ### Filtering a trace @@ -111,11 +101,8 @@ Select **Save** to save the filter definition to a file without applying the fil To delete a trace: 1. Select the profiled database in the PEM client tree. -1. Select **Management > SQL Profiler > Delete trace(s)**. The Delete Traces dialog box opens. - - ![The Delete traces… dialog](../../images/sp_delete_trace.png) - -1. Select the icon to the left of a trace name to mark one or more traces for deletion. +1. Select **Management > SQL Profiler > Delete trace(s)**. +1. In the Delete Traces dialog box, select the icon to the left of a trace name to mark one or more traces for deletion. 1. Select **Delete**. The PEM client acknowledges that the selected traces were deleted. @@ -123,8 +110,6 @@ To delete a trace: To view a list of scheduled traces, select the profiled database in the PEM client tree. Select **Management > SQL Profiler > Scheduled traces**. -![Reviewing scheduled traces](../../images/sp_scheduled_traces.png) - The Scheduled Traces dialog box displays a list of the traces that are awaiting execution. Select **Edit** to the left of a trace name to see detailed information about the trace: - The **Status** field lists the status of the current trace. diff --git a/product_docs/docs/pem/8/registering_database_server.mdx b/product_docs/docs/pem/8/registering_database_server.mdx index c16d5c8ba26..7fce5ae461a 100644 --- a/product_docs/docs/pem/8/registering_database_server.mdx +++ b/product_docs/docs/pem/8/registering_database_server.mdx @@ -19,13 +19,9 @@ To manage or monitor a database server with PEM, you must: You can use the Create Server dialog box to provide registration information for a server, bind a PEM agent, and display the server in the PEM client tree. To open the Create Server dialog box, select **Object > Create > Server**. -![Accessing the Create – Server dialog](images/pem_accessing_create_server_dialog.png) - !!! Note You must ensure the `pg_hba.conf` file of the Postgres server that you're registering allows connections from the host of the PEM client before attempting to connect. -![The General tab of the Create – Server dialog](images/create_server_general_tab.png) - Use the **General** tab to describe the general properties of the server: - Use the **Name** field to specify a name for the server. The name identifies the server in the PEM browser tree. @@ -36,8 +32,6 @@ Use the **General** tab to describe the general properties of the server: - Select **Connect now?** to attempt a server connection when you select **Save**. Clear **Connect now?** if you don't want the PEM client to validate the specified connection parameters until a later connection attempt. - Provide notes about the server in the **Comments** field. -![The Connection tab of the Create – Server dialog](images/create_server_connection_tab.png) - Use the **Connection tab** to specify connection details for the server: - Specify the IP address of the server host or the fully qualified domain name in the **Host name/address** field. On Unix-based systems, leave the address field blank to use the default PostgreSQL Unix Domain Socket on the local machine. Or you can set an alternative path containing a PostgreSQL socket. If you enter a path, the path must begin with a forward slash (/). @@ -49,8 +43,6 @@ Use the **Connection tab** to specify connection details for the server: - Select **Save password?** to store passwords in encrypted format in a PEM backend database for later reuse. Each password is stored on a per-user, per-server basis and isn't shared with other team members. PEM uses the saved password to connect the database server next time. To remove a saved password, disconnect the database server first, and then select **Object > Clear Saved Password**. - Use the **Role** field to specify the name of the role that's assigned the privileges for the client to use after connecting to the server. This value allows you to connect as one role and then assume the permissions of another role (the one you specified in this field) when the connection is established. The connecting role must be a member of the role specified. -![The SSL tab of the Create – Server dialog](images/create_server_ssl_tab.png) - Use the **SSL** tab to configure SSL: - In the **SSL mode** field, select the type of SSL connection for the server to use. For more information about using SSL encryption, see [the PostgreSQL documentation](https://www.postgresql.org/docs/current/static/libpq-ssl.html). @@ -66,8 +58,6 @@ You can use the platform-specific file manager dialog box to upload files that s !!! Warning Certificates, private keys, and the revocation list are stored in the per-user file storage area on the server, which is owned by the user account under which the PEM server process is run. This means that administrators of the server might be able to access those files. Use caution before using this feature. -![The SSH Tunnel tab of the Create – Server dialog](images/create_server_ssh_tunnel_tab.png) - Use the **SSH Tunnel** tab to configure SSH tunneling. You can use a tunnel to connect a database server through an intermediary proxy host to a server that resides on a network to which the client might not be able to connect directly. - Set **Use SSH tunneling** to **Yes** to use an SSH tunnel when connecting to the specified server. @@ -80,8 +70,6 @@ Use the **SSH Tunnel** tab to configure SSH tunneling. You can use a tunnel to c - If the SSH host is expecting a private key file for authentication, use the **Identity file** field to specify the location of the key file. - If the SSH host is expecting a password, use the **Password** field to specify the password. If an identity file is being used, specify the passphrase. -![The Advanced tab of the Create – Server dialog](images/create_server_advanced_tab.png) - Use the **Advanced** tab to specify details that are used to manage the server: - Specify the IP address of the server host in the **Host Address** field. @@ -103,8 +91,6 @@ Use the **Advanced** tab to specify details that are used to manage the server: - If you're using PEM to monitor the status of a Failover Manager cluster, use the **EFM installation path** field to specify the location of the Failover Manager binary file. By default, the Failover Manager binary file is installed in `/usr/edb/efm-x.x/bin`, where `x.x` specifies the Failover Manager version. -![The PEM Agent tab of the Create – Server dialog](images/create_server_pem_agent_tab.png) - Use the **PEM Agent** tab to specify connection details for the PEM agent. On the **Connection Parameters** tab: @@ -140,8 +126,6 @@ For more information about using SSL encryption, see the [PostgreSQL documentati - Specify the password for the agent to use when connecting to the server in the **Password** field and **Confirm password** fields. If you don't specify a password, you must configure the authentication for the agent manually. For example, you can use a `.pgpass` file, which must be present and accessible on the system where agent is installed. -![The PEM Agent Advanced tab of the Create – Server dialog](images/create_server_pem_agent_advanced_tab.png) - On the **Advanced** tab: - Set **Allow takeover?** to **Yes** to specify that another agent can take over the server. This feature allows an agent to take responsibility for the monitoring of the database server if, for example, the server moved to another host as part of a high-availability failover process. @@ -151,8 +135,6 @@ On the **Advanced** tab: !!! Note The database-level probes don't execute for excluded databases, but the server-level probes can collect the database statistics. -![The Create Server dialog (BART - General tab)](images/create_server_bart_general.png) - Use the **General** tab under the **BART** tab to describe the general properties of the BART server that map to the PEM server: - Use the **BART server** field to select the BART server name. All the BART servers configured in the PEM console are listed. @@ -167,8 +149,6 @@ Use the **General** tab under the **BART** tab to describe the general propertie - Use **Allow incremental backup?** to specify whether to enable incremental backup for this database server. - Use **Setup passwordless SSH?** to specify if you want to create SSH certificates to allow passwordless logins between the database server and the BART server. Be sure to bind a PEM agent before setting up the passwordless SSH authentication. Passwordless SSH doesn't work for a database server being remotely monitored by a PEM agent. -![The Create - Server dialog (BART - Misc tab)](images/create_server_bart_misc.png) - Use the **Misc** tab under the **BART** tab to describe the miscellaneous properties of the BART Server: - Use **Override default configuration?** to override the BART server configurations with the specific database server configurations. @@ -191,8 +171,6 @@ To enable auto discovery for a specific agent, you must enable the Server Auto D To open the Auto Discovery dialog box, select a PEM agent in the PEM client tree and select **Management > Auto Discovery**. -![The PEM Auto Discovery dialog](images/auto_discovery.png) - When the Auto Discovery dialog box opens, the **Discovered Database Servers** box displays a list of servers that currently aren't being monitored by a PEM agent. Select the box next to a server name to display information about the server in the **Server Connection Details** box and connection properties for the agent in the **Agent Connection Details** box. Use **Check All** to select the box next to all of the displayed servers or **Uncheck All** to clear all of the boxes to the left of the server names. @@ -213,9 +191,7 @@ The fields in the **Agent Connection Details** box specify the properties for th - The **Password** field displays the password associated with the specified user name. - Use the **SSL mode** field to specify your SSL connection preferences. -After you finish specifying the connection properties for the servers that you're binding for monitoring, select **OK** to register the servers. - -![The registered server](images/global_overview.png) +After you finish specifying the connection properties for the servers that you're binding for monitoring, select **OK** to register the servers. After selecting **OK**, the newly registered server is displayed in the PEM tree and is monitored by the PEM server. @@ -290,8 +266,6 @@ If you don't provide the password, a password authentication error occurs. The P Once registered, the new server is added to the PEM browser tree and is displayed on the Global Overview dashboard. -![The Global Overview dashboard](images/global_overview.png) - When first connecting to a newly bound server, the Global Overview dashboard might display the new server with a status of “unknown” in the server list. Before recognizing the server, the bound agent must execute a number of probes to examine the server. These probes might take a few minutes to complete, depending on network availability. I a few minutes, bar graphs on the Global Overview dashboard show that the agent connected successfully. The new server is included in the **Postgres Server Status** list. diff --git a/product_docs/docs/pem/8/reports.mdx b/product_docs/docs/pem/8/reports.mdx index 5e2f05057f4..9a8404e575f 100644 --- a/product_docs/docs/pem/8/reports.mdx +++ b/product_docs/docs/pem/8/reports.mdx @@ -34,13 +34,7 @@ The Postgres Enterprise Manager Summary provides details about: - Flask version - Platform specific information -The summary provides information about the number of agents and servers. - -![System Configuration Report - PEM Summary and Summary](images/system_configuration_report_pem_summary_and_summary.png) - -The Group: PEM Agents panel provides details about the PEM agent, CPU cores, disk utilization, and memory information. - -![System Configuration Report - PEM Agents](images/system_configuration_report_pem_agents.png) +The summary provides information about the number of agents and servers. The Group: PEM Agents panel provides details about the PEM agent, CPU cores, disk utilization, and memory information. The Group: PEM Server Directory panel provides details about: @@ -51,8 +45,6 @@ The Group: PEM Server Directory panel provides details about: - Database size - Tablespace size -![System Configuration Report - Group Server Name](images/system_configuration_report_pem_server_directory.png) - The group server name depends on the group name to which the server is added. ## Core Usage report @@ -71,5 +63,3 @@ The report also gives detailed information about locally managed servers: - Platform - Cores - RAM - -![Core Usage Report](images/core_usage_report.png) diff --git a/product_docs/docs/pem/8/tuning_performance/performance_diagnostic.mdx b/product_docs/docs/pem/8/tuning_performance/performance_diagnostic.mdx index 21f8f694413..97b3b65082f 100644 --- a/product_docs/docs/pem/8/tuning_performance/performance_diagnostic.mdx +++ b/product_docs/docs/pem/8/tuning_performance/performance_diagnostic.mdx @@ -38,9 +38,7 @@ To analyze the Wait States data on multiple levels, narrow down the data you sel - You need superuser privileges to access the Performance Diagnostic dashboard. -If the prerequisites aren't met, then you get this error while accessing the Performance Diagnostic dashboard: - -![Performance Diagnostic Error dialog](../images/performance_diagnostic_error.png) +If the prerequisites aren't met, then an error appears when you access the Performance Diagnostic dashboard: ## Using the Performance Diagnostic dashboard @@ -54,8 +52,6 @@ To open the Performance Diagnostic dashboard in a new browser tab, select **Pref The duration selection in the first graph is 10 minutes. To see the duration on a graph, select a duration from the **Last** list. To display the data for a specified date and time, select a date and time from the **Until** list. -![Performance Diagnostic dashboard - Time Changes option](../images/performance_diagnostic_datetime_selection.png) - The first graph displays the number of active sessions and wait event types for the selected duration. You can change the duration in the first graph to analyze the data for a specific time period. The next section plots the following graphs based on the selected duration in the first graph: @@ -72,26 +68,10 @@ Select a time on the Line graph to analyze the wait events. The third section di - The **Users** tab displays the details of the wait events grouped by users for the selected sample time. - The **Waits** tab displays the number of wait events belonging to each wait event type for the selected sample time. -![Performance Diagnostic dashboard - Time range selection in the first Wait event types graph](../images/performance_diagnostic_timeseries_selection.png) - To show or hide a wait event type in all the graphs, select the graph legends. The analysis is simpler when you can only see the wait event types you want to analyze. -![Performance Diagnostic dashboard - Show and hide a wait event type by click the respective graph legend](../images/performance_diagnostic_chart_legends.png) - You can filter the data displayed in the rows under all three tabs. You can also sort the data alphabetically by selecting the column headers. -**SQL** tab - -![Performance Diagnostic - SQL tab with filter applied](../images/performance_diagnostic_table_filter.png) - -**Users** tab - -![Performance Diagnostic - Users tab](../images/performance_diagnostic_users_table.png) - -**Waits** tab - -![Performance Diagnostic - Waits tab](../images/performance_diagnostic_wait_events.png) - Select the eye in any row of the **SQL** tab to display a window with details on the query of that row. This window displays a query ID and its corresponding session IDs in a list at that selected sample time in the **Query information** section. You can select the **Session ID** list for the selected query that you want to analyze the data. The details corresponding to the selected session ID and query ID appear. The **Query information** table also displays the SQL query. The **Wait event types** section displays the total number of wait event types for the selected session ID and query ID. It shows two types of graphs: diff --git a/product_docs/docs/pem/8/tuning_performance/postgres_expert.mdx b/product_docs/docs/pem/8/tuning_performance/postgres_expert.mdx index 62a78a68131..15e5a9605f9 100644 --- a/product_docs/docs/pem/8/tuning_performance/postgres_expert.mdx +++ b/product_docs/docs/pem/8/tuning_performance/postgres_expert.mdx @@ -21,36 +21,26 @@ You can select specific rules for each expert to evaluate or accept all rules. T To use the Postgres Expert wizard, in the PEM client select **Management > Postgres Expert**. -In the Welcome message, select **Next**. +1. In the Welcome message, select **Next**. -![The Postgres Expert Welcome message](../images/pe_welcome.png) +1. The **Experts/Rules** tree lists the available experts and rules for identifying best practice deviations. Select the ones you want to use to evaluate the selected servers or databases. -The **Experts/Rules** tree lists the available experts and rules for identifying best practice deviations. Select the ones you want to use to evaluate the selected servers or databases. + The tree categorizes the rules under three experts: -![The PEM Agent Installer's Welcome dialog](../images/pe_select_rules.png) + - **Configuration Expert** evaluates the parameter settings of the server or operating system to find any adjustments that might improve system performance. + - **Schema Expert** evaluates schema objects, such as locating missing primary keys or foreign keys without indexes. + - **Security Expert** evaluates the system to find security vulnerabilities. -The tree categorizes the rules under three experts: + After making your selections, select **Next**. -- **Configuration Expert** evaluates the parameter settings of the server or operating system to find any adjustments that might improve system performance. -- **Schema Expert** evaluates schema objects, such as locating missing primary keys or foreign keys without indexes. -- **Security Expert** evaluates the system to find security vulnerabilities. +1. Select or clear the servers and databases that you want to evaluate. If you select multiple servers or databases, then the resulting report contains a separate evaluation of each target. After you finish, select **Next**. -After making your selections, select **Next**. - -![The Servers/Databases dialog box](../images/pe_select_servers.png) - -Select or clear the servers and databases that you want to evaluate. If you select multiple servers or databases, then the resulting report contains a separate evaluation of each target. After you finish, select **Next**. - -![Specify a report destination](../images/pe_direct_output.png) - -To view the report in the client, select **View the report now**. To save a copy to an HTML file, select **Download the report**. If you download the report, then the file saves to your default download directory. Select **Finish**. +1. To view the report in the client, select **View the report now**. To save a copy to an HTML file, select **Download the report**. If you download the report, then the file saves to your default download directory. Select **Finish**. ## Reviewing Postgres Expert recommendations Postgres Expert produces a report that contains an evaluation of the selected rules. Each rule is categorized as high, medium, or low severity for the selected servers. -![The Postgres Expert report](../images/pe_report.png) - The report header contains a summary of the report that includes: - The date and time of the report diff --git a/product_docs/docs/pem/8/tuning_performance/tuning_wizard.mdx b/product_docs/docs/pem/8/tuning_performance/tuning_wizard.mdx index bf29e459862..2e9c5bdf9f7 100644 --- a/product_docs/docs/pem/8/tuning_performance/tuning_wizard.mdx +++ b/product_docs/docs/pem/8/tuning_performance/tuning_wizard.mdx @@ -14,73 +14,59 @@ Before using the Tuning Wizard, you must specify the name of the service in the The Tuning Wizard can make recommendations only for those servers that reside on the same server as their bound PEM agent. If you specify a value of **Yes** in the **Remote monitoring** field when defining your server, the server doesn't display in the Tuning Wizard tree. -To open the Tuning Wizard, in the PEM client select **Management > Tuning Wizard**. +1. To open the Tuning Wizard, in the PEM client select **Management > Tuning Wizard**. -![The Tuning Wizard Welcome message](../images/tuning_wiz_welcome.png) +1. Select **Next**. -Select **Next**. +1. When you expand the **Servers** node of the tree, a list of servers appears. All of these servers are currently monitored by PEM and available for tuning. Select a server to tune it. -![The Select Servers dialog box](../images/tuning_wiz_server_sel.png) + !!! Note + If you don't provide the server's service name, then the Tuning Wizard displays a warning next to the server name on the tree. -When you expand the **Servers** node of the tree, a list of servers appears. All of these servers are currently monitored by PEM and available for tuning. Select a server to tune it. + Select **Next**. -!!! Note - If you don't provide the server's service name, then the Tuning Wizard displays a warning next to the server name on the tree. +1. Select an option in the **Machine utilization** field to specify the type of work performed by each server. The type of work performed by the server determines how the Tuning Wizard allocates system resources: -Select **Next**. + - Select **Dedicated** to dedicate the majority of the system resources to the database server. + - Select **Mixed use** to dedicate a moderate amount of system resources to the database server. + - Select **Developer workstation** to dedicate a relatively small amount of system resources to the database server. -![The Configuration dialog](../images/tuning_wiz_configuration.png) + Select an option in the **Workload Selection** field to specify the type of workload typically performed on the selected server: -Select an option in the **Machine utilization** field to specify the type of work performed by each server. The type of work performed by the server determines how the Tuning Wizard allocates system resources: + - Select **OLTP** if the selected server is used primarily to process online transaction workloads. + - Select **Mixed** if the selected server provides a mix of transaction processing and data reporting. + - Select **Data warehouse** if the server is used for heavy data reporting. -- Select **Dedicated** to dedicate the majority of the system resources to the database server. -- Select **Mixed use** to dedicate a moderate amount of system resources to the database server. -- Select **Developer workstation** to dedicate a relatively small amount of system resources to the database server. + Select **Next**. -Select an option in the **Workload Selection** field to specify the type of workload typically performed on the selected server: +1. The tree on the Tuning Changes Summary dialog box displays the parameter setting modifications recommended for each server analyzed by the Tuning Wizard. Select the recommendations that you want the Tuning Wizard to apply or to include in a preview report: -- Select **OLTP** if the selected server is used primarily to process online transaction workloads. -- Select **Mixed** if the selected server provides a mix of transaction processing and data reporting. -- Select **Data warehouse** if the server is used for heavy data reporting. + - Select a parameter name and the Tuning Wizard includes the parameter setting. + - Select the server name and the Tuning Wizard includes all parameter setting recommendations for the specified server. -Select **Next**. + Select **Next**. -![The Tuning Changes Summary dialog box](../images/tuning_wiz_changes_sum.png) +1. In the **Schedule or Run?** dialog box, either select a time for PEM to apply the recommended changes or generate a report that details the recommended changes. -The tree on the **Tuning Changes Summary** dialog box displays the parameter setting modifications recommended for each server analyzed by the Tuning Wizard. Select the recommendations that you want the Tuning Wizard to apply or to include in a preview report: + PEM makes the recommended changes that you selected in the **Tuning Changes Summary** dialog box. If you choose to generate a report, then PEM creates a report. It contains a list of the current values and recommended changes to the configuration parameters as selected in the **Tuning Changes Summary** dialog box. To implement changes, you must open the Tuning Wizard a second time, selecting the parameters you want to modify in the **Tuning Changes Summary** dialog box. -- Select a parameter name and the Tuning Wizard includes the parameter setting. -- Select the server name and the Tuning Wizard includes all parameter setting recommendations for the specified server. + Select **Schedule changes** to view and specify your scheduling options. -Select **Next**. - -In the **Schedule or Run?** dialog box, either select a time for PEM to apply the recommended changes or generate a report that details the recommended changes. - -PEM makes the recommended changes that you selected in the **Tuning Changes Summary** dialog box. If you choose to generate a report, then PEM creates a report. It contains a list of the current values and recommended changes to the configuration parameters as selected in the **Tuning Changes Summary** dialog box. To implement changes, you must open the Tuning Wizard a second time, selecting the parameters you want to modify in the **Tuning Changes Summary** dialog box. - -Select **Schedule changes** to view and specify your scheduling options. - -![The Schedule or Run? dialog](../images/tuning_wiz_apply_changes.png) - -You can set the **Configuration now?** slider to: + You can set the **Configuration now?** slider to: - **Yes** — Apply the Tuning Wizard's recommendations and restart the server. - **No** — Enable the **Time?** field where you can specify a date and time with the calendar selector. PEM applies the recommended changes and restarts the server at this time. -Select **Generate report** to view your report options. - -![The Schedule or Run? dialog box](../images/tuning_wiz_generate_report.png) + Select **Generate report** to view your report options. -You can set the **View report now?** slider to: + You can set the **View report now?** slider to: - **Yes** — Display the Tuning Wizard report onscreen. - **No** — Enable the **Save the report to file** field where you can specify a file name and location. -Select **Finish**. - -![The Tuning Wizard report](../images/tuning_wiz_report.png) +1. Select **Finish**. To confirm that the Tuning Wizard implemented the recommended changes, review the `postgresql.conf` file for the modified server. When the change is applied, the Tuning Wizard adds a comment above each modified parameter in the `postgresql.conf` file. diff --git a/product_docs/docs/pgd/4/architectures/index.mdx b/product_docs/docs/pgd/4/architectures/index.mdx index bc0a1a1004d..6fb6812a497 100644 --- a/product_docs/docs/pgd/4/architectures/index.mdx +++ b/product_docs/docs/pgd/4/architectures/index.mdx @@ -20,8 +20,8 @@ EDB has identified four standard Always On architectures: - [Gold](gold): Two locations with two data nodes each and a third location with a witness - [Platinum](platinum): Two locations with three data nodes each (two masters plus additional redundant hardware in a hot standby mode) -!!! Note: A location is either a data center or availability zone \[AZ\] - +!!! Note "Note: A location is either a data center or availability zone \[AZ\]." +!!! All Always On architectures protect a progressively robust range of failure situations. For example, Always On Bronze protects against local hardware failure but doesn't provide protection from location (data center or AZ) failure. Always On Silver makes sure that a backup is kept at a different location, thus providing some protection in case of the catastrophic loss of a location. However, the database still must be restored from backup first, which might violate Recovery Time Objective (RTO) requirements. Always On Gold provides two locations connected in a multi-master mesh network, making sure that service remains available even in case a location goes offline. Finally, Always On Platinum adds redundant hot standby hardware in both locations to maintain local high availability in case of a hardware failure. Each architecture can provide zero Recovery Point Objective (RPO), as data can be streamed synchronously to at least one local master, thus guaranteeing zero data loss in case of local hardware failure. However, synchronous replication is highly discouraged for Bronze architectures due to the extended RPO on failure of either data node.