You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: advocacy_docs/supported-open-source/warehousepg/wem/get-started.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,13 @@ Once WarehousePG Enterprise Manager (WEM) is installed and the backend services
12
12
To start using the interface:
13
13
1. Navigate to your WEM server URL (e.g., `http://your-server:8080`).
14
14
2. Enter your credentials on the login screen.
15
-
3.Click**Sign in**.
15
+
3.Select**Sign in**.
16
16
17
-
For security, sessions automatically expire after a period of inactivity; if a timeout occurs, the system will display a "Session Expired" message and redirect you to the login screen. You can also manually terminate your session at any time by clicking the Logout icon located in the sidebar footer.
17
+
For security, sessions automatically expire after a period of inactivity; if a timeout occurs, the system will display a "Session Expired" message and redirect you to the login screen. You can also manually terminate your session at any time by selecting the **Logout** icon located in the sidebar footer.
18
18
19
19
## Configuring WEM settings post-installation
20
20
21
-
Once you have installed WEM, you may need to fine-tune how WEM connects to your cluster or external services (like Prometheus and Alertmanager). There are two primary ways to manage these configurations:
21
+
Once you have installed WEM, you might need to fine-tune how WEM connects to your cluster or external services (like Prometheus and Alertmanager). There are two primary ways to manage these configurations:
22
22
23
23
1. Using the WEM settings tab
24
24
@@ -76,8 +76,8 @@ Five high-level indicators provide an immediate status check:
76
76
***Last sync**: The timestamp of the most recent data ingestion from the cluster.
77
77
78
78
### Status and resource summaries
79
-
***Segment status card**: Displays the overall operational state of the data plane. It tracks the count of healthy vs. unhealthy segments and provides a visual health bar. Click this card to access the **Cluster Overview** panel.
80
-
***Disk usage summary**: Provides a high-level view of storage utilization for both the coordinator and the segment nodes. Click this card to access the **Storage** panel.
79
+
***Segment status card**: Displays the overall operational state of the data plane. It tracks the count of healthy vs. unhealthy segments and provides a visual health bar. Select this card to access the **Cluster Overview** panel.
80
+
***Disk usage summary**: Provides a high-level view of storage utilization for both the coordinator and the segment nodes. Select this card to access the **Storage** panel.
81
81
82
82
### Real-time performance charts
83
83
The dashboard includes three live charts that begin streaming data upon page load:
Copy file name to clipboardExpand all lines: advocacy_docs/supported-open-source/warehousepg/wem/index.mdx
+32-10Lines changed: 32 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,22 +14,44 @@ navigation:
14
14
navRootedTo: /supported-open-source/warehousepg/
15
15
---
16
16
17
-
WarehousePG Enterprise Manager (WEM) is the centralized managementand monitoring interface for WarehousePG (WHPG) clusters. By integrating with Prometheus, Grafana, and Loki, WEM provides real-time visibility into host-level metrics, cluster health, and query performance.
17
+
WarehousePG Enterprise Manager (WEM) is a comprehensive management, monitoring, and administration platform designed specifically for WarehousePG (WHPG) clusters. By integrating real-time telemetry, AI-assisted development, and interactive configuration tools into a single interface, WEM transforms complex distributed database operations into a streamlined, visual experience. Whether you are auditing cluster health, tuning SQL performance, or managing security, WEM provides the single pane of glass necessary to maintain a high-performance distributed environment.
18
18
19
-
-[Release notes:](release_notes) Review the latest feature updates, bug fixes, and maintenance improvements for the current version of WEM.
19
+
## Why WEM?
20
20
21
-
-[Overview:](overview) Understand the core architecture of the platform, check software compatibility requirements, and review any known issues.
21
+
Managing a distributed database manually across multiple segment nodes and coordinators can be resource-intensive and error-prone. WEM solves these challenges by providing:
22
+
-**Unified visibility:** Move beyond per-node SSH sessions. WEM aggregates host metrics, SQL statistics, and system logs into one centralized location.
22
23
23
-
-[Installing:](installing) Follow the step-by-step requirements and procedures to deploy WEM and integrate it with your database nodes.
24
+
-**Reduced operational fisk:** With features like the interactive HBA editor and automatic configuration backups, WEM provides a safety net for critical administrative changes.
24
25
25
-
-[Getting started:](get-started) Learn how to access the console, navigate the interface structure, and understand how user roles affect your view.
26
+
-**AI-driven optimization:** Leverage built-in AI intelligence to explain execution plans and suggest query optimizations, lowering the barrier to entry for managing complex distributed workloads.
26
27
27
-
-[Observing system events:](monitoring) Maintaining operational awareness through log auditing, alert tracking, and health monitoring.
28
+
-**Proactive resilience:** Integrated Canary checks and automated alerting ensure you are notified of potential bottlenecks or connectivity issues before they impact your users.
28
29
29
-
-[Optimizing system performance:](performance) Tuning the workload and infrastructure to ensure consistent high-speed execution.
30
30
31
-
-[Securing the environment:](security) Establishing safety protocols and managing access to sensitive data.
31
+
### Key capabilities
32
32
33
-
-[Troubleshooting:](troubleshooting) Identify and resolve common configuration errors, connectivity issues, and performance bottlenecks.
33
+
WEM introduces a robust suite of tools for the modern database administrator and developer:
34
34
35
-
-[Reference:](reference) Access technical specifications, command-line tool documentation, and the full role-permissions matrix.
35
+
-**Observability & health**
36
+
-**Real-time & historical metrics:** Monitor live cluster pulse via the integrated Exporter or analyze long-term trends using Prometheus data.
37
+
38
+
-**Cluster overview:** A dedicated dashboard for the immediate health status of your coordinator and segment architecture.
39
+
40
+
-**Log management:** Searchable, aggregated log streams powered by Loki for rapid root-cause analysis.
41
+
42
+
-**Intelligence & analysis**
43
+
-**Query monitor & editor:** A full-featured SQL editor featuring an AI Assistant to help write, optimize, and explain distributed queries.
44
+
45
+
-**Data skew analysis:** Deep-dive tools to analyze table distribution and storage efficiency across the cluster segments.
46
+
47
+
-**Cluster administration**
48
+
-**Access management:** An interactive HBA editor for `pg_hba.conf` and a centralized user interface for user/password management.
49
+
50
+
-**Resource management:** Real-time tracking of CPU, Memory, and I/O consumption across the entire cluster.
51
+
52
+
-**System settings audit:** A searchable interface to verify and audit cluster-level GUC parameters.
53
+
54
+
-**Data protection**
55
+
-**Backup & recovery:** Centralized monitoring of backup schedules, recovery points, and success rates.
56
+
57
+
-***Canary checks:** Automated "heartbeat" tests that proactively verify cluster connectivity and query responsiveness.
Copy file name to clipboardExpand all lines: advocacy_docs/supported-open-source/warehousepg/wem/installing/collector.mdx
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,14 +49,17 @@ Install the WarehousePG (WHPG) Collector on your WHPG cluster coordinator.
49
49
50
50
## Configuring the Collector
51
51
52
-
On the coordinator, edit the file `/var/lib/whpg-observability-collector/collector.conf` and configure the following parameters:
52
+
Once the Collector packages are installed, edit the file `/var/lib/whpg-observability-collector/collector.conf` on the coordinator and configure the following parameters:
53
53
54
-
-`WHPG_OBS_DSN`: Specify your WHPG cluster connection details. You can specify any database on your WHPG cluster. However, the user must hold the superuser role. For example:
54
+
-`WHPG_OBS_DSN`: Specify your WHPG cluster connection details. For example:
Copy file name to clipboardExpand all lines: advocacy_docs/supported-open-source/warehousepg/wem/installing/prerequisites.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,8 @@ This guide assumes you have installed Prometheus and Loki.
16
16
-[Loki](https://grafana.com/docs/loki/latest/setup/install/) 3.5 or later.
17
17
-[Prometheus](https://prometheus.io/docs/prometheus/latest/installation/) 3.5.0 or later.
18
18
- A database user that holds the superuser role and is able to connect to your WHPG cluster from the WEM host.
19
-
- An active Anthropic account and a valid API key are required to enable the AI Assistant query writing and optimization.
20
-
- An active installation of [Prometheus Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) version 0.28.1 or later is required to enable centralized alert handling and notifications within WEM.
19
+
-Optional: An active Anthropic account and a valid API key are required to enable the AI Assistant for query writing and optimization.
20
+
-Optional: An active installation of [Prometheus Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) version 0.28.1 or later is required to enable centralized alert handling and notifications within WEM.
21
21
22
22
!!! Warning
23
23
WEM is not supported for installation on Red Hat Enterprise Linux 7 (RHEL 7). This limitation applies only to where the WEM application itself is deployed; WEM is fully capable of monitoring WHPG clusters that are running on RHEL 7 nodes.
Copy file name to clipboardExpand all lines: advocacy_docs/supported-open-source/warehousepg/wem/installing/wem.mdx
+21-15Lines changed: 21 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
title: Installing WEM
3
3
navTitle: Installing WEM
4
4
description: Learn how to install the WarehousePG Enterprise Manager service.
5
+
deepToC: true
5
6
---
6
7
7
8
Install the WarehousePG Enterprise Manager (WEM) package on your designated host.
@@ -23,12 +24,12 @@ Install the WarehousePG Enterprise Manager (WEM) package on your designated host
23
24
sudo dnf install -y whpg-enterprise-manager
24
25
```
25
26
26
-
## Configuring WEM options
27
+
## Configuring WEM
27
28
28
29
Edit the configuration file `/etc/wem/wem.conf` and configure the following parameters:
29
30
30
31
31
-
1. Set the values of `WHPG_HOST`, `WHPG_PORT`, `WHPG_DATABASE`, `WHPG_USER` , and `WHPG_PASSWORD` to point to your WHPG cluster. You can specify any database on your WHPG cluster. However, the user must hold the superuser role. For example:
32
+
1. Set the values of `WHPG_HOST`, `WHPG_PORT`, `WHPG_DATABASE`, `WHPG_USER` , and `WHPG_PASSWORD` to point to your WHPG cluster. For example:
32
33
33
34
```ini
34
35
WHPG_HOST=whpg-coordinator-host
@@ -37,15 +38,17 @@ Edit the configuration file `/etc/wem/wem.conf` and configure the following para
37
38
WHPG_USER=gpadmin
38
39
WHPG_PASSWORD=postgres
39
40
```
40
-
41
+
42
+
!!! Note
43
+
You can specify any database on your WHPG cluster. However, the user must hold the superuser role.
44
+
41
45
1. Set the values of the Prometheus and Loki endpoints. For example:
42
46
43
47
```ini
44
48
PROMETHEUS_URL="http://prometheus.hostname:9090"
45
49
LOKI_URL="http://loki.hostname:3100"
46
50
```
47
51
48
-
49
52
1. To enable the AI Assistant for query writing and optimization, configure the `ANTHROPIC_API_KEY` parameter. Note that this requires an active Anthropic account.
50
53
51
54
1. To enable centralized alert handling and notifications with Alertmanager, configure the `ALERTMANAGER_URL` parameter to point to your Alertmanager endpoint.
@@ -55,41 +58,44 @@ Edit the configuration file `/etc/wem/wem.conf` and configure the following para
55
58
56
59
### Configuring WEM portal access
57
60
58
-
Define how you access the WEM portal and establish the initial administrative credentials by configuring the following parameters in your environment file:
61
+
Define how you access the WEM portal by configuring the following parameters in the WEM configuration file:
59
62
60
63
```ini
61
64
WEM_HOST=wem-hostname
62
65
WEM_USER=admin
63
66
WEM_PORT=8080
64
67
```
65
68
66
-
To configure the administrator password, choose one of the three following methods:
69
+
To establish the initial administrative credentials, choose one of the three following methods:
70
+
71
+
!!! Note
72
+
The methods outlined below are strictly for the **initial setup** of the administrator password. Once the WEM portal is initialized and you have logged in for the first time, all subsequent user management—including adding new users, modifying roles, and updating passwords—must be handled directly through the WEM user interface.
67
73
68
74
1.**Option 1: Interactive setup** This is the simplest method for manual installations. You do not need to modify the configuration file manually; the system will prompt you for the password and handle the internal setup.
69
75
70
-
Run the setup command and follow the prompt to enter your desired password:
76
+
Run the `wem setup` command and follow the prompt to enter your desired password:
71
77
72
78
```bash
73
79
wem setup --interactive
74
80
```
75
81
76
-
1.**Option 2: Static configuration** Use this method to define your administrative password directly within the configuration file.
82
+
1.**Option 2: Static configuration** Use this method to define your administrative password directly within the WEM configuration file.
77
83
78
84
```ini
79
-
WEM_ADMIN_PASSWORD=admin123
85
+
WEM_ADMIN_PASSWORD=your-secure-password
80
86
```
81
87
82
-
1.**Option 3: File-based configuration** For enhanced security, manage the password via an external file. This is ideal for automated deployments or keeping secrets out of main config files.
88
+
1.**Option 3: File-based configuration** For enhanced security, manage the password via an external file. This is ideal for automated deployments or keeping secrets out of configuration files.
83
89
84
-
1.Provide a password by creating a file containing your password. Then, set the following parameter in your configuration:
90
+
1.Create a file containing your password:
85
91
86
92
```bash
87
93
echo"your-secure-password"> /etc/wem/admin.pw
88
94
```
89
95
90
-
Point WEM to the file:
96
+
Set the following parameter in the WEM configuration file:
91
97
92
-
```bash
98
+
```ini
93
99
WEM_ADMIN_PASSWORD_FILE=/etc/wem/admin.pw
94
100
```
95
101
@@ -112,13 +118,13 @@ sudo systemctl status wem
112
118
113
119
After starting the service, use these diagnostic tools to ensure all WEM components are communicating correctly and the environment is healthy:
114
120
115
-
-Connectivity Check: Run the verification tool to test the portal's link to the backend:
121
+
- Run `wem setup`to test WEM configuration settings:
116
122
117
123
```bash
118
124
wem setup --verify
119
125
```
120
126
121
-
-System Health Audit: Perform a comprehensive "doctor" check to identify potential configuration errors, missing dependencies, or connectivity issues:
127
+
- Perform a comprehensive "doctor" check to identify potential configuration errors, missing dependencies, or connectivity issues:
Copy file name to clipboardExpand all lines: advocacy_docs/supported-open-source/warehousepg/wem/monitoring/alerts.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Alerts are automatically generated from several monitoring vectors:
23
23
24
24
WEM displays severity levels to help you prioritize your operational workflow:
25
25
-**Critical:** Indicates a severe failure or a total loss of service. These require immediate attention.
26
-
-**Warning:** Highlights performance degradation or resource pressure. These should be investigated to prevent escalation.
26
+
-**Warning:** Highlights performance degradation or resource pressure. These must be investigated to prevent escalation.
27
27
-**Info:** Routine informational notices regarding system changes or successful task completions.
28
28
29
29
@@ -33,4 +33,4 @@ Use the specialized tabs to move through the stages of alert detection, suppress
33
33
-**Suppress noise during maintenance:** Use the **Silences** tab to temporarily mute specific alerts. This is essential during scheduled maintenance or segment recovery windows to prevent alert fatigue and ensure that your notification channels remain focused on unexpected issues.
34
34
-**Audit dispatch history:** Review the **Notifications** tab to see exactly when and where alerts were sent (e.g., Slack, Email, or PagerDuty). Use this to verify that the correct stakeholders were notified during an incident.
35
35
-**Evaluate detection logic:** Browse the **Alert Rules** tab to inspect the active triggers defined in your Prometheus configuration. This view allows you to verify the technical conditions (thresholds, durations, and labels) that govern how WEM identifies system degradation.
36
-
-**Perform retrospective analysis:** Use the **Alert History** tab to identify recurring patterns. By auditing resolved alerts, you can isolate intermittent hardware failures or recurring resource pressure that may require long-term capacity planning.
36
+
-**Perform retrospective analysis:** Use the **Alert History** tab to identify recurring patterns. By auditing resolved alerts, you can isolate intermittent hardware failures or recurring resource pressure that might require long-term capacity planning.
Copy file name to clipboardExpand all lines: advocacy_docs/supported-open-source/warehousepg/wem/monitoring/cluster-overview.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Verifying the cluster health
3
3
navTitle: Verifying the cluster health
4
-
description: Use the Cluster panel to monitor real-time WarehousePG cluster health, verify node availability, and track critical connectivity metrics to ensure high availability
4
+
description: Use the Cluster Overview panel to monitor real-time WarehousePG cluster health, verify node availability, and track critical connectivity metrics to ensure high availability
5
5
deepToC: true
6
6
---
7
7
@@ -35,5 +35,5 @@ WarehousePG relies on a distributed architecture where primary segments handle t
35
35
36
36
Identify which specific databases are consuming cluster resources to prevent one tenant from impacting others:
37
37
38
-
-**Compare database sizes:** Identify rapidly growing databases that may require storage expansion or data vacuuming.
38
+
-**Compare database sizes:** Identify rapidly growing databases that might require storage expansion or data vacuuming.
39
39
-**Track session distribution:** Monitor connection counts per database to identify unauthorized access or application connection leaks.
0 commit comments