Skip to content

Commit baca035

Browse files
Merge pull request #1018 from EnterpriseDB/content/pem/8.0.1/pem_online_help
Content/pem/8.0.1/pem online help Former-commit-id: f30638c
2 parents bf961eb + 6617a8a commit baca035

File tree

223 files changed

+3891
-3178
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

223 files changed

+3891
-3178
lines changed

product_docs/docs/pem/8.0.1/index.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22
title: "EDB Postgres Enterprise Manager"
33
directoryDefaults:
44
description: "EDB Postgres Enterprise Manager Version 8 Documentation and release notes. PostgreSQL GUI tool for monitoring and performance optimization."
5+
navigation:
6+
- "#Getting Started"
7+
- pem_inst_guide_linux
8+
- pem_pgbouncer
9+
- pem_upgrade
10+
- pem_inst_guide_windows
11+
- "#Guides"
12+
- pem_admin
13+
- pem_agent
14+
- pem_bart
15+
- pem_ent_feat
16+
- pem_security_best_practices
17+
- pem_sqlprofiler
18+
- "#Online Help"
19+
- pem_online_help
520
---
621

722
Welcome to Postgres Enterprise Manager (PEM). Postgres Enterprise Manager (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.

product_docs/docs/pem/8.0.1/pem_online_help/01_toc_pem_getting_started/01_pem_architecture.mdx

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,23 @@
22
title: "PEM Architecture"
33
---
44

5+
<div id="pem_architecture" class="registered_link"></div>
6+
7+
58
Postgres Enterprise Manager (PEM) is a tool designed to monitor and manage multiple Postgres servers through a single GUI interface. PEM is capable of monitoring the following areas of the infrastructure:
69

7-
!!! Note
8-
The term Postgres refers to either PostgreSQL or EDB Postgres Advanced Server.
10+
Note: The term Postgres refers to either PostgreSQL or EDB Postgres Advanced Server.
911

1012
- **Hosts** - One or more servers (physical or virtual) and their operating systems.
11-
1213
- **Servers** - One or more instances of PostgreSQL or EDB Postgres Advanced Server running on a host.
13-
1414
- **Databases** - One or more databases and the schema objects (tables, indexes, etc.) within them.
1515

1616
PEM consists of a number of individual software components; the individual components are described below.
1717

1818
- **PEM Server** - The PEM Server is used as the data repository for monitoring data and as a server to which both Agents and Clients connect. The PEM server consists of an instance of PostgreSQL and an associated database for storage of monitoring data, and a server that provides web services.
19-
2019
- **PEM Agent** - The PEM Agent is responsible for executing tasks and reporting statistics from the Agent host and monitored Postgres instances to the PEM server. A single PEM Agent can monitor multiple installed instances of Postgres that reside on one or many hosts.
21-
2220
- **PEM Web Client** - The PEM web interface allows you to manage and monitor Postgres servers and utilize PEM extended functionality. The web interface software is installed with the PEM server and is accessed via any supported web browser.
23-
24-
- **SQL Profiler** - SQL Profiler is a Postgres server plugin to record the monitoring data and query plans to be analysed by the SQL Profiler tool in PEM. This is an optional component of PEM, but the plugin must be installed into each instance of Postgres with which you wish to use the SQL Profiler tool. The SQL Profiler may be used with any supported version of an EnterpriseDB distribution of a PostgreSQL server or Advanced Server (not just those managed through the PEM server). See the [PEM SQL Profiler Configuration Guide](/pem/latest/) for details and supported versions.
21+
- **SQL Profiler** - SQL Profiler is a Postgres server plugin to record the monitoring data and query plans to be analysed by the SQL Profiler tool in PEM. This is an optional component of PEM, but the plugin must be installed into each instance of Postgres with which you wish to use the SQL Profiler tool. The SQL Profiler may be used with any supported version of an EnterpriseDB distribution of a PostgreSQL server or Advanced Server (not just those managed through the PEM server). See the [PEM SQL Profiler Configuration Guide](https://www.enterprisedb.com/edb-docs/p/edb-postgres-enterprise-manager) for details and supported versions.
2522

2623
**PEM architecture**
2724

@@ -38,33 +35,19 @@ The PEM server consists of an instance of Postgres, an instance of the Apache we
3835
The instance of Postgres (a database server) and an instance of the Apache web-server ( HTTPD) can be on the same host or on separate hosts.
3936

4037
- **Postgres Instance (Database server)** - This is the backend database server. It hosts a database named **pem** which acts as the repository for PEM Server. The **pem** database contains several schemas that store metric data collected from each monitored host, server, and database.
41-
4238
- **pem** - This schema is the core of the PEM application. It contains the definitions of configuration functions, tables, or views required by the application.
43-
4439
- **pemdata** - This schema stores the current snapshot of the monitored data.
45-
4640
- **pemhistory** - This schema stores the historical monitored data.
47-
4841
- **Apache Web Server (HTTPD)** - The PEM Web Application is deployed as a WSGI application with HTTPD to provide web services to the client. It is comprised of the following:
49-
5042
- **Web content presentation** - The presentation layer is created by the Web Application (for example Browser, login page,..).
51-
5243
- **Rest API** - The REST API allows integration with other apps and services.
53-
5444
- **Database Server Administration/Management** - Database server administration and management activities like CREATE, ALTER, DROP, etc. can be performed for managed as well as unmanaged servers.
55-
5645
- **Dashboard/Chart generation** - Internally, the web application includes functionality that generates Dashboards and Charts.
57-
5846
- **Management Tools** - The Audit Manager, Capacity Manager, Log Manager, Postgres Expert, Postgres Log Analysis Expert, and the Tuning Wizard are made available in the Web Application.
59-
6047
- Other tools provide functionality on managed or unmanaged servers:
61-
6248
- **SQL Profiler UI Integration** - SQL Profiler generates easily analyzed traces of session content.
63-
6449
- **Query Editor/Data View** - The Query editor allows you to query, edit, and view data.
65-
6650
- **Debugger** - The Debugger helps you debug queries.
67-
6851
- **Performance Diagnostics** - Performance Diagnostics help you analyze the performance of Advanced Server.
6952

7053
We recommended that you use a dedicated machine to host production instances of the PEM backend database. The host may be subject to high levels of data throughput, depending on the number of database servers that are being monitored and the workloads the servers are processing.
@@ -92,7 +75,7 @@ Once configured, each agent collects statistics and other information on the hos
9275
- Table access statistics
9376
- Table and index sizes
9477

95-
A list of PEM probes can be found [here](../04_toc_pem_features/12_pem_manage_probes/03_pem_probe_config/01_pem_probes/#pem_probes).
78+
A list of PEM probes can be found [here](../04_toc_pem_features/12_pem_manage_probes/03_pem_probe_config/#pem_probes).
9679

9780
By default, the PEM Agent bound to the database server collects the OS/Database monitoring statistics and also runs any scheduled tasks/jobs for that particular database server, storing data in the pem database on the PEM server.
9881

@@ -110,8 +93,8 @@ The client allows you to use PEM functionality that makes use of the data logged
11093

11194
You are not required to install the SQL Profiler plugin on every server, but you must install and configure the plugin on each server on which you wish to use the SQL Profiler. You may also want to install and configure SQL Profiler on un-monitored development servers. For ad-hoc use also, you may temporarily install the SQL Profiler plugin.
11295

113-
The plugin is installed with the EDB Postgres Advanced Server distribution but must be installed separately for use with PostgreSQL. The SQL Profiler installer is available from the [EnterpriseDB website](https://www.enterprisedb.com/downloads/edb-postgres-enterprise-manager).
96+
The plugin is installed with the EDB Postgres Advanced Server distribution but must be installed separately for use with PostgreSQL. The SQL Profiler installer is available from the [EnterpriseDB website](http://www.enterprisedb.com/download-postgres-enterprise-manager).
11497

11598
SQL Profiler may be used on servers that are not managed through PEM, but to perform scheduled traces, a server must have the plugin installed, and must be managed by an installed and configured PEM agent.
11699

117-
For more information about using SQL Profiler, see the [PEM SQL Profiler Configuration Guide](/pem/latest/)
100+
For more information about using SQL Profiler, see the [PEM SQL Profiler Configuration Guide](https://www.enterprisedb.com/edb-docs/p/edb-postgres-enterprise-manager)

product_docs/docs/pem/8.0.1/pem_online_help/01_toc_pem_getting_started/02_pem_server_logon.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22
title: "PEM Server Logon"
33
---
44

5+
<div id="pem_server_logon" class="registered_link"></div>
6+
7+
58
The PEM web interface uses Apache to connect to the PEM server on port 8080 of the IP address on which the PEM server is installed. To connect to PEM, open your browser of choice, and navigate to:
69

7-
`<ip_address_of_PEM_host>:8080/pem`
10+
> *&lt;ip\_address\_of\_PEM\_host&gt;:8080/pem*
811
912
Where `ip_address_of_PEM_host` specifies the IP address of the host of the PEM server.
1013

@@ -17,12 +20,9 @@ Use the fields on the Login window to authenticate yourself with the PEM server:
1720
We strongly recommend you create an individual role for each user. You can create a login role with the `CREATE ROLE` SQL statement, or by defining a role with the PEM client `Create - Login/Group Role` dialog. To access the dialog, connect to the PEM server database; right-click the `Login/Group Roles` node in the tree control, and select `New Login Role...` from the `Create` pull-aside menu. Roles must be granted permissions and role memberships to properly use PEM:
1821

1922
- users that are members of the `pem_user` role are essentially `read-only` users; they may view dashboards, change the database server connection options, but they will not be able to install agents or configure the server directory, alerts, probes, or run any of the wizard/dialog based components of PEM.
20-
21-
- users that are members of the `pem_admin` role have the same read permissions as members of the pem_user role, plus sufficient privileges to configure the servers, directory, alerts and probes.
22-
23-
- `administrative` users must be added to the pem_admin role and explicitly granted the create role privilege. in addition to the permissions granted through membership in the pem_admin role, the create role privilege allows an administrator to create additional pem users, and to install and register new agents.
24-
25-
- users can be member of one of the [PEM roles](04_pem_roles/#pem_roles) to give right to run a particular component, to manage, or to configure PEM.
23+
- users that are members of the `pem_admin` role have the same read permissions as members of the pem\_user role, plus sufficient privileges to configure the servers, directory, alerts and probes.
24+
- `administrative` users must be added to the pem\_admin role and explicitly granted the create role privilege. in addition to the permissions granted through membership in the pem\_admin role, the create role privilege allows an administrator to create additional pem users, and to install and register new agents.
25+
- users can be member of one of the [PEM roles](../01_toc_pem_getting_started/#pem_roles) to give right to run a particular component, to manage, or to configure PEM.
2626

2727
- Provide the password associated with the user in the `Password` field.
2828

product_docs/docs/pem/8.0.1/pem_online_help/01_toc_pem_getting_started/03_pem_managing_configuration_settings.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: "Managing Configuration Settings"
33
---
44

5+
<div id="pem_managing_configuration_settings" class="registered_link"></div>
6+
7+
58
There are multiple configuration files that are read at startup by Postgres Enterprise Manager. These are as follows:
69

710
- `config.py`: This is the main configuration file, and should not be modified. It can be used as a reference for configuration settings, that may be overridden in one of the following files.
@@ -10,4 +13,8 @@ There are multiple configuration files that are read at startup by Postgres Ente
1013

1114
The default `config.py` file is shown below for reference:
1215

16+
<div class="literalinclude" language="python">
17+
1318
../../web/config.py
19+
20+
</div>

0 commit comments

Comments
 (0)