From 35c8567bf8798cffca483283cf3d2df6d5133fb7 Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Tue, 15 Jun 2021 18:07:18 +0000 Subject: [PATCH 1/4] code-escape <> placeholders Former-commit-id: 67364304ee3452a200a7e587e3c9034f0383be0d --- .../03_installing_pem_server_on_linux.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/03_installing_pem_server_on_linux.mdx b/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/03_installing_pem_server_on_linux.mdx index afe29c79afc..b245035038d 100644 --- a/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/03_installing_pem_server_on_linux.mdx +++ b/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/03_installing_pem_server_on_linux.mdx @@ -41,7 +41,7 @@ To create an EnterpriseDB repository configuration file, assume superuser privil yum -y install https://yum.enterprisedb.com/edb-repo-rpms/edb-repo-latest.noarch.rpm ``` -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After creating the `edb.repo` file, use the following command to replace the `USERNAME` and `PASSWORD` placeholders in the `baseurl` specification with the and of a registered EDB user: +The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After creating the `edb.repo` file, use the following command to replace the `USERNAME` and `PASSWORD` placeholders in the `baseurl` specification with the `` and `` of a registered EDB user: ```text sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo @@ -106,7 +106,7 @@ The following steps will walk you through using the EDB `apt` repository to inst sh -c 'echo "deb [arch=amd64] https://apt.enterprisedb.com/$(lsb_release -cs)-edb/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/edb-$(lsb_release -cs).list' ``` - b. Substitute your EnterpriseDB credentials for the `username` and `password` placeholders in the following command: + b. Substitute your EnterpriseDB credentials for the `` and `` placeholders in the following command: ```text sh -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf' From 2257bc6ab12ee7602214be2c024f9b961e58e802 Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Tue, 15 Jun 2021 18:18:17 +0000 Subject: [PATCH 2/4] normalize markdown Former-commit-id: d9aefdf6933c7854c06d7cf58ecdeb1d0b377bef --- .../02_installing_pem_overview.mdx | 8 +- .../03_using_pem_web_interface.mdx | 189 ++++++------ .../8.1.0/pem_admin/02_registering_server.mdx | 20 +- .../pem/8.1.0/pem_bart/01_managing_bart.mdx | 1 - .../pem/8.1.0/pem_ent_feat/01_what's_new.mdx | 2 +- .../8.1.0/pem_ent_feat/02_pem_query_tool.mdx | 13 +- .../8.1.0/pem_ent_feat/04_pem_erd_tool.mdx | 62 ++-- ..._performance_monitoring_and_management.mdx | 40 ++- .../pem/8.1.0/pem_ent_feat/16_reference.mdx | 272 +++++++++--------- .../pem_ent_feat/17_monitoring_BDR_nodes.mdx | 8 +- ...rerequisites_for_installing_pem_server.mdx | 2 + ..._server_to_use_kerberos_authentication.mdx | 139 +++++---- ..._server_to_use_windows_kerberos_server.mdx | 173 +++++------ .../08_installing_pem_agent_on_linux.mdx | 6 +- .../pem_inst_guide_windows/01_whats_new.mdx | 2 +- .../04_pem_roles.mdx | 13 +- .../08_pem_define_aws_instance_connection.mdx | 13 +- .../01_pem_agent_config_params.mdx | 13 +- .../06_pem_agent_config_params.mdx | 13 +- .../01_pem_alerting_dialog.mdx | 47 ++- .../09_pem_alerting/06_pem_webhooks.mdx | 13 +- .../16_pem_scheduled_jobs.mdx | 13 +- .../20_performance_diagnostic.mdx | 13 +- .../03_import_export_data.mdx | 13 +- .../06_backup_dialog.mdx | 13 +- .../07_backup_globals_dialog.mdx | 13 +- .../08_backup_server_dialog.mdx | 13 +- .../08_rls_policy_dialog.mdx | 13 +- .../08_restoring_bart_backups.mdx | 13 +- .../01_sp_installing_sql_profiler.mdx | 26 +- .../04_sp_index_advisor.mdx | 13 +- .../04_editgrid/01_viewdata_filter.mdx | 13 +- .../10_pgagent/02_pgagent_install.mdx | 26 +- .../10_pgagent/03_pgagent_jobs.mdx | 13 +- .../01_installing_the_sql_profiler_plugin.mdx | 3 +- .../02_upgrading_backend_database.mdx | 4 +- .../pem_upgrade/03_moving_pem_server.mdx | 157 +++++----- 37 files changed, 604 insertions(+), 804 deletions(-) diff --git a/product_docs/docs/pem/8.1.0/pem_admin/01_overview/02_installing_pem_overview.mdx b/product_docs/docs/pem/8.1.0/pem_admin/01_overview/02_installing_pem_overview.mdx index b01701a2ab4..78c5458774b 100644 --- a/product_docs/docs/pem/8.1.0/pem_admin/01_overview/02_installing_pem_overview.mdx +++ b/product_docs/docs/pem/8.1.0/pem_admin/01_overview/02_installing_pem_overview.mdx @@ -4,12 +4,12 @@ title: "Installing PEM - Overview" For detailed instructions about installing PEM, please consult the `PEM Installation Guides`, available at: - https://www.enterprisedb.com/docs/ + The basic steps involved in the PEM installation process are: -1. Install the PEM server components. The PEM server software and backend database (named pem) may reside on the same host as the supporting httpd server, or may reside on a separate host. The PEM server installer installs a PEM agent and the PEM Web client on the host of the PEM server. +1. Install the PEM server components. The PEM server software and backend database (named pem) may reside on the same host as the supporting httpd server, or may reside on a separate host. The PEM server installer installs a PEM agent and the PEM Web client on the host of the PEM server. -2. Register each additional physical or virtual machine that you would like to manage with PEM. For convenience, PEM supports remote monitoring (an agent is not required to reside on the same host as the server that it monitors). Please note that a remote agent cannot retrieve all of the information available from a monitored server; you may wish to install an agent on each server host. +2. Register each additional physical or virtual machine that you would like to manage with PEM. For convenience, PEM supports remote monitoring (an agent is not required to reside on the same host as the server that it monitors). Please note that a remote agent cannot retrieve all of the information available from a monitored server; you may wish to install an agent on each server host. -3. Install the SQL Profiler component into each Postgres instance on which you want to perform SQL capture and analysis. The SQL Profiler installer will prompt you for the location of your Postgres installation, and place the required software into that directory. The SQL Profiler plugin is already installed on Advanced Server instances, and requires only configuration to enable profiling. +3. Install the SQL Profiler component into each Postgres instance on which you want to perform SQL capture and analysis. The SQL Profiler installer will prompt you for the location of your Postgres installation, and place the required software into that directory. The SQL Profiler plugin is already installed on Advanced Server instances, and requires only configuration to enable profiling. diff --git a/product_docs/docs/pem/8.1.0/pem_admin/01_overview/03_using_pem_web_interface.mdx b/product_docs/docs/pem/8.1.0/pem_admin/01_overview/03_using_pem_web_interface.mdx index 3c2ba429f4a..2580963618a 100644 --- a/product_docs/docs/pem/8.1.0/pem_admin/01_overview/03_using_pem_web_interface.mdx +++ b/product_docs/docs/pem/8.1.0/pem_admin/01_overview/03_using_pem_web_interface.mdx @@ -12,9 +12,9 @@ Where `ip_address_of_PEM_host` specifies the IP address of the host of the PEM s 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 will be the name provided when installing the PEM server. +- Provide the name of a pem database user in the `Username` field. For the first user connecting, this will be the name provided when installing the PEM server. -- Provide the password associated with the user in the `Password` field. +- Provide the password associated with the user in the `Password` field. After providing your credentials, click `Login` to connect to PEM. @@ -28,11 +28,11 @@ The `Browser` pane displays a tree control that provides access to information a The PEM menu bar provides access to commands and features that you can use to manage your database servers and the objects that reside on those servers. If an option is disabled: -- The database server to which you are currently connected may not support the selected feature. +- The database server to which you are currently connected may not support the selected feature. -- The selected menu option may not be valid for the current object (by design). +- The selected menu option may not be valid for the current object (by design). -- The role that you have used to connect to the server may have insufficient privileges to change the selected object. +- The role that you have used to connect to the server may have insufficient privileges to change the selected object. Context-sensitive menus across the top of the PEM web interface allow you to customize your environment and provide access to the enterprise management features of PEM. @@ -42,12 +42,12 @@ Context-sensitive menus across the top of the PEM web interface allow you to cus Use the `File` menu to access the following options: -| Menu Option | Action | -| ------------------------|----------------------------------------------------------------------------------------------------------------------| -| Preferences | Click to open the Preferences dialog to customize your PEM client settings. | -| Lock Layout | Click to open a sub-menu to select the level for locking the UI layout. | -| Server Configuration | Click to open the Server Configuration dialog and update your PEM server configuration settings. | -| Reset Layout | If a workspace panel is popped out by mistake or intentionally it can be reset back to default using Reset Layout. | +| Menu Option | Action | +| -------------------- | ------------------------------------------------------------------------------------------------------------------ | +| Preferences | Click to open the Preferences dialog to customize your PEM client settings. | +| Lock Layout | Click to open a sub-menu to select the level for locking the UI layout. | +| Server Configuration | Click to open the Server Configuration dialog and update your PEM server configuration settings. | +| Reset Layout | If a workspace panel is popped out by mistake or intentionally it can be reset back to default using Reset Layout. | ### The Object Menu @@ -55,23 +55,23 @@ Use the `File` menu to access the following options: The `Object` menu is context-sensitive. Use the `Object` menu to access the following options: -| Menu Option | Action | -| --------------------------| ------------------------------------------------------------------------------------------------------------------------------------------------ | -| Create | Click `Create` to access a context menu that provides context-sensitive selections. | -| Refresh... | Click to refresh the currently selected object. | -| Delete/Drop | Click to delete the currently selected object from the server. | -| Connect Server | Click to open the Connect to Server dialog to establish a connection with a server. | -| CREATE Script | Click to open the Query tool to edit or view the selected script. | -| Disconnect Server | Click to refresh the currently selected object. | -| BART | Click to access a context menu that provides options for removing BART configuration, taking a BART backup, or revalidate the BART configuration.| -| Clear Saved Password | If you have saved the database server password, click to clear the saved password. Enabled only after password is saved. | -| Clear SSH Tunnel Password | If you have saved the ssh tunnel password, click to clear the saved password. Enabled only after password is saved. | -| Drop Cascade | Click to delete the currently selected object and all dependent objects from the server. | -| Hide | Click to hide the currently selected group; to view hidden groups, enable the Show hidden groups option in Preferences. | -| Properties... | Click to review or modify the currently selected object's properties. | -| Trigger(s) | Click to `Disable` or `Enable` trigger(s) for the currently selected table. | -| Truncate | Click to remove all rows from a table (Truncate) or to remove all rows from a table and its child tables (Truncate Cascade). | -| View Data | Click to access a context menu that provides several options for viewing data. | +| Menu Option | Action | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| Create | Click `Create` to access a context menu that provides context-sensitive selections. | +| Refresh... | Click to refresh the currently selected object. | +| Delete/Drop | Click to delete the currently selected object from the server. | +| Connect Server | Click to open the Connect to Server dialog to establish a connection with a server. | +| CREATE Script | Click to open the Query tool to edit or view the selected script. | +| Disconnect Server | Click to refresh the currently selected object. | +| BART | Click to access a context menu that provides options for removing BART configuration, taking a BART backup, or revalidate the BART configuration. | +| Clear Saved Password | If you have saved the database server password, click to clear the saved password. Enabled only after password is saved. | +| Clear SSH Tunnel Password | If you have saved the ssh tunnel password, click to clear the saved password. Enabled only after password is saved. | +| Drop Cascade | Click to delete the currently selected object and all dependent objects from the server. | +| Hide | Click to hide the currently selected group; to view hidden groups, enable the Show hidden groups option in Preferences. | +| Properties... | Click to review or modify the currently selected object's properties. | +| Trigger(s) | Click to `Disable` or `Enable` trigger(s) for the currently selected table. | +| Truncate | Click to remove all rows from a table (Truncate) or to remove all rows from a table and its child tables (Truncate Cascade). | +| View Data | Click to access a context menu that provides several options for viewing data. | ### The Management Menu @@ -79,21 +79,21 @@ The `Object` menu is context-sensitive. Use the `Object` menu to access the foll Use the `Management` menu to access the following PEM features: -| Menu Option | Action | -| -------------------------------| ------------------------------------------------------------------------------------------------------------------- | -| Audit Manager... | Click to open the Audit Manager and configure auditing on your monitored servers. | -| Auto Discovery... | Click to open the Auto Discovery dialog to instruct a PEM agent to locate and bind monitored database servers. | -| Capacity Manager... | Click to open the Capacity Manager dialog and analyze historical or project future resource usage. | -| Log Manager... | Click to open the Log Manager dialog and configure log collection for a server. | -| Manage Alerts... | Click to access the Manage Alerts tab and create or modify alerting behavior. | -| Manage Charts... | Click to open the Manage Charts tab to create or modify PEM charts. | -| Manage Dashboards... | Click to open the Manage Dashboards dialog to VACUUM, ANALYZE, REINDEX, or CLUSTER. | -| Manage Probes... | Click to open the Manage Probes dialog to VACUUM, ANALYZE, REINDEX, or CLUSTER. | -| Postgres Expert... | Click to open the Postgres Expert wizard and perform a static analysis of your servers and databases. | -| Postgres Log Analysis Expert...| Click to access the Postgres Log Analysis Expert dialog analyze log file contents for usage trends. | -| Scheduled Tasks | Click to open the Scheduled Tasks tab and review tasks that are pending or recently completed. | -| Tuning Wizard... | Click to open the Tuning Wizard dialog to generate a set of tuning recommendations for your server. | -| Reports | Click to open the Reports dialog to generate the system configuration report and core usage report for your server. | +| Menu Option | Action | +| ------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| Audit Manager... | Click to open the Audit Manager and configure auditing on your monitored servers. | +| Auto Discovery... | Click to open the Auto Discovery dialog to instruct a PEM agent to locate and bind monitored database servers. | +| Capacity Manager... | Click to open the Capacity Manager dialog and analyze historical or project future resource usage. | +| Log Manager... | Click to open the Log Manager dialog and configure log collection for a server. | +| Manage Alerts... | Click to access the Manage Alerts tab and create or modify alerting behavior. | +| Manage Charts... | Click to open the Manage Charts tab to create or modify PEM charts. | +| Manage Dashboards... | Click to open the Manage Dashboards dialog to VACUUM, ANALYZE, REINDEX, or CLUSTER. | +| Manage Probes... | Click to open the Manage Probes dialog to VACUUM, ANALYZE, REINDEX, or CLUSTER. | +| Postgres Expert... | Click to open the Postgres Expert wizard and perform a static analysis of your servers and databases. | +| Postgres Log Analysis Expert... | Click to access the Postgres Log Analysis Expert dialog analyze log file contents for usage trends. | +| Scheduled Tasks | Click to open the Scheduled Tasks tab and review tasks that are pending or recently completed. | +| Tuning Wizard... | Click to open the Tuning Wizard dialog to generate a set of tuning recommendations for your server. | +| Reports | Click to open the Reports dialog to generate the system configuration report and core usage report for your server. | ### The Dashboards Menu @@ -101,48 +101,48 @@ Use the `Management` menu to access the following PEM features: Use the context-sensitive `Dashboards` menu to access dashboards: -| Option | Action | -| ----------------------------- | --------------------------------------------------------------------------------- | -| Alerts | Click to open the Alerts Dashboard for the selected node. | -| Audit Log | Click to open the Audit Log Analysis Dashboard for the selected node. | -| BDR Admin | Click to open the BDR Admin Dashboard for the selected node. | -| BDR Group Monitoring | Click to open the BDR Group Monitoring Dashboard for the selected node. | -| BDR Node Monitoring | Click to open the BDR Node Monitoring Dashboard for the selected node. | -| Database Server | Click to open the Database Analysis Dashboard for the selected node. | -| I/O Analysis | Click to open the I/O Analysis Dashboard for the selected node. | -| Memory | Click to open the Memory Analysis Dashboard for the selected node. | -| Object Activity | Click to open the Object Activity Analysis Dashboard for the selected node. | -| Operating System | Click to open the Operating System Analysis Dashboard for the selected node. | -| Probe Log | Click to open the Probe Log Analysis Dashboard for the selected node. | -| Server Log | Click to open the Server Log Analysis Dashboard for the selected node. | -| Session Activity | Click to open the Session Activity Analysis Dashboard for the selected node. | -| Storage | Click to open the Storage Analysis Dashboard for the selected node. | -| Streaming Replication | Click to open the Streaming Replication Analysis Dashboard for the selected node. | -| System Wait | Click to open the System Wait Analysis Dashboard for the selected node. | +| Option | Action | +| --------------------- | --------------------------------------------------------------------------------- | +| Alerts | Click to open the Alerts Dashboard for the selected node. | +| Audit Log | Click to open the Audit Log Analysis Dashboard for the selected node. | +| BDR Admin | Click to open the BDR Admin Dashboard for the selected node. | +| BDR Group Monitoring | Click to open the BDR Group Monitoring Dashboard for the selected node. | +| BDR Node Monitoring | Click to open the BDR Node Monitoring Dashboard for the selected node. | +| Database Server | Click to open the Database Analysis Dashboard for the selected node. | +| I/O Analysis | Click to open the I/O Analysis Dashboard for the selected node. | +| Memory | Click to open the Memory Analysis Dashboard for the selected node. | +| Object Activity | Click to open the Object Activity Analysis Dashboard for the selected node. | +| Operating System | Click to open the Operating System Analysis Dashboard for the selected node. | +| Probe Log | Click to open the Probe Log Analysis Dashboard for the selected node. | +| Server Log | Click to open the Server Log Analysis Dashboard for the selected node. | +| Session Activity | Click to open the Session Activity Analysis Dashboard for the selected node. | +| Storage | Click to open the Storage Analysis Dashboard for the selected node. | +| Streaming Replication | Click to open the Streaming Replication Analysis Dashboard for the selected node. | +| System Wait | Click to open the System Wait Analysis Dashboard for the selected node. | ### 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 | -| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Schema Diff | Click to open the Schema Diff dialog to compare the schema objects between two database schemas. | -| Search objects | Click to open the Search Objects dialog to search the database objects within a database. | -| Server | Click to access the various server related tools such as Add Named Restore Point, Performance Diagnostics, Queue Server Startup, Queue Server Shutdown, Replace Cluster Primary, Switchover EFM Cluster and SQL Profiler.| -| Query Tool | Click to open the Query tool for the currently selected object. | -| Reload Configuration | Click to update configuration files without restarting the server. | -| Pause replay of WAL | Click to pause the replay of the WAL log. | -| Resume replay of WAL | Click to resume the replay of the WAL log. | -| Import/Export... | Click to open the Import/Export data... dialog to import or export data from a table. | -| Maintenance... | Click to open the Maintenance... dialog to VACUUM, ANALYZE, REINDEX, or CLUSTER. | -| Backup... | Click to open the Backup... dialog to backup database objects. | -| Backup Globals... | Click to open the Backup Globals... dialog to backup cluster objects. | -| Backup Server... | Click to open the Backup Server... dialog to backup a server. | -| Restore... | Click to access the Restore dialog to restore database files from a backup. | -| Grant Wizard... | Click to access the Grant Wizard tool. | -| Schedule Backup | Click to access the Schedule Backup dialog for BART backups. | +| Option | Action | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Schema Diff | Click to open the Schema Diff dialog to compare the schema objects between two database schemas. | +| Search objects | Click to open the Search Objects dialog to search the database objects within a database. | +| Server | Click to access the various server related tools such as Add Named Restore Point, Performance Diagnostics, Queue Server Startup, Queue Server Shutdown, Replace Cluster Primary, Switchover EFM Cluster and SQL Profiler. | +| Query Tool | Click to open the Query tool for the currently selected object. | +| Reload Configuration | Click to update configuration files without restarting the server. | +| Pause replay of WAL | Click to pause the replay of the WAL log. | +| Resume replay of WAL | Click to resume the replay of the WAL log. | +| Import/Export... | Click to open the Import/Export data... dialog to import or export data from a table. | +| Maintenance... | Click to open the Maintenance... dialog to VACUUM, ANALYZE, REINDEX, or CLUSTER. | +| Backup... | Click to open the Backup... dialog to backup database objects. | +| Backup Globals... | Click to open the Backup Globals... dialog to backup cluster objects. | +| Backup Server... | Click to open the Backup Server... dialog to backup a server. | +| Restore... | Click to access the Restore dialog to restore database files from a backup. | +| Grant Wizard... | Click to access the Grant Wizard tool. | +| Schedule Backup | Click to access the Schedule Backup dialog for BART backups. | ### The Help Menu @@ -150,12 +150,12 @@ Use the options on the `Tools` menu to access the following features: Use the options on the `Help` menu to access the online help documents or to review information about the PEM installation: -| Option | Action | -| -------------------------------- | -------------------------------------------------------------------------------- | -| Online Help | Click to open documentation for Postgres Enterprise Manager. | -| REST API Reference | Click to open the REST API Reference. | -| EDB Website | Click to open the EDB website in a browser window. | -| About Postgres Enterprise Manager| Click to locate versioning and user information for Postgres Enterprise Manager. | +| Option | Action | +| --------------------------------- | -------------------------------------------------------------------------------- | +| Online Help | Click to open documentation for Postgres Enterprise Manager. | +| REST API Reference | Click to open the REST API Reference. | +| EDB Website | Click to open the EDB website in a browser window. | +| About Postgres Enterprise Manager | Click to locate versioning and user information for Postgres Enterprise Manager. | ## Controlling and Customizing Charts, Graphs and Tables @@ -165,19 +165,17 @@ Use the icons in the upper-right corner of each graphic on a dashboard to contro The following table gives the information about icons: -| Icons | Information | -| ---------------------------------------- | ---------------------------------------------------------------------- | -| ![icon6](../../images/lginformation.png) | View information about the chart, graph, or table. | -| ![icon1](../../images/lgrefresh.png) | Refresh the content of a chart, graph or table. | -| ![icon3](../../images/lgpersonalize.png) | Personalize the chart, graph, or table settings for the current user. | -| ![icon4](../../images/lgdownload.png) | Download an image of the chart or graph. | -| ![icon5](../../images/lginformation.png) | View the legends that are used in the chart, graph, or table. | -| ![icon2](../../images/lgfullscreen.png) | Expand the chart or graph to full-screen. | - +| Icons | Information | +| ---------------------------------------- | --------------------------------------------------------------------- | +| ![icon6](../../images/lginformation.png) | View information about the chart, graph, or table. | +| ![icon1](../../images/lgrefresh.png) | Refresh the content of a chart, graph or table. | +| ![icon3](../../images/lgpersonalize.png) | Personalize the chart, graph, or table settings for the current user. | +| ![icon4](../../images/lgdownload.png) | Download an image of the chart or graph. | +| ![icon5](../../images/lginformation.png) | View the legends that are used in the chart, graph, or table. | +| ![icon2](../../images/lgfullscreen.png) | Expand the chart or graph to full-screen. | For more information about customizing the graphics displayed on the PEM dashboards, please see the PEM client online help. - ## Online Help and Documentation PEM contains built-in help that provides assistance in using the tool. To access the online help for PEM, select `Online Help` from the `Help` option on the `Help` menu. @@ -185,4 +183,3 @@ PEM contains built-in help that provides assistance in using the tool. To access ![The PEM online help](../../images/pem_online_help.png) The `Help` menu also provides quick access to the EDB website. - diff --git a/product_docs/docs/pem/8.1.0/pem_admin/02_registering_server.mdx b/product_docs/docs/pem/8.1.0/pem_admin/02_registering_server.mdx index 43b557725df..d7cd51cd6ed 100644 --- a/product_docs/docs/pem/8.1.0/pem_admin/02_registering_server.mdx +++ b/product_docs/docs/pem/8.1.0/pem_admin/02_registering_server.mdx @@ -105,7 +105,7 @@ Use fields on the `PEM Agent` tab to specify connection details for the PEM agen - Move the `Remote monitoring?` slider to `Yes` to indicate that the PEM agent does not reside on the same host as the monitored server. When remote monitoring is enabled, agent level statistics for the monitored server will not be available for custom charts and dashboards, and the remote server will not be accessible by some PEM utilities (such as Audit Manager, Capacity Manager, Log Manager, Postgres Expert and Tuning Wizard). -- Use the drop-down listbox to the right of the `Bound agent` label to select a PEM agent . One agent can monitor multiple Postgres servers. +- Use the drop-down listbox to the right of the `Bound agent` label to select a PEM agent . One agent can monitor multiple Postgres servers. - Enter the IP address or socket path that the agent should use when connecting to the database server in the `Host` field. By default, the agent will use the host address shown on the `General` tab. On a Unix server, you may wish to specify a socket path, e.g. `/tmp`. @@ -113,16 +113,14 @@ Use fields on the `PEM Agent` tab to specify connection details for the PEM agen - Use the drop-down listbox in the `SSL` field to specify an SSL operational mode; specify require, prefer, allow, disable, verify-ca or verify-full. - -| Mode | Description | ---------------------|-------------------------------------------------------------------------------------------------------------------------------------------| -| require | To require SSL encryption for transactions between the server and the agent. | -| prefer | To use SSL encryption between the server and the agent if SSL encryption is available. | -| allow | To allow the connection to use SSL if required by the server. | -| disable | To disable SSL encryption between the agent and the server. | -| verify-ca | To require SSL encryption, and to require the server to authenticate using a certificate registered by a certificate authority. | -| verify-full | To require SSL encryption, and to require the server to authenticate using a certificate registered by a `trusted` certificate authority. | - +| Mode | Description | +| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| require | To require SSL encryption for transactions between the server and the agent. | +| prefer | To use SSL encryption between the server and the agent if SSL encryption is available. | +| allow | To allow the connection to use SSL if required by the server. | +| disable | To disable SSL encryption between the agent and the server. | +| verify-ca | To require SSL encryption, and to require the server to authenticate using a certificate registered by a certificate authority. | +| verify-full | To require SSL encryption, and to require the server to authenticate using a certificate registered by a `trusted` certificate authority. | For more information about using SSL encryption, see the [PostgreSQL documentation](https://www.postgresql.org/docs/12.1/libpq-ssl.html). diff --git a/product_docs/docs/pem/8.1.0/pem_bart/01_managing_bart.mdx b/product_docs/docs/pem/8.1.0/pem_bart/01_managing_bart.mdx index dc25e19be9c..034ebf3f330 100644 --- a/product_docs/docs/pem/8.1.0/pem_bart/01_managing_bart.mdx +++ b/product_docs/docs/pem/8.1.0/pem_bart/01_managing_bart.mdx @@ -271,7 +271,6 @@ Use the fields within the `Times` box to specify the times at which the schedule - Use the `Hours` field to select the hour at which the schedule will execute. - Use the `Minutes` field to select the minute at which the schedule will execute. - ## Restoring BART Backups You can restore the backups that you have earlier created using BART server on a target remote host. When you select a particular BART server, all the associated backups are listed in the Dashboard under `Initiated Server Backups`. diff --git a/product_docs/docs/pem/8.1.0/pem_ent_feat/01_what's_new.mdx b/product_docs/docs/pem/8.1.0/pem_ent_feat/01_what's_new.mdx index 67b21c02d6f..6d6a52ee922 100644 --- a/product_docs/docs/pem/8.1.0/pem_ent_feat/01_what's_new.mdx +++ b/product_docs/docs/pem/8.1.0/pem_ent_feat/01_what's_new.mdx @@ -13,4 +13,4 @@ The following changes have been made to Postgres Enterprise Manager to create ve - Added ability to configure the following PEM tools without restarting the monitored server: - Log Manager - Audit Manager - - Tuning Wizard \ No newline at end of file + - Tuning Wizard diff --git a/product_docs/docs/pem/8.1.0/pem_ent_feat/02_pem_query_tool.mdx b/product_docs/docs/pem/8.1.0/pem_ent_feat/02_pem_query_tool.mdx index 810b6969f1f..46268351161 100644 --- a/product_docs/docs/pem/8.1.0/pem_ent_feat/02_pem_query_tool.mdx +++ b/product_docs/docs/pem/8.1.0/pem_ent_feat/02_pem_query_tool.mdx @@ -187,22 +187,21 @@ Use the `Notifications` tab to view the notifications using PostgreSQL `Listen/N Example: -1. Execute ``LISTEN "foo"`` in first ``Query Tool`` session. +1. Execute `LISTEN "foo"` in first `Query Tool` session. ![Query Tool - notifications listen](../images/query_output_notifications_listen.png) -2. In the another ``Query Tool`` session, execute ``Notify`` command or ``pg_notify`` -function to send the notification of the event together with the payload. +2. In the another `Query Tool` session, execute `Notify` command or `pg_notify` + function to send the notification of the event together with the payload. ![Query Tool - notifications notify](../images/query_output_notifications_notify.png) -3. You can observe the ``Notification`` tab in the first ``Query Tool`` session -where it shows the Recorded time, Event, Process ID, and the Payload of the -particular channel. +3. You can observe the `Notification` tab in the first `Query Tool` session + where it shows the Recorded time, Event, Process ID, and the Payload of the + particular channel. ![Query Tool - Output Notifications panel](../images/query_output_notifications_panel.png) - ## Query History Panel Use the `Query History` tab to review activity for the current session: diff --git a/product_docs/docs/pem/8.1.0/pem_ent_feat/04_pem_erd_tool.mdx b/product_docs/docs/pem/8.1.0/pem_ent_feat/04_pem_erd_tool.mdx index f253316b5d8..b738518d1d2 100644 --- a/product_docs/docs/pem/8.1.0/pem_ent_feat/04_pem_erd_tool.mdx +++ b/product_docs/docs/pem/8.1.0/pem_ent_feat/04_pem_erd_tool.mdx @@ -13,7 +13,7 @@ The **Entity-Relationship Diagram (ERD)** tool is a database design tool that pr ![ERD Tool](../images/erd_tool.png) -You can open multiple copies of the ERD tool in individual tabs simultaneously. To close a copy of the ERD tool, click the ``X`` in the upper-right hand corner of the tab bar. +You can open multiple copies of the ERD tool in individual tabs simultaneously. To close a copy of the ERD tool, click the `X` in the upper-right hand corner of the tab bar. ## Toolbar @@ -23,50 +23,50 @@ The **ERD Tool** toolbar uses context-sensitive icons that provide shortcuts to ## File Options -| Icon | Behavior | Shortcut | -|----------------------|-------------------------------------------------------------------------------------------------------------------|------------------| -| `Open File` | Click the `Open File` icon to load a previously saved diagram. | Ctrl + O | -| `Save` | Click the `Save` icon to perform a quick-save of a previously saved diagram, or to save the diagram to a file. | Ctrl + S | -| `Save as` | Click the `Save As` to open a new browser dialog and specify a new location to save the diagram. | Ctrl + Shift + S | +| Icon | Behavior | Shortcut | +| ----------- | -------------------------------------------------------------------------------------------------------------- | ---------------- | +| `Open File` | Click the `Open File` icon to load a previously saved diagram. | Ctrl + O | +| `Save` | Click the `Save` icon to perform a quick-save of a previously saved diagram, or to save the diagram to a file. | Ctrl + S | +| `Save as` | Click the `Save As` to open a new browser dialog and specify a new location to save the diagram. | Ctrl + Shift + S | ## Export Options -| Icon | Behavior | Shortcut | -|------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-------------------| -| `Generate SQL` | Click the `Generate SQL` icon to generate the DDL SQL for the diagram and open a query tool with the generated SQL ready for execution. | Option + Ctrl + S | -| `Download image` | Click the `Download image` icon to save the ERD diagram in a image format. | Option + Ctrl + I | +| Icon | Behavior | Shortcut | +| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| `Generate SQL` | Click the `Generate SQL` icon to generate the DDL SQL for the diagram and open a query tool with the generated SQL ready for execution. | Option + Ctrl + S | +| `Download image` | Click the `Download image` icon to save the ERD diagram in a image format. | Option + Ctrl + I | ## Editing Options -| Icon | Behavior | Shortcut | -|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| -| `Add table` | Click this button to add a new table to the diagram. On clicking, this will open a table dialog where you can put the table details. | Option/Alt + Ctrl + A | -| `Edit table` | Click this button to edit a table on the diagram. On clicking, this will open a table dialog where you can change table details. This will enable when a table is selected. | Option/Alt + Ctrl + E | -| `Clone table` | Click this button to clone the complete table structure, name it with a auto generated name and put it in the diagram. | Option/Alt + Ctrl + C | -| `Drop table/link` | You can drop a table or link using this button. You need to select a table or link and click on this button to drop it. | Option/Alt + Ctrl + D | +| Icon | Behavior | Shortcut | +| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | +| `Add table` | Click this button to add a new table to the diagram. On clicking, this will open a table dialog where you can put the table details. | Option/Alt + Ctrl + A | +| `Edit table` | Click this button to edit a table on the diagram. On clicking, this will open a table dialog where you can change table details. This will enable when a table is selected. | Option/Alt + Ctrl + E | +| `Clone table` | Click this button to clone the complete table structure, name it with a auto generated name and put it in the diagram. | Option/Alt + Ctrl + C | +| `Drop table/link` | You can drop a table or link using this button. You need to select a table or link and click on this button to drop it. | Option/Alt + Ctrl + D | ## Table Relationship Options -| Icon | Behavior | Shortcut | -|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| -| `1M` | Click this button to open a one-to-many relationship dialog to add a relationship between the two tables. The selected table becomes the referencing table and will have the `many` endpoint of the link. | Option/Alt + Ctrl + O | -| `MM` | Click this button to open a many-to-many relationship dialog to add a relationship between the two tables. This option will create a new table based on the selected columns for the two relating tables and link them. | Option/Alt + Ctrl + M | +| Icon | Behavior | Shortcut | +| ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | +| `1M` | Click this button to open a one-to-many relationship dialog to add a relationship between the two tables. The selected table becomes the referencing table and will have the `many` endpoint of the link. | Option/Alt + Ctrl + O | +| `MM` | Click this button to open a many-to-many relationship dialog to add a relationship between the two tables. This option will create a new table based on the selected columns for the two relating tables and link them. | Option/Alt + Ctrl + M | ## Utility Options -| Icon | Behavior | Shortcut | -|--------------------|------------------------------------------------------------------------------------------------------------------|------------------------| -| `Add/Edit note` | Click this button to make notes on tables nodes while designing the database. | Option/Alt + Ctrl + N | -| `Auto align` | Click this button to auto align all tables and links to make it look more cleaner. | Option/Alt + Ctrl + L | -| `Show details` | Click this button to toggle the column details visibility. It allows you to show few or more column details. | Option/Alt + Shift + D | +| Icon | Behavior | Shortcut | +| --------------- | ------------------------------------------------------------------------------------------------------------ | ---------------------- | +| `Add/Edit note` | Click this button to make notes on tables nodes while designing the database. | Option/Alt + Ctrl + N | +| `Auto align` | Click this button to auto align all tables and links to make it look more cleaner. | Option/Alt + Ctrl + L | +| `Show details` | Click this button to toggle the column details visibility. It allows you to show few or more column details. | Option/Alt + Shift + D | ## Zoom Options -| Icon | Behavior | Shortcut | -|--------------------|---------------------------------------------------------------------------------------------------|---------------------------| -| `Zoom to fit` | Click this button to zoom in/out automatically and fit all the tables to the view. | Option/Alt + Shift + F | -| `Zoom in` | Click this button to zoom in the diagram. | Option/Alt + Shift + "+" | -| `Zoom out` | Click this button to zoom out the diagram. | Option/Alt + Shift + "-" | +| Icon | Behavior | Shortcut | +| ------------- | ---------------------------------------------------------------------------------- | ------------------------ | +| `Zoom to fit` | Click this button to zoom in/out automatically and fit all the tables to the view. | Option/Alt + Shift + F | +| `Zoom in` | Click this button to zoom in the diagram. | Option/Alt + Shift + "+" | +| `Zoom out` | Click this button to zoom out the diagram. | Option/Alt + Shift + "-" | ## Table Dialog @@ -133,4 +133,4 @@ The table link shows relationship between tables: - You can use the notes popup to mark some notes while designing the database. - You open the pop-up using the toolbar note button. -- If some note is added to a table then it will have notes button on the table node. You can click on the button to check/update notes. \ No newline at end of file +- If some note is added to a table then it will have notes button on the table node. You can click on the button to check/update notes. diff --git a/product_docs/docs/pem/8.1.0/pem_ent_feat/05_performance_monitoring_and_management.mdx b/product_docs/docs/pem/8.1.0/pem_ent_feat/05_performance_monitoring_and_management.mdx index e667797295f..488cd235e09 100644 --- a/product_docs/docs/pem/8.1.0/pem_ent_feat/05_performance_monitoring_and_management.mdx +++ b/product_docs/docs/pem/8.1.0/pem_ent_feat/05_performance_monitoring_and_management.mdx @@ -407,34 +407,30 @@ Unless otherwise noted, Postgres Enterprise Manager enables the probes listed in - ### BDR Probes To monitor the BDR Group via BDR dashboards, the following probes must be enabled. All these probes are configured at server level. The user with `bdr_superuser` will be able to view information from all the following probes. -All the following probes works with ``BDR Enterprise Edition``. - -| Probe Name | Information Monitored by Probe | `bdr_monitor` role required? | Works with BDR SE? | -|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|--------------------| -| BDR Conflict History Summary | This probe returns information about row conflicts per conflict type. The stored information inlcudes:
The local time of the conflict
The type of the conflict | Yes | Yes | -| BDR Global Locks | This probe returns information about global locks in a BDR Group. The stored information includes:
The name of the node where the global lock has originated
The PID of the process holding the lock
The type of lock (DDL or DML)
The name of the locked relation(for DML Locks) or Keys(for advisory locks)
The internal state of the lock acquistion process
The list of backends waiting for the same global lock
The time when the global lock acquire was initiated by origin node
The time when the local node started trying to acquire the local lock
The time acquire_stage last changed | Yes | Yes | -| BDR Group Camo Details | This probe returns information about Camo's in BDR Group. The stored information includes:
The name of the node
The node name for whom this node is partner
The node name for whom this node is origin
The connection status
The readiness status
The number of pending or unresolved camo transactions
The lsn of last applied wal log
The lsn of last received wal log | No | No | -| BDR Group Replication Slot Details | This probe returns information about replication slots in BDR Group. The stored information includes:
The name of the BDR Group
The name of the origin node
The name of the target node
The slot name on the origin node used by this subscription
The active status
The state of the replication (catchup,streaming,disconnected,..)
The approximate lag time for reported write
The approximate lag time for reported flush
The approximate lag time for reported replay
The bytes difference between sent_lsn and current WAL write position
The bytes difference between write_lsn and current WAL write position
The bytes difference between flush_lsn and current WAL write position
| No | Yes | -| BDR Group Subscription Summary | This probe returns information about the summary of Subscriptions in the BDR Group. The stored information includes:
The name of the origin of the subscription
The name of the target of the subscription
The timestamp of the last replayed transaction
The lag between now and time of last replayed transaction
| No | Yes | -| BDR Monitor Group Raft | This probe returns the status and message of a cluster-wide raft check. | Yes | Yes | -| BDR Group Raft Details | This probe returns the information about raft consensus status from all the nodes in BDR Group. The stored information includes:
The name of the node
The raft worker state on the node
The node id of the RAFT_LEADER
The raft election internal id
The raft snapshot internal id | Yes | Yes | -| BDR Monitor Group Versions | This prove returns the status and message of cluster-wide version check. | Yes | Yes | -| BDR Group Versions Details | This probe returns the information about version details of the installed postgres, pglogical, bdr, and bdr edition for each node in the BDR Group. The stored information includes:
The name of the node
The installed postgres version on the node
The installed pglogical version on the node
The version of the BDR on the node
The BDR edition (Standard/Enterprise) | No | Yes | -| BDR Node Replication Rates | This probe returns information about outgoing replication activity from a given node. The stored information includes:
The name of the target peer node
The latest sent position
The latest position reported as replayed
The approximate lag time for reported replay
The bytes difference between replay_lsn and current WAL write position on origin
The human readable bytes difference between replay_lsn and current WAL write position
Approximate time required for the peer node to catchup to all the changes that are yet to be applied | Yes | No | -| BDR Node Slots | This probe returns information about the mapping of local BDR nodes to replication slots, their status, and replication progress. The stored information includes:
The name of the slot
The name of the target node
The name of the BDR Group
The database name on the target node
The PID of the process attached to the slot
The catalog XID needed by the slot
The IP address of the client connection
The latest sent position
The latest position reported as replayed
The approximate lag time for reported replay
The Bytes difference between replay_lsn and current WAL write position
The Human-readable bytes difference between replay_lsn and current WAL write position | Yes | Yes | -| BDR Node Summary | This probe returns information about all the nodes in the BDR Group. The stored information includes:
The name of the Node
The name of the BDR group the node is part of
The consistent state of the node in human readable form
The state which the node is trying to reach (during join or promotion)
The name of subscribed repsets | Yes | Yes | -| BDR Workers | This probe returns information about workers in BDR node. The stored information includes:
The PID of the worker process
The worker query start timestamp
The worker state change timestamp
The worker wait event type
The worker wait event
The worker state
The worker role name
The worker commit timestamp
The worker local timestamp
The name of the origin node
The receive LSN
The receive commit LSN
The last exact replay LSN
The last exact flush LSN
The last exact replay timestamp
The worker query | Yes | Yes | -| BDR Work Errors | This probe returns information aboutthe work errors in BDR node. The stored information includes:
The process id of the worker causing the error
The name of the BDR Group the node is part of
The name of the origin node
The name of the source node

The name of the target node
The name of the subscription
The internal identifier of the role of this worker
The name of the role of this worker
The date and time of the error
The age of the error
The description of the error
he context in which the error happened
The remote relation id
The subscription writer id
The subscription writer name | Yes | Yes | - - - +All the following probes works with `BDR Enterprise Edition`. + +| Probe Name | Information Monitored by Probe | `bdr_monitor` role required? | Works with BDR SE? | +| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ------------------ | +| BDR Conflict History Summary | This probe returns information about row conflicts per conflict type. The stored information inlcudes:
The local time of the conflict
The type of the conflict | Yes | Yes | +| BDR Global Locks | This probe returns information about global locks in a BDR Group. The stored information includes:
The name of the node where the global lock has originated
The PID of the process holding the lock
The type of lock (DDL or DML)
The name of the locked relation(for DML Locks) or Keys(for advisory locks)
The internal state of the lock acquistion process
The list of backends waiting for the same global lock
The time when the global lock acquire was initiated by origin node
The time when the local node started trying to acquire the local lock
The time acquire_stage last changed | Yes | Yes | +| BDR Group Camo Details | This probe returns information about Camo's in BDR Group. The stored information includes:
The name of the node
The node name for whom this node is partner
The node name for whom this node is origin
The connection status
The readiness status
The number of pending or unresolved camo transactions
The lsn of last applied wal log
The lsn of last received wal log | No | No | +| BDR Group Replication Slot Details | This probe returns information about replication slots in BDR Group. The stored information includes:
The name of the BDR Group
The name of the origin node
The name of the target node
The slot name on the origin node used by this subscription
The active status
The state of the replication (catchup,streaming,disconnected,..)
The approximate lag time for reported write
The approximate lag time for reported flush
The approximate lag time for reported replay
The bytes difference between sent_lsn and current WAL write position
The bytes difference between write_lsn and current WAL write position
The bytes difference between flush_lsn and current WAL write position
| No | Yes | +| BDR Group Subscription Summary | This probe returns information about the summary of Subscriptions in the BDR Group. The stored information includes:
The name of the origin of the subscription
The name of the target of the subscription
The timestamp of the last replayed transaction
The lag between now and time of last replayed transaction
| No | Yes | +| BDR Monitor Group Raft | This probe returns the status and message of a cluster-wide raft check. | Yes | Yes | +| BDR Group Raft Details | This probe returns the information about raft consensus status from all the nodes in BDR Group. The stored information includes:
The name of the node
The raft worker state on the node
The node id of the RAFT_LEADER
The raft election internal id
The raft snapshot internal id | Yes | Yes | +| BDR Monitor Group Versions | This prove returns the status and message of cluster-wide version check. | Yes | Yes | +| BDR Group Versions Details | This probe returns the information about version details of the installed postgres, pglogical, bdr, and bdr edition for each node in the BDR Group. The stored information includes:
The name of the node
The installed postgres version on the node
The installed pglogical version on the node
The version of the BDR on the node
The BDR edition (Standard/Enterprise) | No | Yes | +| BDR Node Replication Rates | This probe returns information about outgoing replication activity from a given node. The stored information includes:
The name of the target peer node
The latest sent position
The latest position reported as replayed
The approximate lag time for reported replay
The bytes difference between replay_lsn and current WAL write position on origin
The human readable bytes difference between replay_lsn and current WAL write position
Approximate time required for the peer node to catchup to all the changes that are yet to be applied | Yes | No | +| BDR Node Slots | This probe returns information about the mapping of local BDR nodes to replication slots, their status, and replication progress. The stored information includes:
The name of the slot
The name of the target node
The name of the BDR Group
The database name on the target node
The PID of the process attached to the slot
The catalog XID needed by the slot
The IP address of the client connection
The latest sent position
The latest position reported as replayed
The approximate lag time for reported replay
The Bytes difference between replay_lsn and current WAL write position
The Human-readable bytes difference between replay_lsn and current WAL write position | Yes | Yes | +| BDR Node Summary | This probe returns information about all the nodes in the BDR Group. The stored information includes:
The name of the Node
The name of the BDR group the node is part of
The consistent state of the node in human readable form
The state which the node is trying to reach (during join or promotion)
The name of subscribed repsets | Yes | Yes | +| BDR Workers | This probe returns information about workers in BDR node. The stored information includes:
The PID of the worker process
The worker query start timestamp
The worker state change timestamp
The worker wait event type
The worker wait event
The worker state
The worker role name
The worker commit timestamp
The worker local timestamp
The name of the origin node
The receive LSN
The receive commit LSN
The last exact replay LSN
The last exact flush LSN
The last exact replay timestamp
The worker query | Yes | Yes | +| BDR Work Errors | This probe returns information aboutthe work errors in BDR node. The stored information includes:
The process id of the worker causing the error
The name of the BDR Group the node is part of
The name of the origin node
The name of the source node

The name of the target node
The name of the subscription
The internal identifier of the role of this worker
The name of the role of this worker
The date and time of the error
The age of the error
The description of the error
he context in which the error happened
The remote relation id
The subscription writer id
The subscription writer name | Yes | Yes | ### Customizing Probes diff --git a/product_docs/docs/pem/8.1.0/pem_ent_feat/16_reference.mdx b/product_docs/docs/pem/8.1.0/pem_ent_feat/16_reference.mdx index 7e34ee950f1..9e519cfc5d3 100644 --- a/product_docs/docs/pem/8.1.0/pem_ent_feat/16_reference.mdx +++ b/product_docs/docs/pem/8.1.0/pem_ent_feat/16_reference.mdx @@ -8,142 +8,142 @@ The following sections are provided for reference; please note that the items re You can use global configuration options to modify aspects of the PEM Server's behavior. Please note that the list of configuration parameters is subject to change. -| **Parameter name** | **Value and Unit** | **Description** | -| ------------------------------------------------------------------------ | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| audit_log_retention_time | 30 days | Specifies the number of days that an audit log will be retained on the PEM server. | -| auto_create_agent_alerts | true | Specifies whether to create default agent level alerts automatically when an agent is registered. | -| auto_create_server_alerts | true | Specifies whether to create default server level alerts automatically when a server is bound to an agent. | -| chart_disable_bullets | false | Enable/disable bullets on line charts on dashboards and Capacity Manager reports. | -| cm_data_points_per_report | 50 | Specifies the number of data points to plot on charts on Capacity Manager reports. | -| cm_max_end_date_in_years | 5 years | Specifies the maximum amount of time that the Capacity Manager will extrapolate data for. Ensures that threshold-based end dates of on reports do not get extrapolated indefinitely. | -| dash_alerts_timeout | 60 seconds | Specifies the number of seconds after which the components of the Alerts dashboard are auto-refreshed. | -| dash_db_comrol_span | 7 days | Specifies the number of days worth of data to plot on the Commit/Rollback Analysis chart on the Database Analysis dashboard and Server Analysis dashboard. | -| dash_db_comrol_timeout | 1800 seconds | Specifies the number of seconds after which the Commits/Rollbacks line chart is auto-refreshed on the Database Analysis dashboard and Server Analysis dashboard. | -| dash_db_connovervw_timeout | 300 seconds | Specifies the number of seconds after which the Connection Overview pie chart is auto-refreshed in the Database Analysis dashboard. | -| dash_db_eventlag_span | 7 days | Specifies the number of days worth of data to plot on the Number of Events Lag chart for slony replication on the Database Analysis dashboard. | -| dash_db_eventlag_timeout | 1800 seconds | Specifies the number of seconds after which the Number of Events Lag line chart for slony replication is auto-refreshed on the Database Analysis dashboard. | -| dash_db_hottable_rows | 25 rows | Specifies the number of rows to show on the HOT Table Analysis table on the Database Analysis dashboard. | -| dash_db_hottable_timeout | 300 seconds | Specifies the number of seconds after which the Hot Tables table is auto-refreshed in the Database Analysis dashboard. | -| dash_db_io_span | 7 days | Specifies the number of days worth of data to plot on the Database I/O Analysis chart on the Database Analysis dashboard and I/O Analysis dashboard. | -| dash_db_io_timeout | 1800 seconds | Specifies the number of seconds after which the Database I/O line chart is auto-refreshed on the Database Analysis dashboard and I/O Analysis dashboard. | -| dash_db_rowact_span | 7 days | Specifies the number of days worth of data to plot on the Row Activity Analysis chart on the Database Analysis dashboard, the I/O Analysis dashboard, and the Server Analysis dashboard. | -| dash_db_rowact_timeout | 1800 seconds | Specifies the number of seconds after which the Row Activity line chart is auto-refreshed on the Database Analysis dashboard, the I/O Analysis dashboard, and the Server Analysis dashboard. | -| dash_db_storage_timeout | 300 seconds | Specifies the number of seconds after which the Storage bar chart is auto-refreshed in the Database Analysis dashboard. | -| dash_db_timelag_span | 7 days | Specifies the number of days worth of data to plot on the Time Lag chart for Slony replication on the Database Analysis dashboard. | -| dash_db_timelag_timeout | 1800 seconds | Specifies the number of seconds after which the Time Lag line chart for Slony replication is auto-refreshed on the Database Analysis dashboard. | -| dash_db_useract_span | 7 days | Specifies the number of days worth of data to plot on the User Activity Analysis chart on the Database Analysis dashboard. | -| dash_db_useract_timeout | 1800 seconds | Specifies the number of seconds after which the User Activity line chart is auto-refreshed in the Database Analysis dashboard. | -| dash_efm_timeout | 300 seconds | Specifies the number of seconds after which the Failover Manager Node Status and Failover Manager Cluster Info line chart is auto-refreshed on the Streaming Replication dashboard. | -| dash_global_overview_timeout | 30 seconds | Specifies the number of seconds after which the components of the Global Overview dashboard are auto-refreshed. | -| dash_header_timeout | 60 seconds | Specifies the number of seconds after which the information on the header of all the dashboards are auto-refreshed. | -| dash_io_chkpt_span | 7 days | Specifies the number of days worth of data to plot on the Checkpoints chart on the I/O Analysis dashboard. | -| dash_io_chkpt_timeout | 1800 seconds | Specifies the number of seconds after which the Checkpoints line chart is auto-refreshed on the I/O Analysis dashboard. | -| dash_io_hotindx_timeout | 300 seconds | Specifies the number of seconds after which the Hot Indexes bar chart is auto-refreshed on the I/O Analysis dashboard. | -| dash_io_hottbl_timeout | 300 seconds | Specifies the number of seconds after which the Hot Tables bar chart is auto-refreshed on the I/O Analysis dashboard. | -| dash_io_index_objectio_rows | 25 rows | Specifies the number of rows displayed on the Index Activity table on the I/O Analysis dashboard and the Object Activity Analysis dashboard. | -| dash_io_index_objectio_timeout | 60 seconds | Specifies the number of seconds after which the Index Activity table is auto-refreshed on the I/O Analysis dashboard and the Object Activity Analysis dashboard. | -| dash_io_objectio_rows | 25 rows | Specifies the number of rows displayed in the Object I/O Details table on the I/O Analysis dashboard and Object Activity Analysis dashboard. | -| dash_io_objectio_timeout | 300 seconds | Specifies the number of seconds after which the Object I/O Details table is auto-refreshed on the I/O Analysis dashboard and Object Activity Analysis dashboard. | -| dash_memory_hostmemact_span | 7 days | Specifies the number of days worth of data to plot on the Host Memory Activity Analysis chart on the Memory Analysis dashboard. | -| dash_memory_hostmemact_timeout | 1800 seconds | Specifies the number of seconds after which the Host Memory Activity line chart is auto-refreshed on the Memory Analysis dashboard. | -| dash_memory_hostmemconf_timeout | 300 seconds | Specifies the number of seconds after which the Host Memory Configuration pie chart is auto-refreshed on the Memory Analysis dashboard and Server Analysis dashboard. | -| dash_memory_servmemact_span | 7 days | Specifies the number of days worth of data to plot on the server Memory Activity Analysis chart on the Memory Analysis dashboard. | -| dash_memory_servmemact_timeout | 1800 seconds | Specifies the number of seconds after which the Server Memory Activity line chart is auto-refreshed on the Memory Analysis dashboard. | -| dash_memory_servmemconf_timeout | 300 seconds | Specifies the number of seconds after which the Server Memory Configuration pie chart is auto-refreshed on the Memory Analysis dashboard. | -| dash_objectact_objstorage_rows | 15 rows | Specifies the number of rows to show on the Object Storage table on the Object Activity Analysis dashboard. | -| dash_objectact_objstorage_timeout | 300 seconds | Specifies the number of seconds after which the Object Storage table is auto-refreshed in the Object Activity Analysis dashboard. | -| dash_objectact_objtopindexes_timeout | 300 seconds | Specifies the number of seconds after which the Top 5 Largest Indexes bar chart is auto-refreshed in the Object Activity Analysis dashboard. | -| dash_objectact_objtoptables_timeout | 300 seconds | Specifies the number of seconds after which the Top 5 Largest Tables bar chart is auto-refreshed in the Object Activity Analysis dashboard. | -| dash_os_cpu_span | 7 days | Specifies the number of days worth of data to plot on the CPU chart on the Operating System Analysis dashboard. | -| dash_os_cpu_timeout | 1800 seconds | Specifies the number of seconds after which the CPU line chart is auto-refreshed on the Operating System Analysis dashboard. | -| dash_os_data_span | 7 days | Specifies the number of days worth of data to plot on the I/O line chart on the Operating System Analysis dashboard. | -| dash_os_disk_span | 7 days | Specifies the number of days worth of data to plot on the Utilisation chart on the Operating System Analysis dashboard. | -| dash_os_hostfs_timeout | 1800 seconds | Specifies the number of seconds after which the Host File System Details table is auto-refreshed on the Operating System Analysis dashboard. | -| dash_os_io_timeout | 1800 seconds | Specifies the number of seconds after which the I/O line chart is auto-refreshed on the Operating System Analysis dashboard. | -| dash_os_memory_span | 7 days | Specifies the number of days worth of data to plot on the Memory chart on the Operating System Analysis dashboard. | -| dash_os_memory_timeout | 1800 seconds | Specifies the number of seconds after which the Memory line chart is auto-refreshed on the Operating System Analysis dashboard. | -| dash_os_packet_span | 7 days | Specifies the number of days worth of data to plot on the Packet chart on the Operating System Analysis dashboard. | -| dash_os_packet_timeout | 1800 seconds | Specifies the number of seconds after which the Network Packets line chart is auto-refreshed on the Operating System Analysis dashboard. | -| dash_os_process_span | 7 days | Specifies the number of days worth of data to plot on the Process chart on the Operating System Analysis dashboard. | -| dash_os_process_timeout | 1800 seconds | Specifies the number of seconds after which the Process line chart is auto-refreshed on the Operating System Analysis dashboard. | -| dash_os_storage_timeout | 1800 seconds | Specifies the number of seconds after which the Storage pie chart is auto-refreshed on the Operating System Analysis dashboard. | -| dash_os_traffic_span | 7 days | Specifies the number of days worth of data to plot on the Traffic chart on the Operating System Analysis dashboard. | -| dash_os_traffic_timeout | 1800 seconds | Specifies the number of seconds after which the Traffic line chart is auto-refreshed on the Operating System Analysis dashboard. | -| dash_os_util_timeout | 1800 seconds | Specifies the number of seconds after which the Utilisation line chart is auto-refreshed on the Operating System Analysis dashboard. | -| dash_probe_log_timeout | 300 seconds | Specifies the number of seconds after which the Probe Log table is auto-refreshed on | -| dash_replication_archivestat_span | 7 days | Specifies the number of days worth of data to plot on the WAL Archive Status chart on the Streaming Replication Analysis dashboard. | -| dash_replication_archivestat_timeout | 1800 seconds | Specifies the number of seconds after which the WAL Archive Status line chart is auto-refreshed on the Streaming Replication dashboard. | -| dash_replication_pagelag_span | 7 days | Specifies the number of days worth of data to plot on the WAL Lag Pages chart on the Streaming Replication dashboard. | -| dash_replication_pagelag_timeout | 1800 seconds | Specifies the number of seconds after which the WAL Lag Pages line chart is auto-refreshed on the Streaming Replication dashboard. | -| dash_replication_segmentlag_span | 7 days | Specifies the number of days worth of data to plot on the WAL Lag Segments chart on the Streaming Replication dashboard. | -| dash_replication_segmentlag_timeout | 1800 seconds | Specifies the number of seconds after which the WAL Lag Segments line chart is auto-refreshed on the Streaming Replication dashboard. | -| dash_replication_timelag_span | 7 days | Specifies the number of days worth of data to plot on the Replication Lag Time chart on the Streaming Replication dashboard. | -| dash_replication_timelag_timeout | 1800 seconds | Specifies the number of seconds after which the Replication Lag Time line chart is auto-refreshed on the Streaming Replication dashboard. | -| dash_server_buffers_written | 168 hours | Specifies the number of days worth of data to plot on the Background Writer Statistics chart on the Server Analysis dashboard. | -| dash_server_buffers_written_timeout | 300 seconds | Specifies the number of seconds after which the Background Writer Statistics line chart is auto-refreshed on the Server Analysis dashboard. | -| dash_server_connovervw_timeout | 300 seconds | Specifies the number of seconds after which the Connection Overview pie chart is auto-refreshed in the Server Analysis dashboard. | -| dash_server_database_timeout | 300 seconds | Specifies the number of seconds after which the Databases table is auto-refreshed in the Server Analysis dashboard. | -| dash_server_dbsize_span | 7 days | Specifies the number of days worth of data to plot on the Database Size Analysis on the Server Analysis dashboard. | -| dash_server_dbsize_timeout | 1800 seconds | Specifies the number of seconds after which the Database Size line chart is auto-refreshed in the Server Analysis dashboard. | -| dash_server_disk_timeout | 1800 seconds | Specifies the number of seconds after which the Disk line chart is auto-refreshed in the Server Analysis dashboard. | -| dash_server_global_span | 7 days | Specifies the number of days worth of data to plot on the Disk line chart on the Server Analysis dashboard. | -| dash_server_sharedbuff_span | 7 days | Specifies the number of days worth of data to plot on the Shared Buffer chart on the Server Analysis dashboard. | -| dash_server_sharedbuff_timeout | 1800 seconds | Specifies the number of seconds after which the Shared Buffers line chart is auto-refreshed in the Server Analysis dashboard. | -| dash_server_tabspacesize_span | 7 days | Specifies the number of days worth of data to plot on the Tablespace Size chart on the Server Analysis dashboard. | -| dash_server_tabspacesize_timeout | 1800 seconds | Specifies the number of seconds after which the Tablespace Size line chart is auto-refreshed in the Server Analysis dashboard. | -| dash_server_useract_span | 7 days | Specifies the number of days worth of data to plot on the User Activity chart on the Server Analysis dashboard. | -| dash_server_useract_timeout | 1800 seconds | Specifies the number of seconds after which the User Activity line chart is auto-refreshed in the Server Analysis dashboard. | -| dash_sessact_lockact_timeout | 300 seconds | Specifies the number of seconds after which the Session Lock Activity table is auto-refreshed in the Session Activity Analysis dashboard. | -| dash_sessact_workload_timeout | 300 seconds | Specifies the number of seconds after which the Session Workload table is auto-refreshed in the Session Activity Analysis dashboard. | -| dash_sess_waits_nowaits_timeout | 300 seconds | Specifies the number of seconds after which the Session Waits By Number Of Waits pie | -| dash_sess_waits_timewait_timeout | 300 seconds | Specifies the number of seconds after which the Session Waits By Time Waited pie chart is auto-refreshed in the Session Waits Analysis dashboard. | -| dash_sess_waits_waitdtl_timeout | 300 seconds | Specifies the number of seconds after which the Session Waits Details table is auto-refreshed in the Session Waits Analysis dashboard. | -| dash_storage_dbdtls_timeout | 300 seconds | Specifies the number of seconds after which the Database Details table is auto-refreshed in the Storage Analysis dashboard. | -| dash_storage_dbovervw_timeout | 300 seconds | Specifies the number of seconds after which the Database Overview pie chart is auto-refreshed in the Storage Analysis dashboard. | -| dash_storage_hostdtls_timeout | 300 seconds | Specifies the number of seconds after which the Host Details table is auto-refreshed | -| dash_storage_hostovervw_timeout | 300 seconds | Specifies the number of seconds after which the Host Overview pie chart is auto-refreshed in the Storage Analysis dashboard. | -| dash_storage_tblspcdtls_timeout | 300 seconds | Specifies the number of seconds after which the Tablespace Details table is auto-refreshed in the Storage Analysis dashboard. | -| dash_storage_tblspcovervw_timeout | 300 seconds | Specifies the number of seconds after which the Tablespace Overview pie chart is auto-refreshed in the Storage Analysis dashboard. | -| dash_sys_waits_nowaits_timeout | 300 seconds | Specifies the number of seconds after which the System Waits By Number Of Waits pie chart is auto-refreshed in the System Waits Analysis dashboard. | -| dash_sys_waits_timewait_timeout | 300 seconds | Specifies the number of seconds after which the System Waits By Time Waited pie chart is auto-refreshed in the System Waits Analysis dashboard. | -| dash_sys_waits_waitdtl_timeout | 300 seconds | Specifies the number of seconds after which the System Waits Details table is auto-refreshed in the System Waits Analysis dashboard. | -| deleted_charts_retention_time | 7 days | Specifies the number of days that a custom chart (displayed on a user-defined dashboard) is stored. | -| deleted_probes_retention_time | 7 days | Specifies the number of days that a custom probe (displayed on a user-defined dashboard) is stored. | -| download_chart_format | jpeg | Specifies the format in which a downloaded chart will be stored. May be jpeg or png. | -| flapping_detection_state_change | 3 | Specifies the number of state changes detected within a specified interval to define a given alert as flapping. Flapping starts when more than `N` state changes have occurred over \[ `N` + 1 \* (min(probe_interval) \* 2)] minutes and the fine state is not None. Where the default value of `N` is 2 or 3, and min(probe_interval) is the smallest interval for all the probes used by the alert. Flapping ends when ZERO state changes have occurred over \[2 `N` \* min(probe_interval)] minutes. | -| job_retention_time | 30 days | Specifies the number of days that non-recurring scheduled tasks and their associated | -| long_running_transaction_minutes | 5 minutes | Specifies the number of minutes a query executes for before being considered long running. | -| nagios_cmd_file_name | <file_name> | Specifies nagios command file to which passive service check result will be sent. | -| nagios_enabled | t | Specifies whether alert notification will be submitted to nagios or not. | -| nagios_medium_alert_as_critical | f | Specifies whether medium level PEM alert will be considered as critical in nagios. | -| nagios_spool_retention_time | 7 days | Specifies the number of days to retain nagios messages in the spool table before they are discarded. | -| probe_log_retention_time | 30 days | Specifies the number of days that probe log records are retained. | -| reminder_notification_interval | 24 hours | Specifies the number of hours after which a reminder email is sent in case an alert has not been cleared. | -| server_log_retention_time | 30 days | Specifies the number of days that the server log is retained on the PEM server. | -| show_data_tab_on_graph | false | If 'true', a Data tab is added to each graph. Select the Data tab to review the data that is plotted on the graph. | -| smtp_authentication | false | Specifies whether to enable/disable authentication over SMTP. | -| smtp_enabled | true | Specifies whether to enable/disable sending of emails. | -| smtp_encryption | false | Specifies whether to send SMTP email using an encrypted connection. | -| smtp_password | | Specifies the password to be used to connect to the SMTP server. | -| smtp_port | 25 | Specifies the SMTP server port to be used for sending email. | -| smtp_server | 127.0.0.1 | Specifies the SMTP server host address to be used for sending email. | -| smtp_spool_retention_time | 7 days | Specifies the number of days to retain sent email messages in the spool table before they are discarded. | -| smtp_username | | Specifies the username to be used to connect to SMTP server. | -| snmp_community | public | Specifies the SNMP community used when sending traps. Used only with SNMPv1 and SNMPv2. | -| snmp_enabled | true | Specifies whether to enable/disable sending SNMP traps. | -| snmp_port | 162 | Specifies the SNMP server port to be used for sending SNMP traps. | -| snmp_server | 127.0.0.1 | Specifies the SNMP server host address to be used for sending SNMP traps. | -| snmp_spool_retention_time | 7 days | Specifies the number of days to retain sent traps in the spool table before they are discarded. | -| snmp_security_name | | Specifies the user name or security name for sending SNMP traps. Used only with SNMPv3. | -| snmp_security_engine_id | | Specifies the Engine id of the SNMP Agent on the SNMP Server. Used only with SNMPv3. | -| snmp_security_level | NOAUTH_NOPRIV | Specifies Security level and its possible values can be: AUTH_NOPRIV - Authentication, No Privacy or AUTH_PRIV - Authentication, Privacy or NOAUTH_NOPRIV - no Authentication, no Privacy. Used only with SNMPv3. | -| snmp_context_name | | Specifies the Context name, the identifier for MIB objects when sending SNMP traps. Used only with SNMPv3. | -| snmp_context_engine_id | | Specifies the Context engine id, the identifier for MIB objects when sending SNMP traps. If not specified, snmp_security_engine_id will be used. Used only with SNMPv3. | -| snmp_authentication_protocol | NONE | Specifies the authentication type for SNMP traps. Its possible values can be NONE,HMACMD5 or HMACSHA. Used only with SNMPv3. | -| snmp_privacy_protocol | NONE | Specifies the privacy protocol for SNMP traps. Its possible values can be NONE, DES, AES128, IDEA, AES192, or AES256. Used only with SNMPv3. | -| snmp_authentication_password | | Specifies the authentication password associated with security name mentioned in snmp_security_name. Used only for SNMPv3. | -| snmp_privacy_password | | Specifies the privacy password associated with security name mentioned in snmp_security_name. Used only for SNMPv3. | -| webclient_help_pg | EDB hosted documentation | Specifies the location of the online PostgreSQL core documentation. | +| **Parameter name** | **Value and Unit** | **Description** | +| ------------------------------------ | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| audit_log_retention_time | 30 days | Specifies the number of days that an audit log will be retained on the PEM server. | +| auto_create_agent_alerts | true | Specifies whether to create default agent level alerts automatically when an agent is registered. | +| auto_create_server_alerts | true | Specifies whether to create default server level alerts automatically when a server is bound to an agent. | +| chart_disable_bullets | false | Enable/disable bullets on line charts on dashboards and Capacity Manager reports. | +| cm_data_points_per_report | 50 | Specifies the number of data points to plot on charts on Capacity Manager reports. | +| cm_max_end_date_in_years | 5 years | Specifies the maximum amount of time that the Capacity Manager will extrapolate data for. Ensures that threshold-based end dates of on reports do not get extrapolated indefinitely. | +| dash_alerts_timeout | 60 seconds | Specifies the number of seconds after which the components of the Alerts dashboard are auto-refreshed. | +| dash_db_comrol_span | 7 days | Specifies the number of days worth of data to plot on the Commit/Rollback Analysis chart on the Database Analysis dashboard and Server Analysis dashboard. | +| dash_db_comrol_timeout | 1800 seconds | Specifies the number of seconds after which the Commits/Rollbacks line chart is auto-refreshed on the Database Analysis dashboard and Server Analysis dashboard. | +| dash_db_connovervw_timeout | 300 seconds | Specifies the number of seconds after which the Connection Overview pie chart is auto-refreshed in the Database Analysis dashboard. | +| dash_db_eventlag_span | 7 days | Specifies the number of days worth of data to plot on the Number of Events Lag chart for slony replication on the Database Analysis dashboard. | +| dash_db_eventlag_timeout | 1800 seconds | Specifies the number of seconds after which the Number of Events Lag line chart for slony replication is auto-refreshed on the Database Analysis dashboard. | +| dash_db_hottable_rows | 25 rows | Specifies the number of rows to show on the HOT Table Analysis table on the Database Analysis dashboard. | +| dash_db_hottable_timeout | 300 seconds | Specifies the number of seconds after which the Hot Tables table is auto-refreshed in the Database Analysis dashboard. | +| dash_db_io_span | 7 days | Specifies the number of days worth of data to plot on the Database I/O Analysis chart on the Database Analysis dashboard and I/O Analysis dashboard. | +| dash_db_io_timeout | 1800 seconds | Specifies the number of seconds after which the Database I/O line chart is auto-refreshed on the Database Analysis dashboard and I/O Analysis dashboard. | +| dash_db_rowact_span | 7 days | Specifies the number of days worth of data to plot on the Row Activity Analysis chart on the Database Analysis dashboard, the I/O Analysis dashboard, and the Server Analysis dashboard. | +| dash_db_rowact_timeout | 1800 seconds | Specifies the number of seconds after which the Row Activity line chart is auto-refreshed on the Database Analysis dashboard, the I/O Analysis dashboard, and the Server Analysis dashboard. | +| dash_db_storage_timeout | 300 seconds | Specifies the number of seconds after which the Storage bar chart is auto-refreshed in the Database Analysis dashboard. | +| dash_db_timelag_span | 7 days | Specifies the number of days worth of data to plot on the Time Lag chart for Slony replication on the Database Analysis dashboard. | +| dash_db_timelag_timeout | 1800 seconds | Specifies the number of seconds after which the Time Lag line chart for Slony replication is auto-refreshed on the Database Analysis dashboard. | +| dash_db_useract_span | 7 days | Specifies the number of days worth of data to plot on the User Activity Analysis chart on the Database Analysis dashboard. | +| dash_db_useract_timeout | 1800 seconds | Specifies the number of seconds after which the User Activity line chart is auto-refreshed in the Database Analysis dashboard. | +| dash_efm_timeout | 300 seconds | Specifies the number of seconds after which the Failover Manager Node Status and Failover Manager Cluster Info line chart is auto-refreshed on the Streaming Replication dashboard. | +| dash_global_overview_timeout | 30 seconds | Specifies the number of seconds after which the components of the Global Overview dashboard are auto-refreshed. | +| dash_header_timeout | 60 seconds | Specifies the number of seconds after which the information on the header of all the dashboards are auto-refreshed. | +| dash_io_chkpt_span | 7 days | Specifies the number of days worth of data to plot on the Checkpoints chart on the I/O Analysis dashboard. | +| dash_io_chkpt_timeout | 1800 seconds | Specifies the number of seconds after which the Checkpoints line chart is auto-refreshed on the I/O Analysis dashboard. | +| dash_io_hotindx_timeout | 300 seconds | Specifies the number of seconds after which the Hot Indexes bar chart is auto-refreshed on the I/O Analysis dashboard. | +| dash_io_hottbl_timeout | 300 seconds | Specifies the number of seconds after which the Hot Tables bar chart is auto-refreshed on the I/O Analysis dashboard. | +| dash_io_index_objectio_rows | 25 rows | Specifies the number of rows displayed on the Index Activity table on the I/O Analysis dashboard and the Object Activity Analysis dashboard. | +| dash_io_index_objectio_timeout | 60 seconds | Specifies the number of seconds after which the Index Activity table is auto-refreshed on the I/O Analysis dashboard and the Object Activity Analysis dashboard. | +| dash_io_objectio_rows | 25 rows | Specifies the number of rows displayed in the Object I/O Details table on the I/O Analysis dashboard and Object Activity Analysis dashboard. | +| dash_io_objectio_timeout | 300 seconds | Specifies the number of seconds after which the Object I/O Details table is auto-refreshed on the I/O Analysis dashboard and Object Activity Analysis dashboard. | +| dash_memory_hostmemact_span | 7 days | Specifies the number of days worth of data to plot on the Host Memory Activity Analysis chart on the Memory Analysis dashboard. | +| dash_memory_hostmemact_timeout | 1800 seconds | Specifies the number of seconds after which the Host Memory Activity line chart is auto-refreshed on the Memory Analysis dashboard. | +| dash_memory_hostmemconf_timeout | 300 seconds | Specifies the number of seconds after which the Host Memory Configuration pie chart is auto-refreshed on the Memory Analysis dashboard and Server Analysis dashboard. | +| dash_memory_servmemact_span | 7 days | Specifies the number of days worth of data to plot on the server Memory Activity Analysis chart on the Memory Analysis dashboard. | +| dash_memory_servmemact_timeout | 1800 seconds | Specifies the number of seconds after which the Server Memory Activity line chart is auto-refreshed on the Memory Analysis dashboard. | +| dash_memory_servmemconf_timeout | 300 seconds | Specifies the number of seconds after which the Server Memory Configuration pie chart is auto-refreshed on the Memory Analysis dashboard. | +| dash_objectact_objstorage_rows | 15 rows | Specifies the number of rows to show on the Object Storage table on the Object Activity Analysis dashboard. | +| dash_objectact_objstorage_timeout | 300 seconds | Specifies the number of seconds after which the Object Storage table is auto-refreshed in the Object Activity Analysis dashboard. | +| dash_objectact_objtopindexes_timeout | 300 seconds | Specifies the number of seconds after which the Top 5 Largest Indexes bar chart is auto-refreshed in the Object Activity Analysis dashboard. | +| dash_objectact_objtoptables_timeout | 300 seconds | Specifies the number of seconds after which the Top 5 Largest Tables bar chart is auto-refreshed in the Object Activity Analysis dashboard. | +| dash_os_cpu_span | 7 days | Specifies the number of days worth of data to plot on the CPU chart on the Operating System Analysis dashboard. | +| dash_os_cpu_timeout | 1800 seconds | Specifies the number of seconds after which the CPU line chart is auto-refreshed on the Operating System Analysis dashboard. | +| dash_os_data_span | 7 days | Specifies the number of days worth of data to plot on the I/O line chart on the Operating System Analysis dashboard. | +| dash_os_disk_span | 7 days | Specifies the number of days worth of data to plot on the Utilisation chart on the Operating System Analysis dashboard. | +| dash_os_hostfs_timeout | 1800 seconds | Specifies the number of seconds after which the Host File System Details table is auto-refreshed on the Operating System Analysis dashboard. | +| dash_os_io_timeout | 1800 seconds | Specifies the number of seconds after which the I/O line chart is auto-refreshed on the Operating System Analysis dashboard. | +| dash_os_memory_span | 7 days | Specifies the number of days worth of data to plot on the Memory chart on the Operating System Analysis dashboard. | +| dash_os_memory_timeout | 1800 seconds | Specifies the number of seconds after which the Memory line chart is auto-refreshed on the Operating System Analysis dashboard. | +| dash_os_packet_span | 7 days | Specifies the number of days worth of data to plot on the Packet chart on the Operating System Analysis dashboard. | +| dash_os_packet_timeout | 1800 seconds | Specifies the number of seconds after which the Network Packets line chart is auto-refreshed on the Operating System Analysis dashboard. | +| dash_os_process_span | 7 days | Specifies the number of days worth of data to plot on the Process chart on the Operating System Analysis dashboard. | +| dash_os_process_timeout | 1800 seconds | Specifies the number of seconds after which the Process line chart is auto-refreshed on the Operating System Analysis dashboard. | +| dash_os_storage_timeout | 1800 seconds | Specifies the number of seconds after which the Storage pie chart is auto-refreshed on the Operating System Analysis dashboard. | +| dash_os_traffic_span | 7 days | Specifies the number of days worth of data to plot on the Traffic chart on the Operating System Analysis dashboard. | +| dash_os_traffic_timeout | 1800 seconds | Specifies the number of seconds after which the Traffic line chart is auto-refreshed on the Operating System Analysis dashboard. | +| dash_os_util_timeout | 1800 seconds | Specifies the number of seconds after which the Utilisation line chart is auto-refreshed on the Operating System Analysis dashboard. | +| dash_probe_log_timeout | 300 seconds | Specifies the number of seconds after which the Probe Log table is auto-refreshed on | +| dash_replication_archivestat_span | 7 days | Specifies the number of days worth of data to plot on the WAL Archive Status chart on the Streaming Replication Analysis dashboard. | +| dash_replication_archivestat_timeout | 1800 seconds | Specifies the number of seconds after which the WAL Archive Status line chart is auto-refreshed on the Streaming Replication dashboard. | +| dash_replication_pagelag_span | 7 days | Specifies the number of days worth of data to plot on the WAL Lag Pages chart on the Streaming Replication dashboard. | +| dash_replication_pagelag_timeout | 1800 seconds | Specifies the number of seconds after which the WAL Lag Pages line chart is auto-refreshed on the Streaming Replication dashboard. | +| dash_replication_segmentlag_span | 7 days | Specifies the number of days worth of data to plot on the WAL Lag Segments chart on the Streaming Replication dashboard. | +| dash_replication_segmentlag_timeout | 1800 seconds | Specifies the number of seconds after which the WAL Lag Segments line chart is auto-refreshed on the Streaming Replication dashboard. | +| dash_replication_timelag_span | 7 days | Specifies the number of days worth of data to plot on the Replication Lag Time chart on the Streaming Replication dashboard. | +| dash_replication_timelag_timeout | 1800 seconds | Specifies the number of seconds after which the Replication Lag Time line chart is auto-refreshed on the Streaming Replication dashboard. | +| dash_server_buffers_written | 168 hours | Specifies the number of days worth of data to plot on the Background Writer Statistics chart on the Server Analysis dashboard. | +| dash_server_buffers_written_timeout | 300 seconds | Specifies the number of seconds after which the Background Writer Statistics line chart is auto-refreshed on the Server Analysis dashboard. | +| dash_server_connovervw_timeout | 300 seconds | Specifies the number of seconds after which the Connection Overview pie chart is auto-refreshed in the Server Analysis dashboard. | +| dash_server_database_timeout | 300 seconds | Specifies the number of seconds after which the Databases table is auto-refreshed in the Server Analysis dashboard. | +| dash_server_dbsize_span | 7 days | Specifies the number of days worth of data to plot on the Database Size Analysis on the Server Analysis dashboard. | +| dash_server_dbsize_timeout | 1800 seconds | Specifies the number of seconds after which the Database Size line chart is auto-refreshed in the Server Analysis dashboard. | +| dash_server_disk_timeout | 1800 seconds | Specifies the number of seconds after which the Disk line chart is auto-refreshed in the Server Analysis dashboard. | +| dash_server_global_span | 7 days | Specifies the number of days worth of data to plot on the Disk line chart on the Server Analysis dashboard. | +| dash_server_sharedbuff_span | 7 days | Specifies the number of days worth of data to plot on the Shared Buffer chart on the Server Analysis dashboard. | +| dash_server_sharedbuff_timeout | 1800 seconds | Specifies the number of seconds after which the Shared Buffers line chart is auto-refreshed in the Server Analysis dashboard. | +| dash_server_tabspacesize_span | 7 days | Specifies the number of days worth of data to plot on the Tablespace Size chart on the Server Analysis dashboard. | +| dash_server_tabspacesize_timeout | 1800 seconds | Specifies the number of seconds after which the Tablespace Size line chart is auto-refreshed in the Server Analysis dashboard. | +| dash_server_useract_span | 7 days | Specifies the number of days worth of data to plot on the User Activity chart on the Server Analysis dashboard. | +| dash_server_useract_timeout | 1800 seconds | Specifies the number of seconds after which the User Activity line chart is auto-refreshed in the Server Analysis dashboard. | +| dash_sessact_lockact_timeout | 300 seconds | Specifies the number of seconds after which the Session Lock Activity table is auto-refreshed in the Session Activity Analysis dashboard. | +| dash_sessact_workload_timeout | 300 seconds | Specifies the number of seconds after which the Session Workload table is auto-refreshed in the Session Activity Analysis dashboard. | +| dash_sess_waits_nowaits_timeout | 300 seconds | Specifies the number of seconds after which the Session Waits By Number Of Waits pie | +| dash_sess_waits_timewait_timeout | 300 seconds | Specifies the number of seconds after which the Session Waits By Time Waited pie chart is auto-refreshed in the Session Waits Analysis dashboard. | +| dash_sess_waits_waitdtl_timeout | 300 seconds | Specifies the number of seconds after which the Session Waits Details table is auto-refreshed in the Session Waits Analysis dashboard. | +| dash_storage_dbdtls_timeout | 300 seconds | Specifies the number of seconds after which the Database Details table is auto-refreshed in the Storage Analysis dashboard. | +| dash_storage_dbovervw_timeout | 300 seconds | Specifies the number of seconds after which the Database Overview pie chart is auto-refreshed in the Storage Analysis dashboard. | +| dash_storage_hostdtls_timeout | 300 seconds | Specifies the number of seconds after which the Host Details table is auto-refreshed | +| dash_storage_hostovervw_timeout | 300 seconds | Specifies the number of seconds after which the Host Overview pie chart is auto-refreshed in the Storage Analysis dashboard. | +| dash_storage_tblspcdtls_timeout | 300 seconds | Specifies the number of seconds after which the Tablespace Details table is auto-refreshed in the Storage Analysis dashboard. | +| dash_storage_tblspcovervw_timeout | 300 seconds | Specifies the number of seconds after which the Tablespace Overview pie chart is auto-refreshed in the Storage Analysis dashboard. | +| dash_sys_waits_nowaits_timeout | 300 seconds | Specifies the number of seconds after which the System Waits By Number Of Waits pie chart is auto-refreshed in the System Waits Analysis dashboard. | +| dash_sys_waits_timewait_timeout | 300 seconds | Specifies the number of seconds after which the System Waits By Time Waited pie chart is auto-refreshed in the System Waits Analysis dashboard. | +| dash_sys_waits_waitdtl_timeout | 300 seconds | Specifies the number of seconds after which the System Waits Details table is auto-refreshed in the System Waits Analysis dashboard. | +| deleted_charts_retention_time | 7 days | Specifies the number of days that a custom chart (displayed on a user-defined dashboard) is stored. | +| deleted_probes_retention_time | 7 days | Specifies the number of days that a custom probe (displayed on a user-defined dashboard) is stored. | +| download_chart_format | jpeg | Specifies the format in which a downloaded chart will be stored. May be jpeg or png. | +| flapping_detection_state_change | 3 | Specifies the number of state changes detected within a specified interval to define a given alert as flapping. Flapping starts when more than `N` state changes have occurred over \[ `N` + 1 \* (min(probe_interval) \* 2)] minutes and the fine state is not None. Where the default value of `N` is 2 or 3, and min(probe_interval) is the smallest interval for all the probes used by the alert. Flapping ends when ZERO state changes have occurred over \[2 `N` \* min(probe_interval)] minutes. | +| job_retention_time | 30 days | Specifies the number of days that non-recurring scheduled tasks and their associated | +| long_running_transaction_minutes | 5 minutes | Specifies the number of minutes a query executes for before being considered long running. | +| nagios_cmd_file_name | <file_name> | Specifies nagios command file to which passive service check result will be sent. | +| nagios_enabled | t | Specifies whether alert notification will be submitted to nagios or not. | +| nagios_medium_alert_as_critical | f | Specifies whether medium level PEM alert will be considered as critical in nagios. | +| nagios_spool_retention_time | 7 days | Specifies the number of days to retain nagios messages in the spool table before they are discarded. | +| probe_log_retention_time | 30 days | Specifies the number of days that probe log records are retained. | +| reminder_notification_interval | 24 hours | Specifies the number of hours after which a reminder email is sent in case an alert has not been cleared. | +| server_log_retention_time | 30 days | Specifies the number of days that the server log is retained on the PEM server. | +| show_data_tab_on_graph | false | If 'true', a Data tab is added to each graph. Select the Data tab to review the data that is plotted on the graph. | +| smtp_authentication | false | Specifies whether to enable/disable authentication over SMTP. | +| smtp_enabled | true | Specifies whether to enable/disable sending of emails. | +| smtp_encryption | false | Specifies whether to send SMTP email using an encrypted connection. | +| smtp_password | | Specifies the password to be used to connect to the SMTP server. | +| smtp_port | 25 | Specifies the SMTP server port to be used for sending email. | +| smtp_server | 127.0.0.1 | Specifies the SMTP server host address to be used for sending email. | +| smtp_spool_retention_time | 7 days | Specifies the number of days to retain sent email messages in the spool table before they are discarded. | +| smtp_username | | Specifies the username to be used to connect to SMTP server. | +| snmp_community | public | Specifies the SNMP community used when sending traps. Used only with SNMPv1 and SNMPv2. | +| snmp_enabled | true | Specifies whether to enable/disable sending SNMP traps. | +| snmp_port | 162 | Specifies the SNMP server port to be used for sending SNMP traps. | +| snmp_server | 127.0.0.1 | Specifies the SNMP server host address to be used for sending SNMP traps. | +| snmp_spool_retention_time | 7 days | Specifies the number of days to retain sent traps in the spool table before they are discarded. | +| snmp_security_name | | Specifies the user name or security name for sending SNMP traps. Used only with SNMPv3. | +| snmp_security_engine_id | | Specifies the Engine id of the SNMP Agent on the SNMP Server. Used only with SNMPv3. | +| snmp_security_level | NOAUTH_NOPRIV | Specifies Security level and its possible values can be: AUTH_NOPRIV - Authentication, No Privacy or AUTH_PRIV - Authentication, Privacy or NOAUTH_NOPRIV - no Authentication, no Privacy. Used only with SNMPv3. | +| snmp_context_name | | Specifies the Context name, the identifier for MIB objects when sending SNMP traps. Used only with SNMPv3. | +| snmp_context_engine_id | | Specifies the Context engine id, the identifier for MIB objects when sending SNMP traps. If not specified, snmp_security_engine_id will be used. Used only with SNMPv3. | +| snmp_authentication_protocol | NONE | Specifies the authentication type for SNMP traps. Its possible values can be NONE,HMACMD5 or HMACSHA. Used only with SNMPv3. | +| snmp_privacy_protocol | NONE | Specifies the privacy protocol for SNMP traps. Its possible values can be NONE, DES, AES128, IDEA, AES192, or AES256. Used only with SNMPv3. | +| snmp_authentication_password | | Specifies the authentication password associated with security name mentioned in snmp_security_name. Used only for SNMPv3. | +| snmp_privacy_password | | Specifies the privacy password associated with security name mentioned in snmp_security_name. Used only for SNMPv3. | +| webclient_help_pg | EDB hosted documentation | Specifies the location of the online PostgreSQL core documentation. | ## Capacity Manager Metrics - Reference diff --git a/product_docs/docs/pem/8.1.0/pem_ent_feat/17_monitoring_BDR_nodes.mdx b/product_docs/docs/pem/8.1.0/pem_ent_feat/17_monitoring_BDR_nodes.mdx index bd34ed1d1d6..fac94fbb046 100644 --- a/product_docs/docs/pem/8.1.0/pem_ent_feat/17_monitoring_BDR_nodes.mdx +++ b/product_docs/docs/pem/8.1.0/pem_ent_feat/17_monitoring_BDR_nodes.mdx @@ -2,22 +2,20 @@ title: "Monitoring BDR Nodes" --- - BDR (Bi-Directional Replication) is a PostgreSQL extension that provides a multi-master replication between the Postgres clusters. Before you monitor BDR through PEM console, you must ensure that your BDR nodes are up and running. For more information about BDR, please see [BDR Documentation](https://www.enterprisedb.com/docs/bdr/latest). You can configure PEM to display status information about one or more BDR Nodes via dashboards from PEM 8.1.0 and BDR 3.7.9 onwards. To configure PEM to monitor `BDR Nodes`, use the PEM Web Client to create a server definition. Use the tabs on the [New Server Registration](https://www.enterprisedb.com/docs/pem/latest/pem_online_help/01_toc_pem_getting_started/07_pem_define_connection/#pem_define_connection) dialog to specify general connection properties for the BDR Node with the following exceptions: -- Specify the BDR-enabled database name in the `Database` field of the `PEM Agent` tab. +- Specify the BDR-enabled database name in the `Database` field of the `PEM Agent` tab. -- Specify the user having `bdr_monitor` or `bdr_superuser` role in the `username` field of the `PEM Agent` tab. +- Specify the user having `bdr_monitor` or `bdr_superuser` role in the `username` field of the `PEM Agent` tab. After saving the server definition, the BDR Node will be included in the list of servers under the PEM Server Directory in the PEM client object browser tree. You can monitor the `BDR Nodes` from BDR dashboards. -To include monitoring information on the BDR dashboards, you must enable the relative probes for each BDR Group. You can see the complete list of BDR Probes [here](05_performance_monitoring_and_management/#bdr_probes). +To include monitoring information on the BDR dashboards, you must enable the relative probes for each BDR Group. You can see the complete list of BDR Probes [here](05_performance_monitoring_and_management/#bdr-probes). To enable a probe, right click on the node name, and select `Manage Probes` from the `Management` menu. To monitor the BDR Node, right click on the name of the BDR Node in the Object browser tree control and navigate through the Dashboards menu to select `BDR Admin` or `BDR Group Monitoring` or `BDR Node Monitoring` dashboard. - diff --git a/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/01_prerequisites_for_installing_pem_server.mdx b/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/01_prerequisites_for_installing_pem_server.mdx index c9072287fd7..d7dbaacab34 100644 --- a/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/01_prerequisites_for_installing_pem_server.mdx +++ b/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/01_prerequisites_for_installing_pem_server.mdx @@ -39,6 +39,7 @@ title: "Prerequisites for Installing the PEM Server on Linux Platforms" Please note that Debian 10 and Ubuntu 20 has increased the requirements to accept the certificates due to security reason. If a user wants to install the PEM Agent on any of the machines, they must upgrade `ssltuils` to 1.3 where 4096 bit RSA key and sha256 signature algorithm support has added.If the user does not upgrade `sslutils` to 1.3, then PEM Agent may fail to connect to the PEM backend database server, and it might log the error `ca md too weak`. + 5. Adjust your firewall restrictions. If you are using a firewall, you must allow access to port `8443` on the PEM backend database: @@ -53,6 +54,7 @@ title: "Prerequisites for Installing the PEM Server on Linux Platforms" To install the PEM Server, you must have credentials that allow access to the EDB repository. To request credentials for the repository, contact [EDB](https://www.enterprisedb.com/repository-access-request) . When using commands in the sections that follow, replace the `username` and `password` placeholders with the credentials provided by EDB + 7. PEM is dependent on third-party components from the vendor repository, including the python3, libboost, openssl, snmp++, libcurl, etc. To ensure these components are up to date, you should update your operating system using following platform-specific commands. Minimum version require for openssl is 1.0.2k. To upgrade packages on a CentOS or RHEL 7.x host diff --git a/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/06_configuring_the_pem_server_to_use_kerberos_authentication.mdx b/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/06_configuring_the_pem_server_to_use_kerberos_authentication.mdx index 7f9e1753cc8..9ed951017af 100644 --- a/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/06_configuring_the_pem_server_to_use_kerberos_authentication.mdx +++ b/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/06_configuring_the_pem_server_to_use_kerberos_authentication.mdx @@ -7,13 +7,14 @@ title: "Configuring the PEM Server to use Kerberos Authentication" - Kerberos Server - PEM Server (PEM Web Server and PEM Backend Database Server) - Client machine - + - For example the `REALM` on Kerberos Server is `edbpem.org` then Kerberos Server hostname can be set as `Krb5server.edbpem.org`, the PEM Server hostname as `pem.edbpem.org` and the client's hostname as `pg12.edbpem.org`. - It is a convention to use the DNS domain name as the name of the realm. Follow the steps to configure the Kerberos Authentication for the PEM Server: + ## 1. Install Kerberos, the PEM Server and the PEM Backend Database - Install the Kerberos on the machine that functions as the authentication server. @@ -34,53 +35,52 @@ $ sudo kadmin.local -q "addprinc -randkey postgres/" Where, `HOSTNAME_OF_PEM_SERVER` must contain the `REALM` of the `Kerberos Server`. For example - You can specify `pemdb.edbpem.org` as the hostname of PEM Server with `edbpem.org` as the `REALM`. !!! Note - - If the PEM Web Application and the PEM Backend Database Server are on different machines, then hostname for both will be different. ## 3. Extract Key Tables from Kerberos Server a. Extract the Key Tables from Kerberos for the PEM Web Application and the PEM Backend Database Server: - ```text - sudo kadmin.local "ktadd -k .keytab HTTP/" - sudo kadmin.local "ktadd -k .keytab postgres/" - ``` +```text +sudo kadmin.local "ktadd -k .keytab HTTP/" +sudo kadmin.local "ktadd -k .keytab postgres/" +``` b. Copy the Key Tables from Kerberos Server to the PEM Server: - ```text - scp .keytab @:/tmp - scp .keytab @:/tmp - ``` +```text +scp .keytab @:/tmp +scp .keytab @:/tmp +``` c. On the PEM Server, move the Key Tables to required location and change the ownership as following: - ```text - mv /tmp/.keytab /share - chown pem /share/.keytab - ``` +```text +mv /tmp/.keytab /share +chown pem /share/.keytab +``` - ```text - mv /tmp/.keytab / - chown enterprisedb /.keytab - ``` +```text +mv /tmp/.keytab / +chown enterprisedb /.keytab +``` Where, - - `NAME_OF_PEM_WEB_FILE` is the name specified to the Key Table for the PEM Web Application. - - `NAME_OF_PEM_DB_FILE` is the name specified to the Key Table for the PEM Backend Database Server. - - `OS_USERNAME_ON_PEM_SERVER` is the name of the operating system user on the PEM Server. - - `DATA_DIRECTORY_OF_POSTGRES` is the path of the data directory of the installed postgres (PostgreSQL/EDB Postgres Advanced Server). +- `NAME_OF_PEM_WEB_FILE` is the name specified to the Key Table for the PEM Web Application. +- `NAME_OF_PEM_DB_FILE` is the name specified to the Key Table for the PEM Backend Database Server. +- `OS_USERNAME_ON_PEM_SERVER` is the name of the operating system user on the PEM Server. +- `DATA_DIRECTORY_OF_POSTGRES` is the path of the data directory of the installed postgres (PostgreSQL/EDB Postgres Advanced Server). ## 4. Configure the PEM Backend Database Server - Add the Key Table location in `postgresql.conf` file - ```text - krb_server_keyfile='FILE://.keytab' - ``` + ```text + krb_server_keyfile='FILE://.keytab' + ``` - Where, + Where, - `NAME_OF_PEM_DB_FILE` is the name specified to the Key Table for the PEM Backend Database Server. @@ -88,11 +88,11 @@ c. On the PEM Server, move the Key Tables to required location and change the o - Restart the database server to have the effect of changes - ```text - systemctl restart - ``` + ```text + systemctl restart + ``` - Where, + Where, - `POSTGRES_SERVICE_NAME` is the service name of Postgres (PostgreSQL/EDB Postgres Advanced Server) database. For eg: postgresql-13 for PostgreSQL 13 database on CentOS or RHEL platforms. @@ -100,74 +100,73 @@ c. On the PEM Server, move the Key Tables to required location and change the o - Run the PEM configure script on the PEM Server to use Kerberos Authentication - ```text - $ sudo PEM_APP_HOST= PEM_KRB_KTNAME=.keytab /bin/configure-pem-server.sh - ``` + ```text + $ sudo PEM_APP_HOST= PEM_KRB_KTNAME=.keytab /bin/configure-pem-server.sh + ``` - Configure the `PEM_DB_HOST` in `config_setup.py` file and check the value of `PEM_AUTH_METHOD` is set to `'kerberos'`. - - ```text - $ sudo vim /share/web/config_setup.py - PEM_DB_HOST=`` - ``` + ```text + $ sudo vim /share/web/config_setup.py + PEM_DB_HOST=`` + ``` + - Configure the `HOST` in `.install-config` file - ```text - $ sudo vim /share/.install-config - HOST=`` - ``` + ```text + $ sudo vim /share/.install-config + HOST=`` + ``` + - If the PEM Server uses Kerberos Authentication, - All the monitored servers will default to use the same authentication. To override the default, add the parameter `ALLOW_DATABASE_CONNECTION_WITHOUT_KERBEROS` and set to `True` in `config_local.py` file. - - All the authenticated user principal will be appended with realm (USERNAME@REALM) and passed as database user name by default. To override the default, add the parameter `PEM_USER_KRB_INCLUDE_REALM` and set to `False` in `config_local.py` file. + - All the authenticated user principal will be appended with realm (USERNAME@REALM) and passed as database user name by default. To override the default, add the parameter `PEM_USER_KRB_INCLUDE_REALM` and set to `False` in `config_local.py` file. - Restart the Apache server - ```text - sudo systemctl restart - ``` + ```text + sudo systemctl restart + ``` - Edit the entries at the top in `pg_hba.conf` to use `gss` authentication method and reload the database server. - ```text - host pem +pem_user /32 gss - host postgres +pem_user /32 gss - ``` + ```text + host pem +pem_user /32 gss + host postgres +pem_user /32 gss + ``` - ```text - systemctl reload - ``` + ```text + systemctl reload + ``` - Where, + Where, - - `POSTGRES_SERVICE_NAME` is the service name of Postgres (PostgreSQL/EDB Postgres Advanced Server) database. For eg: postgresql-13 for PostgreSQL 13 database on CentOS or RHEL platforms. +- `POSTGRES_SERVICE_NAME` is the service name of Postgres (PostgreSQL/EDB Postgres Advanced Server) database. For eg: postgresql-13 for PostgreSQL 13 database on CentOS or RHEL platforms. !!! Note - If you are using PostgreSQL OR EDB Postgres Advanced Server 12 or later then you can specify connection type as `hostgssenc` to allow only gss encrypted connection. ## 6. Obtain and view the initial ticket - The `kinit` utility obtains and caches Kerberos tickets. This utility is typically used to obtain the ticket-granting ticket, using a password entered by the user to decrypt the credential from the key distribution center (KDC). The ticket-granting ticket is then stored in the user's credential cache. -- You can view the details of the ticket using `klist` utility. +- You can view the details of the ticket using `klist` utility. !!! Note The `Kerberos Client` must be installed on the PEM Server and the Client machine to use `kinit` and `klist`. - ``` text - $ kinit - $ klist - ``` +```text +$ kinit +$ klist +``` It will display the principal along with the kerberos ticket. !!! Note - The `USERNAME@REALM` specified here must be the database user having the `pem_admin` role and `CONNECT` privilege on `pem` database. -## 7. Browser Settings +## 7. Browser Settings Configure the Browser on the Client machine to access the PEM Web Client to use the `Spnego/Kerberos`. @@ -184,12 +183,12 @@ Configure the Browser on the Client machine to access the PEM Web Client to use - Add the `--auth-server-whitelist` parameter to the google-chrome command. For example, to run Chrome from a Linux prompt, run the google-chrome command as follows: - ```text - google-chrome --auth-server-whitelist = "hostname/domain" - ``` + ```text + google-chrome --auth-server-whitelist = "hostname/domain" + ``` -- After configuring the PEM server, you can access the PEM web interface in your browser. Navigate to: +- After configuring the PEM server, you can access the PEM web interface in your browser. Navigate to: - ```text - https://:8443/pem - ``` + ```text + https://:8443/pem + ``` diff --git a/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/07_configuring_the_pem_server_to_use_windows_kerberos_server.mdx b/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/07_configuring_the_pem_server_to_use_windows_kerberos_server.mdx index 4ecd1b16f6f..f8c2fc1b202 100644 --- a/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/07_configuring_the_pem_server_to_use_windows_kerberos_server.mdx +++ b/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/07_configuring_the_pem_server_to_use_windows_kerberos_server.mdx @@ -4,10 +4,9 @@ title: "Configuring the PEM Server to use Windows Active Directory Domain Servic - The Windows Active Directory Domain Services works with hostnames and not with `ip addresses`. To use single sign-on in PEM Server using `Active Directory Domain Services`, the following machines must be configured with hostnames using the DNS. - - Windows Server (Domain Controller) - - PEM Server (PEM Web Server and PEM Backend Database Server) - - Client machine - + - Windows Server (Domain Controller) + - PEM Server (PEM Web Server and PEM Backend Database Server) + - Client machine - For example the `REALM` on Windows Active Directory is `edbpem.internal` then Windows Server hostname can be set as `Krb5server.edbpem.internal`, the PEM Server hostname as `pem.edbpem.internal` and the client's hostname as `pg12.edbpem.internal`. Follow the steps to configure the Kerberos Authentication for the PEM Server: @@ -22,57 +21,58 @@ Follow the steps to configure the Kerberos Authentication for the PEM Server: ## 2. Create Users in Active Directory to map with Service Principals -- Create user in Active directory of Windows Server to map with the HTTP Service Principal for the PEM Web Application. +- Create user in Active directory of Windows Server to map with the HTTP Service Principal for the PEM Web Application. - a. Open `Active Directory Users and Computers` -> `` -> `Users` -> Right Click -> `New` -> `User` + a. Open `Active Directory Users and Computers` -> `` -> `Users` -> Right Click -> `New` -> `User` - ![Active Directory Users and Computers](../../images/active_directory_users_and_computers.png) + ![Active Directory Users and Computers](../../images/active_directory_users_and_computers.png) - b. Enter the user details + b. Enter the user details - ![Active Directory Users and Computers Create User](../../images/active_directory_users_and_computers_create_user.png) + ![Active Directory Users and Computers Create User](../../images/active_directory_users_and_computers_create_user.png) - c. Give the password and make sure to deselect `User must change password at next logon`, and select `User cannot change password` and `Password never expires`. + c. Give the password and make sure to deselect `User must change password at next logon`, and 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) + ![Active Directory Users and Computers set password](../../images/active_directory_users_and_computers_set_password.png) - d. Review the user details + d. Review the user details - ![Active Directory Users and Computers User Details](../../images/active_directory_users_and_computers_user_details.png) + ![Active Directory Users and Computers User Details](../../images/active_directory_users_and_computers_user_details.png) - e. On the `PEMServer Web Properties`, add the Users as member of the following groups: + e. On the `PEMServer Web Properties`, add the Users as member of the following groups: - - Domain Admins - - Domain Users - - Enterprise Admins - - Schema Admins + - Domain Admins + - Domain Users + - Enterprise Admins + - Schema Admins - ![PEM Server Web Properties](../../images/pem_server_web_properties_member_of.png) + ![PEM Server Web Properties](../../images/pem_server_web_properties_member_of.png) -- Create user (for eg: `pemserverdb`) in Active directory of Windows Server to map with the Postgres Service Principal for the PEM Backend Database. +- Create user (for eg: `pemserverdb`) in Active directory of Windows Server to map with the Postgres Service Principal for the PEM Backend Database. - Repeat the steps from `a` to `e` as above. + Repeat the steps from `a` to `e` as above. ## 3. Extract Key Tables from Active Directory -- Extract the Key Tables for the Service Principals and map with the respective domain users created in above step. +- Extract the Key Tables for the Service Principals and map with the respective domain users created in above step. a. Open `Windows PowerShell` as an `Administrator` user, create a Key Table for HTTP Service Principal mapping with user `pemserverweb` and a Key Table for Postgres Service Principal mappping with user `pemserverdb`. - ```text - > ktpass /out pemserver.keytab /princ HTTP/pem.edbpem.internal@EDBPEM.INTERNAL /mapuser pemserverweb /crypto AES256-SHA1 +rndpass /target EDBPEM.INTERNAL -ptype KRB5_NT_PRINCIPAL - > ktpass /out pemdb.keytab /princ postgres/pem.edbpem.internal@EDBPEM.INTERNAL /mapuser pemserverdb /crypto AES256-SHA1 +rndpass /target EDBPEM.INTERNAL -ptype KRB5_NT_PRINCIPAL - ``` - +```text +> ktpass /out pemserver.keytab /princ HTTP/pem.edbpem.internal@EDBPEM.INTERNAL /mapuser pemserverweb /crypto AES256-SHA1 +rndpass /target EDBPEM.INTERNAL -ptype KRB5_NT_PRINCIPAL +> ktpass /out pemdb.keytab /princ postgres/pem.edbpem.internal@EDBPEM.INTERNAL /mapuser pemserverdb /crypto AES256-SHA1 +rndpass /target EDBPEM.INTERNAL -ptype KRB5_NT_PRINCIPAL +``` + Where, - - `pemserver.keytab` is the name of the Key Table for the PEM Web Apllication - - `pemdb.keytab` is the name of the key Table for the PEM Backend Database Server - - `pem.edbpem.internal@EDBPEM.INTERNAL` is the hostname of the PEM Server (here @EDBPEM.INTERNAL means @REALM) - - `pemserverweb` is the user for the PEM Web Application - - `pemserverdb` is the user for the PEM Backend Database Server - - `EDBPEM.INTERNAL` is the domain of the target - ![Windows PowerShell ktpass](../../images/windows_powershell_ktpass.png) +- `pemserver.keytab` is the name of the Key Table for the PEM Web Apllication +- `pemdb.keytab` is the name of the key Table for the PEM Backend Database Server +- `pem.edbpem.internal@EDBPEM.INTERNAL` is the hostname of the PEM Server (here @EDBPEM.INTERNAL means @REALM) +- `pemserverweb` is the user for the PEM Web Application +- `pemserverdb` is the user for the PEM Backend Database Server +- `EDBPEM.INTERNAL` is the domain of the target + + ![Windows PowerShell ktpass](../../images/windows_powershell_ktpass.png) !!! Note The command line argument `+rndpass` will reset the password for the Domain User `pemserverweb` to a random password. @@ -92,39 +92,40 @@ d. Copy both the Key Tables to the PEM Server Host (or respectively to PEM Web S e. On the PEM Server, move the Key Tables to required location and change the ownership as following: - ```text - mv /tmp/pemserver.keytab /share - chown pem /share/pemserver.keytab - ``` +```text +mv /tmp/pemserver.keytab /share +chown pem /share/pemserver.keytab +``` - ```text - mv /tmp/pemdb.keytab / - chown enterprisedb /pemdb.keytab - ``` +```text +mv /tmp/pemdb.keytab / +chown enterprisedb /pemdb.keytab +``` Where, - - `OS_USERNAME_ON_PEM_SERVER` is the name of the operating system user on the PEM Server. - - `DATA_DIRECTORY_OF_POSTGRES` is the path of the data directory of the installed postgres (PostgreSQL/EDB Postgres Advanced Server). + +- `OS_USERNAME_ON_PEM_SERVER` is the name of the operating system user on the PEM Server. +- `DATA_DIRECTORY_OF_POSTGRES` is the path of the data directory of the installed postgres (PostgreSQL/EDB Postgres Advanced Server). ## 4. Configure the PEM Backend Database Server - Add the Key Table location in `postgresql.conf` file - ```text - krb_server_keyfile='FILE://pemdb.keytab' - ``` + ```text + krb_server_keyfile='FILE://pemdb.keytab' + ``` - Where, + Where, - `DATA_DIRECTORY_OF_POSTGRES` is the path of the data directory of the installed postgres (PostgreSQL/EDB Postgres Advanced Server. - Restart the database server to have the effect of changes - ```text - systemctl restart - ``` + ```text + systemctl restart + ``` - Where, + Where, - `POSTGRES_SERVICE_NAME` is the service name of Postgres (PostgreSQL/EDB Postgres Advanced Server) database. For eg: postgresql-13 for PostgreSQL 13 database on CentOS or RHEL platforms. @@ -132,54 +133,54 @@ e. On the PEM Server, move the Key Tables to required location and change the o - Run the PEM configure script on the PEM Server to use Kerberos Authentication - ```text - $ sudo PEM_APP_HOST=pem.edbpem.internal PEM_KRB_KTNAME=/bin/configure-pem-server.sh - ``` + ```text + $ sudo PEM_APP_HOST=pem.edbpem.internal PEM_KRB_KTNAME=/bin/configure-pem-server.sh + ``` - Configure the `PEM_DB_HOST` in `config_setup.py` file and check the value of `PEM_AUTH_METHOD` is set to `'kerberos'`. - - ```text - $ sudo vim /share/web/config_setup.py - PEM_DB_HOST=`pem.edbpem.internal` - ``` + ```text + $ sudo vim /share/web/config_setup.py + PEM_DB_HOST=`pem.edbpem.internal` + ``` + - Configure the `HOST` in `.install-config` file - ```text - $ sudo vim /share/.install-config - HOST=`pem.edbpem.internal` - ``` + ```text + $ sudo vim /share/.install-config + HOST=`pem.edbpem.internal` + ``` + - If the PEM Server uses Kerberos Authentication, - All the monitored servers will default to use the same authentication. To override the default, add the parameter `ALLOW_DATABASE_CONNECTION_WITHOUT_KERBEROS` and set to `True` in `config_local.py` file. - - All the authenticated user principal will be appended with realm (USERNAME@REALM) and passed as database user name by default. To override the default, add the parameter `PEM_USER_KRB_INCLUDE_REALM` and set to `False` in `config_local.py` file. + - All the authenticated user principal will be appended with realm (USERNAME@REALM) and passed as database user name by default. To override the default, add the parameter `PEM_USER_KRB_INCLUDE_REALM` and set to `False` in `config_local.py` file. - Restart the Apache server - ```text - sudo systemctl restart - ``` + ```text + sudo systemctl restart + ``` - Edit the entries at the top in `pg_hba.conf` to use `gss` authentication method and reload the database server. - ```text - host pem +pem_user /32 gss - host postgres +pem_user /32 gss - ``` + ```text + host pem +pem_user /32 gss + host postgres +pem_user /32 gss + ``` - ```text - systemctl reload - ``` + ```text + systemctl reload + ``` - Where, + Where, - - `POSTGRES_SERVICE_NAME` is the service name of Postgres (PostgreSQL/EDB Postgres Advanced Server) database. For eg: postgresql-13 for PostgreSQL 13 database on CentOS or RHEL platforms. +- `POSTGRES_SERVICE_NAME` is the service name of Postgres (PostgreSQL/EDB Postgres Advanced Server) database. For eg: postgresql-13 for PostgreSQL 13 database on CentOS or RHEL platforms. !!! Note - You cannot specify connection type as `hostgssenc` as windows does not support gss encrypted connection. -## 6. Browser Settings +## 6. Browser Settings Configure the Browser on the Client machine to access the PEM Web Client to use the `Spnego/Kerberos`. @@ -196,12 +197,12 @@ Configure the Browser on the Client machine to access the PEM Web Client to use - Add the `--auth-server-whitelist` parameter to the google-chrome command. For example, to run Chrome from a Linux prompt, run the google-chrome command as follows: - ```text - google-chrome --auth-server-whitelist = "hostname/domain" - ``` + ```text + google-chrome --auth-server-whitelist = "hostname/domain" + ``` -- After configuring the PEM server, you can access the PEM web interface in your browser. Navigate to: +- After configuring the PEM server, you can access the PEM web interface in your browser. Navigate to: - ```text - https://:8443/pem - ``` + ```text + https://:8443/pem + ``` diff --git a/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/08_installing_pem_agent_on_linux.mdx b/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/08_installing_pem_agent_on_linux.mdx index 8e89328d0d6..0f10385ca58 100644 --- a/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/08_installing_pem_agent_on_linux.mdx +++ b/product_docs/docs/pem/8.1.0/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/08_installing_pem_agent_on_linux.mdx @@ -67,7 +67,7 @@ When you install an RPM package that is signed by a source that is not recognize During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. -After installing PEM Agent using `yum` or `dnf`, you need to register the PEM Agent. For detailed information see [Registering a PEM Agent](07_registering_a_pem_agent/#registering-a-pem-agent). +After installing PEM Agent using `yum` or `dnf`, you need to register the PEM Agent. For detailed information see [Registering a PEM Agent](09_registering_a_pem_agent/#registering-a-pem-agent). ## Installing a PEM Agent on a Debian or Ubuntu Host @@ -129,7 +129,7 @@ The following steps will walk you through using the EDB apt repository to instal apt-get install edb-pem-agent ``` -After installing PEM Agent using `apt-get`, you need to register the PEM Agent. For more detailed information see [Registering a PEM Agent](07_registering_a_pem_agent/#registering-a-pem-agent). +After installing PEM Agent using `apt-get`, you need to register the PEM Agent. For more detailed information see [Registering a PEM Agent](09_registering_a_pem_agent/#registering-a-pem-agent). ## Installing a PEM Agent on a SLES Host @@ -161,4 +161,4 @@ zypper refresh zypper install edb-pem-agent ``` -After installing the PEM Agent, you must register the agent. For more detailed information see [Registering a PEM Agent](07_registering_a_pem_agent/#registering-a-pem-agent). +After installing the PEM Agent, you must register the agent. For more detailed information see [Registering a PEM Agent](09_registering_a_pem_agent/#registering-a-pem-agent). diff --git a/product_docs/docs/pem/8.1.0/pem_inst_guide_windows/01_whats_new.mdx b/product_docs/docs/pem/8.1.0/pem_inst_guide_windows/01_whats_new.mdx index 67b21c02d6f..6d6a52ee922 100644 --- a/product_docs/docs/pem/8.1.0/pem_inst_guide_windows/01_whats_new.mdx +++ b/product_docs/docs/pem/8.1.0/pem_inst_guide_windows/01_whats_new.mdx @@ -13,4 +13,4 @@ The following changes have been made to Postgres Enterprise Manager to create ve - Added ability to configure the following PEM tools without restarting the monitored server: - Log Manager - Audit Manager - - Tuning Wizard \ No newline at end of file + - Tuning Wizard diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/04_pem_roles.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/04_pem_roles.mdx index 421fb02b850..46732a57825 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/04_pem_roles.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/04_pem_roles.mdx @@ -46,14 +46,5 @@ You can use PEM pre-defined roles to allow access to the functionality listed in | pem_comp_tuning_wizard | pem_component | Role to run the Tuning Wizard. | | pem_comp_bart | pem_component | Role to configure and manage BART server. | -
- -
- -Note - -
- -The difference between pem_admin role and pem_super_admin role is that a user with pem_admin role can view and manage only those objects where the role has been mentioned in the Team field under the server's properties, while a user with pem_super_admin role can view and manage all the objects within Postgres Enterprise Manager console. - -
+!!! Note + The difference between pem_admin role and pem_super_admin role is that a user with pem_admin role can view and manage only those objects where the role has been mentioned in the Team field under the server's properties, while a user with pem_super_admin role can view and manage all the objects within Postgres Enterprise Manager console. diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/08_pem_define_aws_instance_connection.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/08_pem_define_aws_instance_connection.mdx index 708cbcc37b5..0c7c49a12f3 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/08_pem_define_aws_instance_connection.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/08_pem_define_aws_instance_connection.mdx @@ -15,17 +15,8 @@ After creating a Postgres instance on AWS EC2, you can use the PEM server to reg > - Postgres instance and PEM Agent running on the same local machine and a PEM Server running on AWS EC2. > - Postgres instance and PEM Agent running on the same AWS EC2 and a PEM Server running in different AWS EC2. -
- -
- -Note - -
- -In the first two scenarios, you must configure the VPN on AWS EC2 , so the AWS EC2 instance can access the `pem` database. Please contact your network administrator to setup the VPN if needed. - -
+!!! Note + In the first two scenarios, you must configure the VPN on AWS EC2 , so the AWS EC2 instance can access the `pem` database. Please contact your network administrator to setup the VPN if needed. The PEM Agent running on AWS EC2 or on your local machine should be registered to the PEM Server. Please note that when registering the PEM Agent with the PEM Server you should use the hostname of AWS EC2 instance. For more details on registering the PEM Agent see, [PEM Self Registration](../02_toc_pem_agent/07_pem_agent_self_registration/#pem_agent_self_registration). diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/02_pem_agent_binding/01_pem_agent_config_params.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/02_pem_agent_binding/01_pem_agent_config_params.mdx index b405bb5acba..240123c53d7 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/02_pem_agent_binding/01_pem_agent_config_params.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/02_pem_agent_binding/01_pem_agent_config_params.mdx @@ -46,14 +46,5 @@ A number of user-configurable parameters and registry entries control the behavi | WebhookSSLCrl (on Windows) or webhook_ssl_crl (on Linux) | The complete path of the CRL file to validate webhook server certificate. | | | AllowInsecureWebhooks (on Windows) or allow_insecure_webhooks (on Linux) | When set to true, allow webhooks to call with insecure flag. | false | -
- -
- -Note - -
- -If you add or remove any of the parameter in the `agent.cfg` file then agent must be restarted to apply the changes. - -
+!!! Note + If you add or remove any of the parameter in the `agent.cfg` file then agent must be restarted to apply the changes. diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/06_pem_agent_config_params.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/06_pem_agent_config_params.mdx index b405bb5acba..240123c53d7 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/06_pem_agent_config_params.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/06_pem_agent_config_params.mdx @@ -46,14 +46,5 @@ A number of user-configurable parameters and registry entries control the behavi | WebhookSSLCrl (on Windows) or webhook_ssl_crl (on Linux) | The complete path of the CRL file to validate webhook server certificate. | | | AllowInsecureWebhooks (on Windows) or allow_insecure_webhooks (on Linux) | When set to true, allow webhooks to call with insecure flag. | false | -
- -
- -Note - -
- -If you add or remove any of the parameter in the `agent.cfg` file then agent must be restarted to apply the changes. - -
+!!! Note + If you add or remove any of the parameter in the `agent.cfg` file then agent must be restarted to apply the changes. diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/09_pem_alerting/01_pem_alerting_dialog.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/09_pem_alerting/01_pem_alerting_dialog.mdx index 0b0490872d5..231f232c4f0 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/09_pem_alerting/01_pem_alerting_dialog.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/09_pem_alerting/01_pem_alerting_dialog.mdx @@ -116,40 +116,31 @@ Use the fields in the `Script execution` tab to (optionally) define a script tha When you have defined the alert attributes, click the edit icon to close the alert definition editor, and then the save icon (in the upper-right corner of the `Alerts` table). To discard your changes, click the refresh icon; a popup will ask you to confirm that you wish to discard the changes. -
+!!! Note + Suppose you need to use the alert configuration placeholder values in an external script. You can do it either by passing them as the command-line arguments or exporting them as environment variables. Please note that the external script must have proper execution permissions. -
+ - You can run the script with any of the placeholders as command-line argument. -Note + For eg: -
+ > ```bash + > #!/bin/bash + > + > bash /script.sh "%AlertName% %AlertLevel% %AlertDetails%" + > ``` -Suppose you need to use the alert configuration placeholder values in an external script. You can do it either by passing them as the command-line arguments or exporting them as environment variables. Please note that the external script must have proper execution permissions. + - You can define the environment variables for any of the placeholders and then use those environment variables in the script. -- You can run the script with any of the placeholders as command-line argument. + For eg: - For eg: - - > ```bash - > #!/bin/bash - > - > bash /script.sh "%AlertName% %AlertLevel% %AlertDetails%" - > ``` - -- You can define the environment variables for any of the placeholders and then use those environment variables in the script. - - For eg: - - > ```bash - > #!/bin/bash - > - > export AlertName=%AlertName% - > export AlertState=%AlertState% - > - > bash /script.sh - > ``` - -
+ > ```bash + > #!/bin/bash + > + > export AlertName=%AlertName% + > export AlertState=%AlertState% + > + > bash /script.sh + > ``` ## Modifying an Existing Alert diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/09_pem_alerting/06_pem_webhooks.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/09_pem_alerting/06_pem_webhooks.mdx index 67fe1f97c3c..0aa2a002ab3 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/09_pem_alerting/06_pem_webhooks.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/09_pem_alerting/06_pem_webhooks.mdx @@ -27,17 +27,8 @@ Use the `General` tab to define the basic details of the webhook: - Set the request method type used to make the call in the `Request Method` field i.e. `POST` or `PUT`. - By default `webhooks` will be enabled; to disable a webhook set `Enable?` to `No`. -
- -
- -Note - -
- -The above `Enable?` setting will work only if `enable_webhook` parameter is set to true in `agent.cfg` file. By default, `enable_webhook` parameter is set to true only for the Agent running on the PEM Server Host. For all other Agents running on other hosts, it needs to be set to true manually. - -
+!!! Note + The above `Enable?` setting will work only if `enable_webhook` parameter is set to true in `agent.cfg` file. By default, `enable_webhook` parameter is set to true only for the Agent running on the PEM Server Host. For all other Agents running on other hosts, it needs to be set to true manually. ## Defining a Webhook SSL configurations diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/16_pem_scheduled_jobs.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/16_pem_scheduled_jobs.mdx index f0e7e5bf951..9a5c56488ce 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/16_pem_scheduled_jobs.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/16_pem_scheduled_jobs.mdx @@ -59,17 +59,8 @@ After providing all the information required by the step, click the `Save` butto Click the add icon (+) to add each additional step, or select the `Schedules` tab to define the job schedule. -
- -
- -Note - -
- -When you create the Job, the time fields under `Schedules` tab takes the timezone of the client machine. While saving the jobs on the PEM Server, the timezone gets converted according to PEM Server's timezone irrespective of PEM Agent's location. - -
+!!! Note + When you create the Job, the time fields under `Schedules` tab takes the timezone of the client machine. While saving the jobs on the PEM Server, the timezone gets converted according to PEM Server's timezone irrespective of PEM Agent's location. Click the Add icon (+) to add a schedule for the job; then click the compose icon (located at the left side of the header) to open the schedule definition dialog: diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/20_performance_diagnostic.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/20_performance_diagnostic.mdx index 0b48a3b34c3..646916b4a4a 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/20_performance_diagnostic.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/20_performance_diagnostic.mdx @@ -8,17 +8,8 @@ You can use the Performance Diagnostic dashboard to analyze the database perform Peformance Diagnostic feature is supported for Advanced Server databases from PEM 7.6 version onwards and for PostgreSQL databases it is supported from PEM 8.0 onwards. -
- -
- -Note - -
- -For PostgreSQL databases, Performance Diagnostics is supported only for versions 10, 11, and 12 installed on the supported CentOS or RHEL platforms. - -
+!!! Note + For PostgreSQL databases, Performance Diagnostics is supported only for versions 10, 11, and 12 installed on the supported CentOS or RHEL platforms. For more information on EDB Wait States, see [EDB Postgres Advanced Server Guide](/epas/latest/epas_guide/13_performance_analysis_and_tuning/). diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/03_import_export_data.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/03_import_export_data.mdx index aa50b28d839..5a407dfb16e 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/03_import_export_data.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/03_import_export_data.mdx @@ -53,14 +53,5 @@ Use the `Click here for details` link on the notification to open the `Process W ![Import/Export data dialog - Process Watcher](../images/import_export_pw.png) -
- -
- -Note - -
- -You can click on the ![sm_icon](../images/sm_icon.png) icon in the process watcher window to open the file location in the Storage Manager. You can use the [Storage Manager](05_storage_manager/#storage_manager) to download the backup file on the client machine . - -
+!!! Note + You can click on the ![sm_icon](../images/sm_icon.png) icon in the process watcher window to open the file location in the Storage Manager. You can use the [Storage Manager](05_storage_manager/#storage_manager) to download the backup file on the client machine . diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/06_backup_dialog.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/06_backup_dialog.mdx index 8fb7f06020c..88b12a63b6e 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/06_backup_dialog.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/06_backup_dialog.mdx @@ -98,14 +98,5 @@ If the backup is successful, a popup window will confirm success. Click *More de If the backup is unsuccessful, you can review the error messages returned by the backup command on the `Process Watcher`. -
- -
- -Note - -
- -You can click on the ![sm_icon](../images/sm_icon.png) icon in the process watcher window to open the file location in the Storage Manager. You can use the [Storage Manager](05_storage_manager/#storage_manager) to download the backup file on the client machine . - -
+!!! Note + You can click on the ![sm_icon](../images/sm_icon.png) icon in the process watcher window to open the file location in the Storage Manager. You can use the [Storage Manager](05_storage_manager/#storage_manager) to download the backup file on the client machine . diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/07_backup_globals_dialog.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/07_backup_globals_dialog.mdx index 468f465f213..b098fd76b24 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/07_backup_globals_dialog.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/07_backup_globals_dialog.mdx @@ -30,14 +30,5 @@ If the backup is successful, a popup window will confirm success. Click `Click h If the backup is unsuccessful, review the error message returned by the `Process Watcher` to resolve any issue. -
- -
- -Note - -
- -You can click on the ![sm_icon](../images/sm_icon.png) icon in the process watcher window to open the file location in the Storage Manager. You can use the [Storage Manager](05_storage_manager/#storage_manager) to download the backup file on the client machine . - -
+!!! Note + You can click on the ![sm_icon](../images/sm_icon.png) icon in the process watcher window to open the file location in the Storage Manager. You can use the [Storage Manager](05_storage_manager/#storage_manager) to download the backup file on the client machine . diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/08_backup_server_dialog.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/08_backup_server_dialog.mdx index 2205671eca3..d1963e6c487 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/08_backup_server_dialog.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/08_backup_server_dialog.mdx @@ -67,14 +67,5 @@ If the backup is successful, a popup window will confirm success. Click `Click h If the backup is unsuccessful, review the error message returned by the `Process Watcher` to resolve any issue. -
- -
- -Note - -
- -You can click on the ![sm_icon](../images/sm_icon.png) icon in the process watcher window to open the file location in the Storage Manager. You can use the [Storage Manager](05_storage_manager/#storage_manager) to download the backup file on the client machine . - -
+!!! Note + You can click on the ![sm_icon](../images/sm_icon.png) icon in the process watcher window to open the file location in the Storage Manager. You can use the [Storage Manager](05_storage_manager/#storage_manager) to download the backup file on the client machine . diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/12_modifying_tables/08_rls_policy_dialog.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/12_modifying_tables/08_rls_policy_dialog.mdx index 417208ac0a0..ae79a8bc18f 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/12_modifying_tables/08_rls_policy_dialog.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/12_modifying_tables/08_rls_policy_dialog.mdx @@ -6,17 +6,8 @@ title: "RLS Policy Dialog" Use the `RLS Policy` dialog to Create a Row Level Security Policy. -
- -
- -Note - -
- -If the Row Level Security is enabled at table level and no policy is created then by default `Deny Policy` is applied. That means, no rows are visible or can be modified for that table. - -
+!!! Note + If the Row Level Security is enabled at table level and no policy is created then by default `Deny Policy` is applied. That means, no rows are visible or can be modified for that table. The `RLS Policy` dialog creates a Row Level Security Policy through the following dialog tabs: `General`, and `Commands`. The `SQL` tab displays the SQL code generated by dialog selections. diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/06_toc_pem_bart_management/08_restoring_bart_backups.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/06_toc_pem_bart_management/08_restoring_bart_backups.mdx index 26e1af500a0..d1ce6874eab 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/06_toc_pem_bart_management/08_restoring_bart_backups.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/06_toc_pem_bart_management/08_restoring_bart_backups.mdx @@ -31,17 +31,8 @@ On the `Advanced` tab, specify your preferences for advanced options for restori - Use the `Transaction ID (XID)` field to specify the transaction ID for point-in-time recovery. - Use the `Timestamp` field to the timestamp to be used for restore. -
- -
- -Note - -
- -You can specify either `Transaction ID` or `Timestamp` for the point-in-time recovery. - -
+!!! Note + You can specify either `Transaction ID` or `Timestamp` for the point-in-time recovery. ![Restore Backup dialog - Notifications tab](../images/BART_backup_restore_notifications.png) diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/07_toc_pem_sql_profiler/01_sp_installing_sql_profiler.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/07_toc_pem_sql_profiler/01_sp_installing_sql_profiler.mdx index fadade589db..035b398b8d2 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/07_toc_pem_sql_profiler/01_sp_installing_sql_profiler.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/07_toc_pem_sql_profiler/01_sp_installing_sql_profiler.mdx @@ -48,17 +48,8 @@ When the installation is complete, the SQL Profiler plugin is ready to be config ## Installing SQL Profiler on Linux using RPMs -
- -
- -Note - -
- -You may be required to add the `sslutils` package to your PostgreSQL database servers before installing SQL Profiler. - -
+!!! Note + You may be required to add the `sslutils` package to your PostgreSQL database servers before installing SQL Profiler. You can install SQL Profiler using rpm on RHEL or Centos 6 or 7, using yum command as root user: @@ -70,17 +61,8 @@ When the installation is complete, the SQL Profiler plugin is ready to be config ## Installing SQL Profiler on Debian/Ubuntu using DEB -
- -
- -Note - -
- -You may be required to add the `sslutils` package to your PostgreSQL database servers before installing SQL Profiler. - -
+!!! Note + You may be required to add the `sslutils` package to your PostgreSQL database servers before installing SQL Profiler. You can install SQL Profiler using DEB on Debian 9.x or Ubuntu 18, using apt command as root user: diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/07_toc_pem_sql_profiler/04_sp_index_advisor.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/07_toc_pem_sql_profiler/04_sp_index_advisor.mdx index 56d95bf5a5a..e74aa439b3d 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/07_toc_pem_sql_profiler/04_sp_index_advisor.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/07_toc_pem_sql_profiler/04_sp_index_advisor.mdx @@ -20,14 +20,5 @@ After installing Index Advisor, you can select one or more rows from within a tr > -
- -
- -Note - -
- -It is recommended that you disable the index advisor while using the pg_dump functionality. - -
+!!! Note + It is recommended that you disable the index advisor while using the pg_dump functionality. diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/08_toc_pem_developer_tools/04_editgrid/01_viewdata_filter.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/08_toc_pem_developer_tools/04_editgrid/01_viewdata_filter.mdx index b20db8a7891..f2175644690 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/08_toc_pem_developer_tools/04_editgrid/01_viewdata_filter.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/08_toc_pem_developer_tools/04_editgrid/01_viewdata_filter.mdx @@ -10,14 +10,5 @@ This allows you to specify an SQL Filter to limit the data displayed in the edit ![View Data filter dialog](../../images/viewdata_filter_dialog.png) -
- -
- -Note - -
- -Use SHIFT + ENTER keys to apply filter. - -
+!!! Note + Use SHIFT + ENTER keys to apply filter. diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/10_pgagent/02_pgagent_install.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/10_pgagent/02_pgagent_install.mdx index 89f85b3278e..10e9fcc399d 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/10_pgagent/02_pgagent_install.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/10_pgagent/02_pgagent_install.mdx @@ -24,17 +24,8 @@ CREATE LANGUAGE plpgsql; ## Daemon installation on Unix -
- -
- -Note - -
- -pgAgent is available in Debian/Ubuntu (DEB) and Redhat/Fedora (RPM) packages for Linux users, as well as source code. See the [pgAdmin Website](https://www.pgadmin.org/download/). for more information. - -
+!!! Note + pgAgent is available in Debian/Ubuntu (DEB) and Redhat/Fedora (RPM) packages for Linux users, as well as source code. See the [pgAdmin Website](https://www.pgadmin.org/download/). for more information. To install the pgAgent daemon on a Unix system, you will normally need to have root privileges to modify the system startup scripts. Modifying system startup scripts is quite system-specific so you should consult your system documentation for further information. @@ -61,17 +52,8 @@ The connection string is a standard PostgreSQL libpq connection string (see the ## Service installation on Windows -
- -
- -Note - -
- -pgAgent is available in a pre-built installer if you use [EnterpriseDB's PostgreSQL Installers](https://www.enterprisedb.com/downloads/postgres-postgresql-downloads). Use the StackBuilder application to download and install it. If installed in this way, the service will automatically be created and the instructions below can be ignored. - -
+!!! Note + pgAgent is available in a pre-built installer if you use [EnterpriseDB's PostgreSQL Installers](https://www.enterprisedb.com/downloads/postgres-postgresql-downloads). Use the StackBuilder application to download and install it. If installed in this way, the service will automatically be created and the instructions below can be ignored. pgAgent can install itself as a service on Windows systems. The command line options available are similar to those on Unix systems, but include an additional parameter to tell the service what to do: diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/10_pgagent/03_pgagent_jobs.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/10_pgagent/03_pgagent_jobs.mdx index ad4a501a1e4..6efd565ed98 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/10_pgagent/03_pgagent_jobs.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/10_pgagent/03_pgagent_jobs.mdx @@ -48,17 +48,8 @@ Use fields on the step definition dialog to define the step: > > - If you select `SQL`, use the `Code` tab to provide SQL code for the step. > > - If you select `Batch`, use the `Code` tab to provide the batch script that will be executed during the step. -
- -
- -Note - -
- -The fields `Connection type`, `Database` and `Connection string` are only applicable when `SQL` is selected because `Batch` cannot be run on remote servers. - -
+!!! Note + The fields `Connection type`, `Database` and `Connection string` are only applicable when `SQL` is selected because `Batch` cannot be run on remote servers. - Use the `Connection type` switch to indicate if the step is performed on a local server (`Local`) or on a remote host (`Remote`). If you specify a remote connection should be used for the step, the `Connection string` field will be enabled, and you must provide a libpq-style connection string. - Use the `Database` drop-down to select the database on which the job step will be performed. diff --git a/product_docs/docs/pem/8.1.0/pem_sqlprofiler/01_installing_the_sql_profiler_plugin.mdx b/product_docs/docs/pem/8.1.0/pem_sqlprofiler/01_installing_the_sql_profiler_plugin.mdx index 2e06eb2d41c..71496c7377f 100644 --- a/product_docs/docs/pem/8.1.0/pem_sqlprofiler/01_installing_the_sql_profiler_plugin.mdx +++ b/product_docs/docs/pem/8.1.0/pem_sqlprofiler/01_installing_the_sql_profiler_plugin.mdx @@ -111,4 +111,5 @@ Use the following steps to enable the plugin: - Select `Open trace`… to open an existing trace. - Select `Delete trace(s)`… to delete one or more traces. - Select `View scheduled trace(s)`… to review a list of scheduled traces. -![Screen Shot 2021-05-06 at 4 58 23 PM](https://user-images.githubusercontent.com/5795880/117365029-b1687700-ae8c-11eb-850e-aa51c69abc54.png) + + ![Screen Shot 2021-05-06 at 4 58 23 PM](https://user-images.githubusercontent.com/5795880/117365029-b1687700-ae8c-11eb-850e-aa51c69abc54.png) diff --git a/product_docs/docs/pem/8.1.0/pem_upgrade/02_upgrading_backend_database.mdx b/product_docs/docs/pem/8.1.0/pem_upgrade/02_upgrading_backend_database.mdx index 051ed317956..02768848dcc 100644 --- a/product_docs/docs/pem/8.1.0/pem_upgrade/02_upgrading_backend_database.mdx +++ b/product_docs/docs/pem/8.1.0/pem_upgrade/02_upgrading_backend_database.mdx @@ -12,7 +12,7 @@ The update process described in this section uses the `pg_upgrade` utility to mi !!! 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_upgrade`: - - 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, hence to replace those dataypes with `timestamptz` data type use below command: ```text DO @@ -40,7 +40,7 @@ The update process described in this section uses the `pg_upgrade` utility to mi $$ LANGUAGE ‘plpgsql’; ``` - - Replace the below function to avoid any alert errors: + - Replace the below function to avoid any alert errors: ```text CREATE OR REPLACE FUNCTION pem.check_alert_params_array_size( diff --git a/product_docs/docs/pem/8.1.0/pem_upgrade/03_moving_pem_server.mdx b/product_docs/docs/pem/8.1.0/pem_upgrade/03_moving_pem_server.mdx index fc0d1734201..08d851b4940 100644 --- a/product_docs/docs/pem/8.1.0/pem_upgrade/03_moving_pem_server.mdx +++ b/product_docs/docs/pem/8.1.0/pem_upgrade/03_moving_pem_server.mdx @@ -62,13 +62,13 @@ Before starting the server migration, you should ensure that the firewalls betwe 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 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: ```text pg_dump -U > ``` - Where: + Where: - `` specifies the name of the database superuser for the PEM backend database. - `` specifies the name of the PEM backend database. @@ -80,83 +80,82 @@ Before starting the server migration, you should ensure that the firewalls betwe Note that invoking the `pg_dump` utility will not 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: - - - - 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: - - ```text - DO - $$ - DECLARE - rec record; - cnt integer; - BEGIN - -- Check for the deprecated type in our user info probe - SELECT count(*) INTO cnt - FROM pem.probe_column - WHERE sql_data_type = ‘abstime’ AND internal_name = ‘valuntil’; - IF cnt = 0 THEN - RETURN; - END IF; - ALTER TABLE pemdata.user_info - ALTER COLUMN valuntil SET DATA TYPE timestamptz; - ALTER TABLE pemhistory.user_info - ALTER COLUMN valuntil SET DATA TYPE timestamptz; - -- Now update the pem.probe_column itself - UPDATE pem.probe_column - SET sql_data_type = ‘timestamptz’ - WHERE sql_data_type = ‘abstime’ AND internal_name = ‘valuntil’; - END; - $$ LANGUAGE ‘plpgsql’; - ``` - - - Replace the below function to avoid any alert errors: - - ```text - CREATE OR REPLACE FUNCTION pem.check_alert_params_array_size( - template_id pem.alert_template.id%type, params text[] - ) - RETURNS bool AS $FUNC$ - DECLARE - res bool := TRUE; - BEGIN - /* - * During restoring the pem database, it does not maintain the order while - * inserting data in the table, and uses the sort table based on the - * names. - * Hence - we need to check the foreign key constraint is present before - * validating these values. - */ - IF EXISTS( - SELECT 1 FROM information_schema.table_constraints - WHERE constraint_name='alert_template_id_fkey' AND - table_name='alert' AND table_schema='pem' - ) THEN - /* - * Need to use the IS TRUE construct outside the main query, because - * otherwise if there's no template by that ID then the query would return - * 0 rows and the result of the function would be undefined and CHECK - * constraint would succeed. - * Probably this is being over-cautious, because pem.alert.template_id - * references pem.alert_template.id. But the SQL standard (probably) does - * not define the order in which the CHECK or the FOREIGN KEY constraints - * should be validated; in case CHECK is validated first, we want it to - * fail. - */ - EXECUTE $SQL$ - SELECT ( - SELECT pem.check_array_size_equal(t.param_names, $2) - FROM pem.alert_template AS t - WHERE id = $1 - ) IS TRUE - $SQL$ INTO res USING template_id, params; - END IF; - RETURN res; - END - $FUNC$ LANGUAGE 'plpgsql'; - ``` + !!! 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: + + - 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: + + ```text + DO + $$ + DECLARE + rec record; + cnt integer; + BEGIN + -- Check for the deprecated type in our user info probe + SELECT count(*) INTO cnt + FROM pem.probe_column + WHERE sql_data_type = ‘abstime’ AND internal_name = ‘valuntil’; + IF cnt = 0 THEN + RETURN; + END IF; + ALTER TABLE pemdata.user_info + ALTER COLUMN valuntil SET DATA TYPE timestamptz; + ALTER TABLE pemhistory.user_info + ALTER COLUMN valuntil SET DATA TYPE timestamptz; + -- Now update the pem.probe_column itself + UPDATE pem.probe_column + SET sql_data_type = ‘timestamptz’ + WHERE sql_data_type = ‘abstime’ AND internal_name = ‘valuntil’; + END; + $$ LANGUAGE ‘plpgsql’; + ``` + + - Replace the below function to avoid any alert errors: + + ```text + CREATE OR REPLACE FUNCTION pem.check_alert_params_array_size( + template_id pem.alert_template.id%type, params text[] + ) + RETURNS bool AS $FUNC$ + DECLARE + res bool := TRUE; + BEGIN + /* + * During restoring the pem database, it does not maintain the order while + * inserting data in the table, and uses the sort table based on the + * names. + * Hence - we need to check the foreign key constraint is present before + * validating these values. + */ + IF EXISTS( + SELECT 1 FROM information_schema.table_constraints + WHERE constraint_name='alert_template_id_fkey' AND + table_name='alert' AND table_schema='pem' + ) THEN + /* + * Need to use the IS TRUE construct outside the main query, because + * otherwise if there's no template by that ID then the query would return + * 0 rows and the result of the function would be undefined and CHECK + * constraint would succeed. + * Probably this is being over-cautious, because pem.alert.template_id + * references pem.alert_template.id. But the SQL standard (probably) does + * not define the order in which the CHECK or the FOREIGN KEY constraints + * should be validated; in case CHECK is validated first, we want it to + * fail. + */ + EXECUTE $SQL$ + SELECT ( + SELECT pem.check_array_size_equal(t.param_names, $2) + FROM pem.alert_template AS t + WHERE id = $1 + ) IS TRUE + $SQL$ INTO res USING template_id, params; + END IF; + RETURN res; + END + $FUNC$ LANGUAGE 'plpgsql'; + ``` 5. Move the Backup to the Target Host From 8ebc91d652580ff9d171a2b1a95965d847e3f7fd Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Tue, 15 Jun 2021 18:22:16 +0000 Subject: [PATCH 3/4] Move image ref out of github Former-commit-id: 926a189d73d11ba7efec7f061943de635d06aead --- product_docs/docs/pem/8.1.0/images/sql_profiler.png | 3 +++ .../pem_sqlprofiler/01_installing_the_sql_profiler_plugin.mdx | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/pem/8.1.0/images/sql_profiler.png diff --git a/product_docs/docs/pem/8.1.0/images/sql_profiler.png b/product_docs/docs/pem/8.1.0/images/sql_profiler.png new file mode 100644 index 00000000000..9f73162b2bd --- /dev/null +++ b/product_docs/docs/pem/8.1.0/images/sql_profiler.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:71cc250c5792724d9e31784cc66786162da0fe37799494acb5d56ac0da1e9109 +size 71793 diff --git a/product_docs/docs/pem/8.1.0/pem_sqlprofiler/01_installing_the_sql_profiler_plugin.mdx b/product_docs/docs/pem/8.1.0/pem_sqlprofiler/01_installing_the_sql_profiler_plugin.mdx index 71496c7377f..725b3ce1791 100644 --- a/product_docs/docs/pem/8.1.0/pem_sqlprofiler/01_installing_the_sql_profiler_plugin.mdx +++ b/product_docs/docs/pem/8.1.0/pem_sqlprofiler/01_installing_the_sql_profiler_plugin.mdx @@ -112,4 +112,4 @@ Use the following steps to enable the plugin: - Select `Delete trace(s)`… to delete one or more traces. - Select `View scheduled trace(s)`… to review a list of scheduled traces. - ![Screen Shot 2021-05-06 at 4 58 23 PM](https://user-images.githubusercontent.com/5795880/117365029-b1687700-ae8c-11eb-850e-aa51c69abc54.png) + ![Server -> SQL Profiler menu](../images/sql_profiler.png) From 62805ace9caf1af381cf06d2ea4d5f98f4765c9f Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Tue, 15 Jun 2021 19:05:27 +0000 Subject: [PATCH 4/4] partial ToC rewrites Former-commit-id: 1b5d7d34e762fcde5281b4f16cadca9f80a41f5f --- .../01_toc_pem_getting_started/index.mdx | 21 +++++---- .../02_toc_pem_agent/index.mdx | 18 ++++---- .../04_toc_pem_features/index.mdx | 46 +++++++++---------- .../05_toc_pem_management_basics/index.mdx | 32 +++++-------- .../06_toc_pem_bart_management/index.mdx | 23 ++++------ 5 files changed, 60 insertions(+), 80 deletions(-) diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/index.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/index.mdx index c596e78a3c0..fa67603be29 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/index.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/01_toc_pem_getting_started/index.mdx @@ -8,11 +8,10 @@ You can use either a graphical installer or an RPM package to install the PEM se Contents: -
- -pem_architecture pem_server_logon pem_managing_configuration_settings pem_roles - -
+- [PEM Architecture](01_pem_architecture) +- [PEM Server Logon](02_pem_server_logon) +- [Managing Configuration Settings](03_pem_managing_configuration_settings) +- [Roles for managing PEM](04_pem_roles) Each `server` in the PEM client tree control defines a set of connection and authentication properties that creates a connection to a Database server. The server can optionally bind the server to a PEM agent, defining a `managed` server, or not specify an agent binding, defining an `unmanaged` server. The process of defining the connection to a server is referred to as registering a server. You can use the `Auto Discovery` dialog to simplify the process of registering a managed server, or register a server manually. @@ -20,8 +19,10 @@ You can (optionally) use the `Server Group` dialog to create server groups to or Contents: -
- -group_dialog auto_discovery_dialog pem_define_connection pem_define_aws_instance_connection pem_connect_to_server control_server connect_error - -
+- [The Group Dialog](05_group_dialog) +- [Automatic Discovery of Servers](06_auto_discovery_dialog) +- [Defining a server](07_pem_define_connection) +- [Defining and Monitoring Postgres instances on AWS](08_pem_define_aws_instance_connection) +- [Connect to server](09_pem_connect_to_server) +- [Controlling a Server](10_control_server) +- [Connection error](11_connect_error) diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/index.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/index.mdx index f62a609ec08..e55eed84af1 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/index.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/02_toc_pem_agent/index.mdx @@ -8,16 +8,14 @@ The PEM agent is responsible for implementing scheduled tasks on the PEM server Contents: -
- -pem_agent_properties pem_agent_binding pem_agent_start_pem_agent pem_agent_ha - -
+- [PEM Agent Properties](01_pem_agent_properties) +- [Binding an Agent to a Server](02_pem_agent_binding) +- [Controlling the PEM Agent](03_pem_agent_start_pem_agent) +- [High Availability Integration](04_pem_agent_ha) The PEM agent has a number of configuration parameters that control agent behaviors and enable PEM functionality. For a list of the parameters, see: -
- -pem_agent_privileges pem_agent_config_params pem_agent_self_registration pem_agent_server_registration - -
+- [PEM Agent Privileges](05_pem_agent_privileges) +- [PEM Agent Configuration Parameters](06_pem_agent_config_params) +- [PEM Agent Self Registration](07_pem_agent_self_registration) +- [Register/Unregister database server using PEM Agent](08_pem_agent_server_registration) diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/index.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/index.mdx index c1c62297279..241de698740 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/index.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/04_toc_pem_features/index.mdx @@ -8,48 +8,44 @@ Postgres Enterprise Manager offers a number of additional enterprise management Contents: -
- -dashboards pem_server_config - -
+- [Dashboards](01_dashboards) +- [Server Configuration](02_pem_server_config) PEM configuration wizards simplify the process of configuring logging; after logs are gathered, you can use PEM features like the PEM Log Analysis Expert and Tuning Wizard to help you skillfully analyze log file contents. Postgres Expert analyses server configuration, and recommends changes that may improve performance, security, or reliability. Capacity Manager uses statistical data to analyze historical usage, and extrapolate future usage statistics for monitored objects. Contents: -
- -log_manager audit_manager pem_log_analysis_expert tuning_wizard pem_postgres_expert capacity_manager - -
+- [Log Manager](03_log_manager) +- [Audit Manager](04_audit_manager) +- [Postgres Log Analysis Expert](05_pem_log_analysis_expert) +- [Tuning Wizard](06_tuning_wizard) +- [Postgres Expert](07_pem_postgres_expert) +- [Capacity Manager](08_capacity_manager) PEM is highly customizable. You can modify system-defined alerts, or create custom alerts that notify a responsible administrator or group during a specific time period. PEM charts and dashboards are designed to provide an at-a-glance overview of the state of your systems, but you can design custom charts that display the most useful combinations of metric data returned by PEM probes. Then, create custom dashboards with details that `you` need to identify problems, plan for resource usage, or diagnose unique performance issues. Contents: -
- -pem_alerting pem_manage_charts pem_manage_dashboards pem_manage_probes - -
+- [Alerting](09_pem_alerting) +- [Using the Manage Charts Tab](10_pem_manage_charts) +- [The PEM Manage Dashboards Tab](11_pem_manage_dashboards) +- [The Manage Probes Tab](12_pem_manage_probes) PEM can schedule jobs on monitored servers. you can use the wizards to schedule the setup to occur at a time when server usage is low, or when a system restart won't interrupt your users. The Scheduled Task tab provides an overview of all the tasks that are pending execution or that have recently completed on your servers. Performance diagnostic feature helps you analyze the database performance for Advanced Server instances by monitoring the wait events. Contents: -
- -pem_alert_blackout pem_scheduled_system_jobs pem_scheduled_task_tab pem_scheduled_jobs pem_job_notification pem_task_view monitoring_a_failover_manager_cluster performance_diagnostic - -
+- [Schedule Alert Blackout](13_pem_alert_blackout) +- [Scheduled System Jobs](14_pem_scheduled_system_jobs) +- [Scheduled Task Tab](15_pem_scheduled_task_tab) +- [Creating a PEM Scheduled Job](16_pem_scheduled_jobs) +- [Sending email notifications for a job](17_pem_job_notification) +- [Task Viewer](18_pem_task_view) +- [Monitoring a Failover Manager Cluster](19_monitoring_a_failover_manager_cluster) +- [Performance Diagnostic](20_performance_diagnostic) PEM can generate system configuration and core usage reports of locally or remotely monitored servers in HTML as well as in JSON format. Contents: -
- -reports - -
+- [Reports](21_reports) diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/index.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/index.mdx index a984ba3f5d3..896136d6bc6 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/index.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/05_toc_pem_management_basics/index.mdx @@ -10,38 +10,30 @@ The Grant Wizard simplifies the task of privilege management; to open the Grant Contents: -
- -grant_wizard - -
+- [Grant Wizard](01_grant_wizard) PEM provides an easy to use environment in which to manage restore points, import/export tasks, and organize vacuum/analyze management. Contents: -
- -add_restore_point_dialog import_export_data maintenance storage_manager - -
+- [Add named restore point Dialog](02_add_restore_point_dialog) +- [Import/Export data Dialog](03_import_export_data) +- [Maintain a database object](04_maintenance) +- [Storage Manager](05_storage_manager) A powerful, but user-friendly interface provides an easy way to use take backups and create copies of databases or database objects. Contents: -
- -backup_dialog backup_globals_dialog backup_server_dialog restore_dialog - -
+- [Backup Dialog](06_backup_dialog) +- [Backup Globals Dialog](07_backup_globals_dialog) +- [Backup Server Dialog](08_backup_server_dialog) +- [Restore Dialog](09_restore_dialog) You can also use the client to manage objects that reside on managed and unmanaged database servers: Contents: -
- -managing_cluster_objects managing_database_objects modifying_tables - -
+- [Managing Cluster Level Objects](10_managing_cluster_objects) +- [Managing Database Objects](11_managing_database_objects) +- [Creating or Modifying a Table](12_modifying_tables) diff --git a/product_docs/docs/pem/8.1.0/pem_online_help/06_toc_pem_bart_management/index.mdx b/product_docs/docs/pem/8.1.0/pem_online_help/06_toc_pem_bart_management/index.mdx index 49150cbf9a7..69ce6d7a67e 100644 --- a/product_docs/docs/pem/8.1.0/pem_online_help/06_toc_pem_bart_management/index.mdx +++ b/product_docs/docs/pem/8.1.0/pem_online_help/06_toc_pem_bart_management/index.mdx @@ -14,24 +14,17 @@ From PEM version 7.10 onwards, you can manage a BART server through PEM console. Before you manage a BART server through PEM console, you must ensure that your system meets certain requirements. For more information, see: -
- -managing_bart_prerequisites - -
+- [Prerequisites for managing BART](01_managing_bart_prerequisites) You must add a BART server to the PEM console and then associate that BART server with the database server whose backup you want to manage with BART. For more information, see: -
- -configuring_bart_server associating_bart_server_with_database_server - -
+- [Configuring a BART Server](02_configuring_bart_server) +- [Associating the BART Server with a Database Server](03_associating_bart_server_with_database_server) After you associate the BART server with the database server, you will be able to view the details of the backups in the dashboard. You can perform operations such as scheduling a backup or restoring a backup. For more information, see: -
- -viewing_bart_dashboard scheduling_bart_backups scheduling_bart_obsolete_backups_deletion bart_backup_dialog restoring_bart_backups - -
+- [Viewing the BART Server Details on a PEM Dashboard](04_viewing_bart_dashboard) +- [Scheduling BART Backups](05_scheduling_bart_backups) +- [Scheduling BART Obsolete Backups Deletion](06_scheduling_bart_obsolete_backups_deletion) +- [BART Backup Dialog](07_bart_backup_dialog) +- [Restoring BART Backups](08_restoring_bart_backups)