Skip to content

Commit b4c2593

Browse files
mpfusterjpe442
authored andcommitted
improve get started page
1 parent d650fb0 commit b4c2593

File tree

3 files changed

+42
-47
lines changed

3 files changed

+42
-47
lines changed

advocacy_docs/supported-open-source/warehousepg/wem/get-started.mdx

Lines changed: 40 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,53 @@ navTitle: Getting started
44
description: Learn how to access the console, understand user roles, and navigate the primary dashboard components.
55
---
66

7-
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.
7+
Once WarehousePG Enterprise Manager (WEM) is installed and the backend services are running, you can begin observing system health and tuning performance.
88

9+
!!! Important
10+
The host running WEM must remain online and the application must be active to ensure continuous data gathering. Closing the application will stop the collection of SQL and cluster-level metrics.
911

1012
## Accessing the console
1113

12-
To start using the interface:
14+
To begin managing your cluster:
15+
1316
1. Navigate to your WEM server URL (e.g., `http://your-server:8080`).
14-
2. Enter your credentials on the login screen.
15-
3. Select **Sign in**.
17+
1. Enter your administrative credentials on the login screen.
18+
1. Select **Sign in**.
1619

1720
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.
1821

19-
## Configuring WEM settings post-installation
20-
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+
## Configuring WEM settings
2223

23-
1. Using the WEM settings tab
24+
Once you have installed WEM, you can fine-tune how WEM connects to your cluster or configure other external services (Prometheus and Alertmanager) using two methods:
2425

25-
Administrators can modify most operational parameters directly through the browser:
26+
1. **Method 1: Use the WEM settings tab**
2627

28+
Administrators can modify most operational parameters directly through the browser:
2729
1. Navigate to **User Management** > **Settings**.
2830
1. Update fields such as **Prometheus URL** or **Backup History Database Path**.
31+
1. Save to apply changes immediately.
2932

3033
!!! Note
31-
While convenient, some low-level system parameters are only accessible via the configuration file.
32-
33-
2. Manual configuration file editing
34+
Some low-level system parameters are only accessible via the configuration file.
3435

35-
For parameters not exposed in the WEM console or for automated deployments, you can edit the configuration file directly on the host server:
36+
2. **Method 2: Edit the configuration file manually**
3637

37-
1. Stop the service: `systemctl stop wem`.
38-
1. Edit the file `/etc/wem/wem.conf` on your WEM cluster and modify the desired parameter.
39-
1. Restart the service: `systemctl start wem` to apply the changes.
38+
For low-level system parameters not exposed in the WEM console, or for automated deployments, edit the WEM configuration file directly on the host server:
39+
1. Stop the service: `systemctl stop wem` on the WEM host.
40+
1. Edit the file `/etc/wem/wem.conf` and modify the desired parameter.
41+
1. Restart the service: `systemctl start wem`.
4042

4143

4244
## Navigating the interface structure
4345

4446
The WEM interface is organized into three functional areas:
45-
1. **Sidebar (left)**: The primary navigation menu.
46-
2. **Header (top)**: Displays the current page title, system time, and global controls such as filters and refresh triggers.
47-
3. **Main content (center)**: The primary workspace where data tables, charts, and configuration tools are rendered.
47+
1. **Sidebar (left):** Access all primary tabs, including the **Query Monitor**, **Backups**, and **Data Analysis**.
48+
1. **Header (top):** View the current page title, system time, and global controls (filters and refresh triggers).
49+
1. **Main content (center):** Interact with data tables, performance charts, and configuration tools.
4850

4951
## Understanding user roles and permissions
5052

51-
WEM utilizes Role-Based Access Control (RBAC). The panels available in the console are determined by the role assigned to your user account.
53+
WEM utilizes Role-Based Access Control (RBAC). After the initial bootstrap, all user management and password updates are handled exclusively via the User Management panel in the UI. A user's assigned role determines which panels and actions are visible.
5254

5355
| Role | Description | Access scope |
5456
| :--- | :--- | :--- |
@@ -58,39 +60,32 @@ WEM utilizes Role-Based Access Control (RBAC). The panels available in the conso
5860

5961
Refer to the [Role permissions matrix](reference#role-permissions-matrix) for details.
6062

61-
## Inspecting the Dashboard
63+
## Monitoring cluster health via the Dashboard
6264

63-
The **Dashboard** tab is the landing page upon login, providing a real-time snapshot of cluster health and activity.
65+
The **Dashboard** is your landing page, providing a real-time snapshot of cluster health.
6466

65-
### Global controls
66-
* **Node filter**: Scopes the dashboard metrics to a specific cluster node or all nodes for an aggregate view.
67-
* **Refresh**: Forces a manual update of the dashboard data points.
68-
* **System time**: Displays the current server-side time for synchronization reference.
67+
**Use the global controls**
68+
- **Node Filter:** Scope metrics to a specific node or view an aggregate of the entire cluster.
69+
- **Refresh:** Manually update all data points on the page.
6970

70-
### Primary metrics bar
71-
Five high-level indicators provide an immediate status check:
72-
* **Uptime**: Total elapsed time since the cluster was initialized.
73-
* **WHPG version**: The specific version of the WarehousePG database engine.
74-
* **WEM version**: The current build version of the WEM application.
75-
* **Connections**: Total count of active database connections.
76-
* **Last sync**: The timestamp of the most recent data ingestion from the cluster.
71+
**Check primary metrics**
7772

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. 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.
73+
Monitor high-level indicators for an immediate status check, such as **Uptime**, **Connections**, and **Last Sync** time.
8174

82-
### Real-time performance charts
83-
The dashboard includes three live charts that begin streaming data upon page load:
84-
* **Queries chart**: Monitors the volume of running, queued, and blocked queries.
85-
* **CPU chart**: Visualizes system and user CPU utilization.
86-
* **Memory chart**: Displays the percentage of total memory currently in use.
75+
**Review status and resources:**
76+
- View healthy vs. unhealthy segments.
77+
- Monitor storage utilization for the coordinator and segments.
8778

88-
!!! Note
89-
These charts require a functional [Prometheus integration](installing/wem#configuring-wem). 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.
79+
**Analyze performance charts**
80+
81+
WEM streams live data into three primary charts:
82+
- **Active Queries:** Track running, queued, and blocked queries.
83+
- **CPU Usage:** Visualize system and user utilization.
84+
- **Memory Usage:** Monitor total memory usage percentage.
9085

91-
### Recent alerts
92-
This card displays recent WarehousePG log events. Selecting any alert will redirect you to the **Logs** panel for a deeper audit trail.
86+
**Audit recent alerts**
9387

88+
Review the **Recent WHPG Log Alerts** card for WHPG log events. Open the **Logs** panel for a full audit trail.
9489

9590

9691

advocacy_docs/supported-open-source/warehousepg/wem/monitoring/alerts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ deepToC: true
88
The **Alerts** panel serves as the central nervous system for your cluster, aggregating health signals from across your infrastructure. This panel integrates directly with Prometheus Alertmanager to provide a unified interface for incident response and rule management.
99

1010
!!! Warning "Alertmanager required"
11-
If the **Alerts** panel displays `Alertmanager Not Configured`, you must set the `ALERTMANAGER_URL` in your system environment. See [Configuring WEM](../installing/wem#configuring-wem) and [Configuring WEM settings post-installation](../get-started#configuring-wem-settings-post-installation) for details.
11+
If the **Alerts** panel displays `Alertmanager Not Configured`, you must set the `ALERTMANAGER_URL` in your system environment. See [Configuring WEM](../installing/wem#configuring-wem) and [Configuring WEM settings post-installation](../get-started#configuring-wem-settings) for details.
1212

1313
### Identifying alert sources
1414

advocacy_docs/supported-open-source/warehousepg/wem/performance/query-monitor.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Use the **Query Editor** tab as an interactive workbench to safely explore data
5858
Use the integrated AI Assistant to accelerate sql authoring and simplify the debugging of complex performance issues.
5959

6060
!!! Note
61-
This is an optional feature. An administrator must configure an `ANTHROPIC_API_KEY` for the assistant to be active. See [Configuring WEM](../installing/wem#configuring-wem) and [Configuring WEM settings post-installation](../get-started#configuring-wem-settings-post-installation) for details.
61+
This is an optional feature. An administrator must configure an `ANTHROPIC_API_KEY` for the assistant to be active. See [Configuring WEM](../installing/wem#configuring-wem) and [Configuring WEM settings post-installation](../get-started#configuring-wem-settings) for details.
6262

6363
- **Generate queries from natural language:** Press `Ctrl + K` to ask the assistant to write a query for you using plain English. Because the assistant is schema-aware, it will reference your actual table and column names accurately.
6464
- **Optimize slow-running statements:** Paste a slow query into the assistant and ask for optimization suggestions. The assistant will analyze join efficiency, index usage, and cluster resource utilization to recommend a more efficient version of your code.

0 commit comments

Comments
 (0)