Skip to content

Commit e96ca06

Browse files
robert-stringerrobert-stringer
authored
Merge pull request #1276 from EnterpriseDB/pem_7.16_agent_guide
Updated the content of PEM 7.16 Agent Guide Former-commit-id: 507bdde
2 parents 6fc6859 + 4925988 commit e96ca06

File tree

4 files changed

+21
-32
lines changed

4 files changed

+21
-32
lines changed

‎product_docs/docs/pem/7.16/pem_agent/01_pem_architecture.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ The instance of Postgres (a database server) and an instance of the Apache web-s
3838
- **pem** - This schema is the core of the PEM application. It contains the definitions of configuration functions, tables, or views required by the application.
3939
- **pemdata** - This schema stores the current snapshot of the monitored data.
4040
- **pemhistory** - This schema stores the historical monitored data.
41+
42+
4143
- **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:
4244
- **Web content presentation** - The presentation layer is created by the Web Application (for example Browser, login page,..).
4345
- **Rest API** - The REST API allows integration with other apps and services.

‎product_docs/docs/pem/7.16/pem_agent/02_registering_agent.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,12 @@ To use a non-root user account to register a PEM agent, you must first install t
7777

7878
```text
7979
./pemworker --register-agent --pem-server <172.19.11.230> --pem-user <postgres> --pem-port <5432> --display-name <non_root> --cert-path /home/<edb> --config-dir /home/<edb>
80+
```
8081

8182
The above command creates agent certificates and an agent configuration file (``agent.cfg``) in the ``/home/edb/.pem`` directory. Use the following command to assign read and write permissions to these files:
8283

83-
``chmod -R 600 /home/edb/.pem/agent*``
84+
```text
85+
chmod -R 600 /home/edb/.pem/agent*
8486
```
8587

8688
3. Change the parameters of the `agent.cfg` file:

‎product_docs/docs/pem/7.16/pem_agent/03_managing_pem_agent.mdx

Lines changed: 15 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Managing a PEM Agent"
33
---
44

5-
The sections that follow provide information about the behavior and management of a PEM agent.
5+
The following sections provide information about the behavior and management of a PEM agent.
66

77
## Agent Privileges
88

@@ -76,8 +76,6 @@ On Linux systems, PEM configuration options are stored in the `agent.cfg` file,
7676
| enable_smtp | When set to true for multiple PEM Agents (7.13 or lesser) it may send more duplicate emails. Whereas for PEM Agents (7.14 or higher) it may send lesser duplicate emails. | true for PEM server host; false for all others. |
7777
| enable_snmp | When set to true for multiple PEM Agents (7.13 or lesser) it may send more duplicate traps. Whereas for PEM Agents (7.14 or higher) it may send lesser duplicate traps. | true for PEM server host; false for all others. |
7878
| enable_nagios | When set to true, Nagios alerting is enabled. | true for PEM server host; false for all others. |
79-
| enable_webhook | When set to true, Webhook alerting is enabled. | true for PEM server host; false for all others. |
80-
| max_webhook_retries | Set maximum number of times pemAgent should retry to call webhooks on failure. | Default 3. |
8179
| connect_timeout | The max time in seconds (a decimal integer string) that the agent will wait for a connection. | Not set by default; set to 0 to indicate the agent should wait indefinitely. |
8280
| allow_server_restart | If set to TRUE, the agent can restart the database server that it monitors. Some PEM features may be enabled/disabled, depending on the value of this parameter. | False |
8381
| max_connections | The maximum number of probe connections used by the connection throttler. | 0 (an unlimited number) |
@@ -88,11 +86,6 @@ On Linux systems, PEM configuration options are stored in the `agent.cfg` file,
8886
| connection_custom_setup | Use to provide SQL code that will be invoked when a new connection with a monitored server is made. | Not set by default. |
8987
| ca_file | Provide the path where the CA certificate resides. | Not set by default. |
9088
| batch_script_user | Provide the name of the user that should be used for executing the batch/shell scripts. | None |
91-
| webhook_ssl_key | The complete path to the webhook's SSL client key file. | |
92-
| webhook_ssl_crt | The complete path to the webhook's SSL client certificate file. | |
93-
| webhook_ssl_crl | The complete path of the CRL file to validate webhook server certificate. | |
94-
| webhook_ssl_ca_crt | The complete path to the webhook's SSL ca certificate file. | |
95-
| allow_insecure_webhooks | When set to true, allow webhooks to call with insecure flag. | false |
9689

9790
On 64 bit Windows systems, PEM registry entries are located in:
9891

@@ -114,8 +107,6 @@ The registry contains the following entries:
114107
| AlertThreads | The number of alert threads to be spawned by the agent. | Set to 1 for the agent that resides on the host of the PEM server; 0 for all other agents. |
115108
| EnableSMTP | When set to true, the SMTP email feature is enabled. | true for PEM server host; false for all others. |
116109
| EnableSNMP | When set to true, the SNMP trap feature is enabled. | true for PEM server host; false for all others. |
117-
| EnableWebhook | When set to true, Webhook alerting is enabled. | true for PEM server host; false for all others. |
118-
| MaxWebhookRetries | Set maximum number of times pemAgent should retry to call webhooks on failure. | Default 3. |
119110
| ConnectTimeout | The max time in seconds (a decimal integer string) that the agent will wait for a connection. | Not set by default; if set to 0, the agent will wait indefinitely. |
120111
| AllowServerRestart | If set to TRUE, the agent can restart the database server that it monitors. Some PEM features may be enabled/disabled, depending on the value of this parameter. | true |
121112
| MaxConnections | The maximum number of probe connections used by the connection throttler. | 0 (an unlimited number) |
@@ -126,20 +117,13 @@ The registry contains the following entries:
126117
| ConnectionCustomSetup | Use to provide SQL code that will be invoked when a new connection with a monitored server is made. | Not set by default. |
127118
| ca_file | Provide the path where the CA certificate resides. | Not set by default. |
128119
| AllowBatchJobSteps | If set to true,the batch/shell scripts will be executed using Administrator user account. | None |
129-
| WebhookSSLKey | The complete path to the webhook's SSL client key file. | |
130-
| WebhookSSLCrt | The complete path to the webhook's SSL client certificate file. | |
131-
| WebhookSSLCrl | The complete path of the CRL file to validate webhook server certificate. | |
132-
| WebhookSSLCaCrt | The complete path to the webhook's SSL ca certificate file. | |
133-
| AllowInsecureWebhooks | When set to true, allow webhooks to call with insecure flag. | false |
134120

135121
## Agent Properties
136122

137123
The PEM Agent `Properties` dialog provides information about the PEM agent from which the dialog was opened; to open the dialog, right-click on an agent name in the PEM client tree control, and select `Properties` from the context menu.
138124

139125
![PEM Agent Properties dialog - General tab](../images/pem_agent_properties.png)
140126

141-
PEM Agent Properties dialog - General tab
142-
143127
Use fields on the PEM Agent `Properties` dialog to review or modify information about the PEM agent:
144128

145129
- The `Description` field displays a modifiable description of the PEM agent. This description is displayed in the tree control of the PEM client.
@@ -150,23 +134,24 @@ Use fields on the PEM Agent `Properties` dialog to review or modify information
150134

151135
- The `Heartbeat interval` fields display the length of time that will elapse between reports from the PEM agent to the PEM server. Use the selectors next to the `Minutes` or `Seconds` fields to modify the interval.
152136

153-
![PEM Agent Properties dialog - Job Notifications tab](../images/pem_agent_job_notification_properties.png)
137+
![PEM Agent Properties dialog - Job Notifications tab](../images/pem_agent_job_notification_properties.png)
154138

155-
PEM Agent Properties dialog - Job Notifications tab
139+
Use the fields on the `Job Notifications` tab to configure the email notification settings on agent level:
156140

157-
Use the fields on the `Job Notifications` tab to configure the email notification settings on agent level:
141+
- Use the `Override default configuration?` switch to specify if you want the agent level job notification settings to override the default job notification settings. If you select `Yes` for this switch, you can use the rest of the settings on this dialog to define when and to whom the job notifications should be sent. Please note that the rest of the settings on this dialog work only if you enable the `Override default configuration?` switch.
142+
143+
- Use the `Email on job completion?` switch to specify if the job notification should be sent on the successful job completion.
144+
145+
- Use the `Email on a job failure?` switch to specify if the job notification should be sent on the failure of a job.
158146

159-
- Use the `Override default configuration?` switch to specify if you want the agent level job notification settings to override the default job notification settings. If you select `Yes` for this switch, you can use the rest of the settings on this dialog to define when and to whom the job notifications should be sent. Please note that the rest of the settings on this dialog work only if you enable the `Override default configuration?` switch.
160-
- Use the `Email on job completion?` switch to specify if the job notification should be sent on the successful job completion.
161-
- Use the `Email on a job failure?` switch to specify if the job notification should be sent on the failure of a job.
162-
- Use the `Email group` field to specify the email group to whom the job notification should be sent.
147+
- Use the `Email group` field to specify the email group to whom the job notification should be sent.
163148

164-
![PEM Agent Properties dialog - Agent Configurations tab](../images/pem_agent_configurations_properties.png)
149+
![PEM Agent Properties dialog - Agent Configurations tab](../images/pem_agent_configurations_properties.png)
165150

166-
PEM Agent Properties dialog - Agent Configurations tab
151+
The `Agent Configurations` tab displays all the current configurations and capabilities of a agent.
167152

168-
The `Agent Configurations` tab displays all the current configurations and capabilities of a agent.
153+
- The `Parameter` column displays a list of parameters.
169154

170-
- The `Parameter` column displays a list of parameters.
171-
- The `Value` column displays the current value of the corresponding parameter.
172-
- The `Category` column displays the category of the corresponding parameter; it can be either `configuration` or `capability`.
155+
- The `Value` column displays the current value of the corresponding parameter.
156+
157+
- The `Category` column displays the category of the corresponding parameter; it can be either `configuration` or `capability`.

0 commit comments

Comments
 (0)