Getting started with WarehousePG Enterprise Manager
Once WarehousePG Enterprise Manager (WEM) is installed and the backend services are running, you can begin using it to observe system health and tune performance.
Accessing the console
To start using the interface:
- Navigate to your WEM server URL (e.g.,
http://your-server:8080). - Enter your credentials on the login screen.
- Select Sign in.
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.
Configuring WEM settings post-installation
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:
- Using the WEM settings tab
Administrators can modify most operational parameters directly through the browser:
1. Navigate to **User Management** > **Settings**. 1. Update fields such as **Prometheus URL** or **Backup History Database Path**.
Note
While convenient, some low-level system parameters are only accessible via the configuration file.
- Manual configuration file editing
For parameters not exposed in the WEM console or for automated deployments, you can edit the configuration file directly on the host server:
1. Stop the service: `systemctl stop wem`. 1. Edit the file `/etc/wem/wem.conf` on your WEM cluster and modify the desired parameter. 1. Restart the service: `systemctl start wem` to apply the changes.
Navigating the interface structure
The WEM interface is organized into three functional areas:
- Sidebar (left): The primary navigation menu.
- Header (top): Displays the current page title, system time, and global controls such as filters and refresh triggers.
- Main content (center): The primary workspace where data tables, charts, and configuration tools are rendered.
Understanding user roles and permissions
WEM utilizes Role-Based Access Control (RBAC). The panels available in the console are determined by the role assigned to your user account.
| Role | Description | Access scope |
|---|---|---|
| Admin | Full system administration | All panels, user management, and system configuration. |
| Operator | Operational management | Query monitoring, data analysis, and backup operations. |
| Viewer | Read-only observation | High-level dashboards, cluster status, and system metrics. |
Refer to the Role permissions matrix for details.
Inspecting the Dashboard
The Dashboard tab is the landing page upon login, providing a real-time snapshot of cluster health and activity.
Global controls
- Node filter: Scopes the dashboard metrics to a specific cluster node or all nodes for an aggregate view.
- Refresh: Forces a manual update of the dashboard data points.
- System time: Displays the current server-side time for synchronization reference.
Primary metrics bar
Five high-level indicators provide an immediate status check:
- Uptime: Total elapsed time since the cluster was initialized.
- WHPG version: The specific version of the WarehousePG database engine.
- WEM version: The current build version of the WEM application.
- Connections: Total count of active database connections.
- Last sync: The timestamp of the most recent data ingestion from the cluster.
Status and resource summaries
- 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.
- 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.
Real-time performance charts
The dashboard includes three live charts that begin streaming data upon page load:
- Queries chart: Monitors the volume of running, queued, and blocked queries.
- CPU chart: Visualizes system and user CPU utilization.
- Memory chart: Displays the percentage of total memory currently in use.
Note
These charts require a functional Prometheus integration. If you haven't configured a Prometheus service, data collection will begin when the page is loaded in the browser and the dashboard charts won't display historical data.
Recent alerts
This card displays recent WarehousePG log events. Selecting any alert will redirect you to the Logs panel for a deeper audit trail.
Could this page be better? Report a problem or suggest an addition!