Postgres Enterprise Manager

Welcome to Postgres Enterprise Manager (PEM). PEM consists of components that provide the management and analytical functionality for your EDB Postgres Advanced Server or PostgreSQL database. PEM is based on the Open Source pgAdmin 4 project.

• Introduction
  • Postgres compatibility
• Postgres Enterprise Manager release notes
  • Postgres Enterprise Manager 10.4.1 release notes
    • Security Fixes
    • Bug Fixes
  • Postgres Enterprise Manager 10.4.0 release notes
    • Highlights
    • Enhancements
    • Changes
    • Bug Fixes
  • Postgres Enterprise Manager 10.3.1 release notes
    • Changes
    • Bug Fixes
  • Postgres Enterprise Manager 10.3.0 release notes
    • Highlights
    • Enhancements
    • Changes
    • Bug Fixes
  • Postgres Enterprise Manager 10.2.0 release notes
    • Highlights
    • Enhancements
    • Changes
    • Bug Fixes
  • Postgres Enterprise Manager 10.1.2 release notes
  • Postgres Enterprise Manager 10.1.1 release notes
    • Bug Fixes
  • Postgres Enterprise Manager 10.1.0 release notes
    • Highlights
    • Enhancements
    • Changes
    • Bug Fixes
  • Postgres Enterprise Manager 10.0.0 release notes
    • Highlights
    • Enhancements
    • Changes
    • Bug Fixes
• Platform compatibility
• Hardware requirements for installing the PEM server on Linux
• Understanding Postgres Enterprise Manager components and architecture
  • PEM architecture
    • PEM server
    • PEM agent
    • PEM web application
    • SQL Profiler extension
• Deployment considerations
  • How PEM licensing works
    • Licensing rules
    • Examples
  • PEM server and agent connection management mechanism
    • Without PgBouncer
    • With PgBouncer
  • Authentication options
    • 1. Two-factor authentication (2FA)
    • 2. Kerberos authentication
  • Deciding on an SSL model
    • Certificate management models
  • Securing your deployment
    • Web server security configuration
    • PEM application security configurations
  • Web server installation options
    • PEM server and web server on separate hosts
    • PEM server and web server on the same host
  • Sizing PEM deployments
    • Factors affecting resource requirements
    • PEM t-shirt sizing
  • High availability patterns for PEM deployment
    • Running multiple instances of the PEM backend database
    • Running multiple PEM web application instances
    • Upgrading an HA PEM deployment
    • Load balancers, proxies, and VIPs
    • Reference architectures
• Installing Postgres Enterprise Manager server
  • Linux x86-64 (amd64)
    • Red Hat Enterprise Linux (RHEL) and derivatives
    • SUSE Linux Enterprise (SLES)
    • Debian and derivatives
  • Linux Installing Postgres Enterprise Manager server on Linux IBM Power (ppc64le)
    • Red Hat Enterprise Linux (RHEL) and derivatives
    • SUSE Linux Enterprise (SLES)
  • Linux Installing Postgres Enterprise Manager server on Linux AArch64 (ARM64)
    • Red Hat Enterprise Linux (RHEL) and derivatives
    • Debian and derivatives
  • Windows
    • Dependencies of the PEM Server and Agent on Linux
    • Installing Postgres Enterprise Manager server on Linux x86 (amd64)
    • Installing Postgres Enterprise Manager server on Linux AArch64 (ARM64)
    • Installing Postgres Enterprise Manager server on Linux IBM Power (ppc64le)
    • Installing Postgres Enterprise Manager server on Windows
    • Creating an EDB repository on an isolated network
    • Configuring the PEM server on Linux
    • Installing Postgres Enterprise Manager in HA Patterns
• Installing Postgres Enterprise Manager agent
  • Linux x86-64 (amd64)
    • Red Hat Enterprise Linux (RHEL) and derivatives
    • SUSE Linux Enterprise (SLES)
    • Debian and derivatives
  • Linux Installing Postgres Enterprise Manager server on Linux IBM Power (ppc64le)
    • Red Hat Enterprise Linux (RHEL) and derivatives
    • SUSE Linux Enterprise (SLES)
  • Linux Installing Postgres Enterprise Manager server on Linux AArch64 (ARM64)
    • Red Hat Enterprise Linux (RHEL) and derivatives
    • Debian and derivatives
  • Windows
    • Installing Postgres Enterprise Manager agent on Linux x86 (amd64)
    • Installing Postgres Enterprise Manager agent on Linux AArch64 (ARM64)
    • Installing Postgres Enterprise Manager agent on Linux IBM Power (ppc64le)
    • Installing Postgres Enterprise Manager agent on Windows
• Configuring user authentication in PEM
  • Configuring the PEM server to use two-factor authentication
    • Mail server configuration
  • Configuring the PEM server to use Kerberos authentication
    • 1. Install Kerberos, the PEM server, and the PEM backend database
    • 2. Add principals on Kerberos server
    • 3. Extract key tables from Kerberos server
    • 4. Configure the PEM backend database server
    • 5. Obtain and view the initial ticket
    • 6. Configure the PEM server
    • 7. Browser settings
  • Configuring the PEM server to use Windows Active Directory domain services for Kerberos authentication (SSPI)
    • 1. Install Active Directory, the PEM server, and the PEM backend database server
    • 2. Create users in Active Directory to map with service principals
    • 3. Extract key tables from Active Directory
    • 4. Configure the PEM backend database server
    • 5. Obtain and view the initial ticket
    • 6. Configure the PEM server
    • 7. Browser settings
• Connection pooling using PgBouncer
  • Preparing the PEM database server
    • Prerequisites
    • Creating users and roles for PgBouncer-PEM connections
    • Updating the configuration files to allow PgBouncer-PEM connections
    • Creating the SSL key and certificate for PgBouncer-PEM authentication
  • Configuring PgBouncer
    • Prerequisites
    • Configuring PgBouncer
  • Configuring the PEM agent
    • Prerequisites
    • Configuring a new PEM agent
    • Configuring an existing PEM agent
• Upgrade and migration
  • Upgrading a PEM installation
    • Upgrading a PEM installation on a Linux host
    • Upgrading a PEM installation on a Windows host
    • Upgrading an HA PEM installation
  • Upgrading the PEM backend Postgres database
  • Adding entries for PEM Agens and admins to connect to PEM server
  • Adding entries (localhost) for PEM Agens and admins to connect to PEM server
  • Upgrading SQL Profiler
  • Upgrading the PEM web server
    • Upgrading the web server on Linux
    • Upgrading PEM-HTTPD on Windows
  • Moving the PEM server
    • If the PEM agent resides on Linux
    • If the PEM agent resides on Windows
• Splitting an existing PEM server
  • Install PEM on the new host
  • Copy all data from your existing PEM instance
  • Update the pg_hba.conf file on the new PEM instance
  • Configure SSL on the new server and reconfigure PEM agents
    • Approach 1 – Reuse certificates from the existing PEM instance
    • Approach 2 – Use different server certificates but the same CA
    • Approach 3 – Replace all server and agent certificates
    • Approach 4 – Use only certificates from an external CA
  • Disable disconnected agents on each PEM instance
  • Validate your PEM instances
• Uninstalling
  • Uninstalling Postgres Enterprise Manager components on Linux
    • Uninstalling PEM components from RHEL or Rocky Linux or AlmaLinux hosts
    • Uninstalling PEM components from Debian or Ubuntu hosts
    • Uninstalling PEM components from SLES hosts
  • Uninstalling Postgres Enterprise Manager components on Windows
• Troubleshooting
  • Known installation and configuration issues
    • Conflict with existing mod_wsgi
    • Errors from JIT
    • Crash due to bug in RHEL Python 3.9 standard library
    • Blocking TRACK/TRACE Methods in Apache HTTPD
  • Reconfiguring the PEM server
  • PEM web application not loading
  • Error connecting to PostgreSQL server
  • PEM web server connectivity check
  • SQL Error - column “ssl” of relation “server” does not exist
  • SSL Error - Incomplete sslutils upgrade
  • Nginx SSL_read() failure errors
• Changing the default port
  • For RHEL
    • Modify the SELinux configuration
    • Configure the web server (NGINX)
    • Configure the web server (Apache HTTPD)
  • For Debian and Ubuntu
    • Configure the web server (NGINX)
    • Configure the web server (Apache HTTPD)
• Registering a PEM agent
  • How to register PEM agents
  • Registering a PEM agent using the pemworker utility
    • Linux
    • Windows
    • Authenticating the pemworker utility
    • Enable the PEM Agent service
    • Linux
    • Windows
  • Verifying PEM agent registration
    • Command syntax
    • Understanding exit codes
    • Usage examples
  • Unregistering a PEM agent
  • Advanced usage
    • Using connection strings
    • The registration connection string
    • The agent connection string
    • Setting the agent ID
    • Overriding default configurations - examples
    • Setting the agent ID
    • Providing an existing SSL certificate and key
    • Using a non-root user account to register a PEM agent on Linux
• Registering a Postgres server
  • What does registering a Postgres server do?
  • Using the pemworker utility to register a server
    • Specifying additional parameters for the pemworker connection
    • Examples
    • Using the pemworker utility to unregister a server
  • Registering a server with automatic server discovery
  • Manually registering a database server
  • Verifying the connection and binding
• Managing a PEM server
  • Starting and stopping the PEM server and agents
  • Controlling the PEM server or PEM agent on Linux
  • Controlling the PEM server or PEM agent on Windows
  • Controlling the web server on Linux
    • NGINX
    • Apache HTTPD
  • Controlling the web server on Windows
  • Managing PEM authentication
  • Editing the PEM server configuration
  • Managing security
    • Login roles
    • Group roles
    • Using PEM predefined roles to manage access to PEM functionality
    • Using a team role
    • Object permissions
  • Server configuration
  • Server configuration parameters - reference
• Managing Postgres servers
  • Starting and stopping monitored database servers
  • Modifying the pg_hba.conf file
  • Creating and maintaining databases and objects
  • Template Linux service script
• Managing a PEM agent
  • Managing job notifications
    • Configuring job notifications at job level
    • Configuring job notifications at agent level
    • Configuring job notifications at server level
  • Managing scheduled jobs
    • Provide general information about the job
    • Define the job steps
    • Define the job schedule
    • Configure the email notifications
  • Modifying agent configuration
    • Contents of the configuration file
    • Contents of the registry
    • About alert threads
  • Reviewing or modifying agent properties
  • Setting agent privileges
    • Root user versus non-root user
    • Functionality affected by limiting operating system privileges
    • Functionality affected by limiting database privileges
    • Error handling
• Managing SSL certificates
  • Web server certificates
    • Replace the web server certificates (NGINX)
    • Replace the web server certificates (Apache HTTPD)
  • PEM backend database server and agent connection certificates
    • Certificates and key files on the PEM server
    • Certificates and key files for PEM agents
    • PEM certificate renewal
  • Generate a common agent certificate and key pair
  • Use certificates and keys signed by trusted CA
    • Replace the server SSL certificates with certificates signed by a trusted CA
    • Replace the agent SSL certificates with certificates signed by a trusted CA
  • Testing certificates
    • Validate a certificate against the root certificate
    • Make a test connection to the PEM backend database
• Managing configuration settings
• Troubleshooting agent issues
  • Restoring a deleted PEM agent
  • Updating configuration file path (agent status displaying as unknown)
  • Using the command line to delete a PEM agent with down or unknown status
• Accessing the web interface
  • PEM client object browser
  • PEM tabbed browser window
  • Using chart, graph, and table controls
    • Personalizing a graphic
  • Browser toolbar
  • PEM menu bar
    • File menu
    • Object menu
    • Management menu
    • Dashboards menu
    • Tools menu
    • Help menu
  • Controlling and customizing charts, graphs, and tables
• Connecting and disconnecting a database server
  • Disconnecting from a server
• Monitoring performance
  • Probes
    • System probes
    • Customizing probes
  • Alerts
    • Viewing the alerts via Global dashboard
    • Viewing the alerts via Alerts dashboard
    • Customizing the Alerts dashboard
  • Managing monitoring settings using profiles
    • Purpose of using profiles
    • Key concepts
    • Accessing Manage Profiles
  • Notifications
    • SMTP
    • Webhooks
    • SNMP
    • Nagios
  • Capacity Manager
    • Capacity Manager templates
    • Capacity Manager metrics - reference
  • Audit Manager
    • Setting the EDB Postgres Advanced Server instance service ID
    • Setting the EDB Audit Configuration probe
    • Configuring audit logging with the Audit Manager
    • Viewing the log with the Audit Log dashboard
  • Log Manager
    • Reviewing the Server Log Analysis dashboard
  • Charts
    • Creating a custom chart
    • Importing a Capacity Manager template
  • Dashboards
    • Dashboards overview
    • Available dashboards
    • Dashboard configuration
    • Custom dashboards
  • Remote monitoring
• Monitoring Barman
  • Prerequisites for monitoring Barman
  • Configuring a Barman server
    • Using PEM web client
    • Configure
    • Editing
    • Using pemworker command line
  • Viewing the Barman server details on a PEM dashboard
• Monitoring EDB Postgres Distributed
• Monitoring Failover Manager
  • Replacing a primary node
  • Switchover EFM cluster
• Monitoring Replication Server
• Monitoring event history
• Tuning performance
  • Performance Diagnostic
    • Prerequisites
    • Using the Performance Diagnostic dashboard
• Profiling workloads
  • Installing the SQL Profiler extension
    • Installing the package
    • Enabling the extension
  • Using SQL Profiler
    • Permissions for SQL profiler
    • Creating a trace
    • Opening an existing trace
    • Filtering a trace
    • Deleting a trace
    • Viewing scheduled traces
• Reports
  • Custom report templates
  • Viewing system reports
    • Custom report templates
    • Viewing system reports
• PEM command line interface
  • Example
• EDB Postgres Enterprise Manager REST APIs v1.0.0
  • Token
    • TokenGeneration
    • Parameters
    • Responses
    • Response Schema
    • Response Headers
    • delete_token
    • Parameters
    • Responses
    • Response Schema
• Using the Query tool
  • The Query tool toolbar
  • The SQL editor panel
  • The Data Output panel
    • Data Output tab
    • Explain tab
    • Graphical tab
    • Analysis tab
    • Statistics tab
    • Messages tab
    • Notifications tab
  • Query History panel
  • Connection status
  • Macros
• Using the Schema Diff tool
  • Schema Diff Object Comparison panel
  • Schema Diff DDL Comparison panel
• Using the ERD tool
  • Toolbar
  • File options
  • Export options
  • Editing options
  • Table relationship options
  • Utility Options
  • Zoom options
  • Table dialog
  • Table node
  • One-to-many link dialog box
  • Many-to-many link dialog box
  • Table link
  • Table notes
• PL debugger
  • In-context debugging
  • Direct debugging
  • Using the debugger