WEM docs

advocacy_docs/supported-open-source/warehousepg/index.mdx

@@ -4,6 +4,7 @@ description: Covering the open source WarehousePG and EDB Postgres AI support fo
 navigation:
 - warehousepg
 - edbpggpsupp
+- wem
 - observability
 - flowserver
 - whpg-copy

advocacy_docs/supported-open-source/warehousepg/wem/configuring.mdx

@@ -0,0 +1,42 @@
+---
+title: Configuring WarehousePG Enterprise Manager
+navTitle: Configuring WEM
+description: Configure WEM settings after installation using the WEM settings tab or configuration file.
+---
+
+After the initial installation of WarehousePG Enterprise Manager (WEM), use these configuration methods to fine-tune your settings or enable optional observability features. 
+
+### Modifying settings using the WEM console
+
+Administrators can modify operational parameters directly through the web interface. It's the most efficient way to enable features without interrupting the WEM service.
+
+1. Navigate to **Management** > **Settings** and select **Edit Settings**.
+1. Update the required fields, such as **Prometheus URL** or **Exporter log level**.
+1. Select **Save** to apply the changes.
+
+!!! Note
+    Some system parameters are only accessible via the configuration file.
+
+### Modifying settings manually
+
+Edit the configuration file directly on the WEM host to edit parameters not exposed in the browser.
+
+1. Stop the WEM service on the WEM host:
+
+    ```bash
+    systemctl stop wem 
+    ```
+
+1. Open `/etc/wem/wem.conf` and update the required parameters. See [Configuring WEM](installing/wem#configuring-wem) for a list of supported parameters.
+1. Restart the WEM service for the changes to take effect:
+    ```bash
+    systemctl start wem
+    ```
+
+
+
+!!! Note "Configuration precedence and overrides"
+    WEM prioritizes settings defined in the host environment over those in the WEM console.
+
+    If you define a parameter in the `wem.conf` file, that value takes precedence. Changes made in the WEM console will not override values set in the configuration file. 
+    If a change you made through the WEM console does not take effect, check the host configuration file for an existing entry.

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

@@ -0,0 +1,81 @@
+---
+title: Getting started with WarehousePG Enterprise Manager
+navTitle: Getting started
+description: Learn how to access the console, understand user roles, and navigate the primary dashboard components.
+---
+
+Once WarehousePG Enterprise Manager (WEM) is installed and the backend services are running, you can begin observing system health and tuning performance.
+
+!!! Important
+    The host running WEM must remain online and the application must be active to ensure continuous data gathering. Stopping the application will halt the collection of SQL and cluster-level metrics.
+
+## Accessing the console and managing your session
+
+Access the centralized management suite to begin monitoring your WarehousePG (WHPG) cluster.
+
+1. Navigate to your WEM server URL (for example, `http://your-server:8080`) and enter your administrative credentials.
+1. Check the top right bar of the interface to confirm your current role (Admin, Operator, or Viewer). Your role determines which panels and actions are visible during the session.
+1. Sessions automatically expire after a period of inactivity for security. If a timeout occurs, you must log in again to return to the authentication screen. Save any active work in the **Query Editor** regularly to prevent data loss.
+
+## Navigating the interface structure
+
+The WEM interface is organized into functional areas designed to help you move from high-level alerts to deep-dive diagnostics.
+
+- **Panels (left sidebar):**  Access the primary functional modules such as **Cluster**, **Monitoring**, and **Access Management**.
+- **Header (top):** View the current page title, system time, and global controls.
+- **Tabs (top of content):** Navigate between specific tools or sub-views in a selected panel.
+- **Interactive data (center):** Interact with data tables, live performance charts, and configuration tools.
+
+**Navigation directory**
+
+Locate specific operational goals and their corresponding section:
+
+| Goal | Panel |
+| --------------- | ------------ |
+| [Verifying the cluster health](monitoring/cluster-overview/) | Cluster | 
+| [Monitoring and evaluating queries](performance/query-monitor/) | Query Monitor | 
+| [Analyzing data distribution](performance/data-analysis/) | Data Analysis |
+| [Planning storage capacity](performance/storage/) | Storage | 
+| [Defining access policies](system-access/access-management/) | Access Management |
+| [Visualizing hardware performance](monitoring/system-metrics/) | System Metrics | 
+| [Managing system resources](performance/managing-resources/) | Resource Management |
+| [Securing backups](performance/backups/) | Backups |
+| [Auditing system logs](monitoring/logs/) | Logs | 
+| [Validating database responsiveness](monitoring/monitoring/) | Monitoring |
+| [Managing alerts](monitoring/alerts/) | Alerts | 
+| [Performing administrative management](system-access/management/) | Management | 
+
+
+## Understanding user roles and permissions
+
+WEM utilizes Role-Based Access Control (RBAC). After the initial bootstrap, all user management and password updates are handled exclusively via the **Management** panel. A user's assigned profile determines which panels and actions are visible.
+
+| Profile | 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](reference#role-permissions-matrix) for details.
+
+## Monitoring cluster health with the Dashboard
+
+The **Dashboard** is your landing page, which provides a real-time snapshot of cluster health and resource consumption.
+
+**Review status and resources:**
+- Monitor high-level indicators for an immediate status check, such as **Uptime**, **Connections**, and **Last Sync** time.
+- View healthy vs. unhealthy segments. 
+- Monitor storage utilization for the coordinator and segments.
+
+**Analyze performance charts**
+- Track running, queued, and blocked queries in the **Active Queries** chart.
+- Visualize system and user utilization with **CPU Usage**.
+- Monitor total memory usage percentage with **Memory Usage**.
+
+**Audit recent alerts**
+- Review the **Recent WHPG Log Alerts** card for the latest log events. Navigate to the **Logs** panel for a full audit trail.
+
+
+
+
+

advocacy_docs/supported-open-source/warehousepg/wem/index.mdx

@@ -0,0 +1,60 @@
+---
+title: WarehousePG Enterprise Manager
+description: Use WarehousePG Enterprise Manager as a centralized hub for monitoring, managing, and optimizing WarehousePG clusters.
+navigation:
+- release_notes
+- overview
+- installing
+- configuring
+- get-started
+- monitoring
+- performance
+- system-access
+- troubleshooting
+- reference
+navRootedTo: /supported-open-source/warehousepg/
+redirects:
+- /supported-open-source/warehousepg/observability/
+---
+
+WarehousePG Enterprise Manager (WEM) is a comprehensive management and monitoring platform for WarehousePG (WHPG) clusters. By integrating real-time telemetry, AI-assisted development, and interactive configuration, WEM streamlines complex distributed database operations into a single visual interface. It provides a single pane of glass for auditing cluster health, tuning SQL performance, and managing security in high-performance environments.
+
+## Why WEM?
+
+Managing a distributed database manually across multiple segment nodes and coordinators can be resource-intensive and error-prone. WEM solves these challenges by providing:
+- **Unified visibility:** Move beyond per-node SSH sessions. WEM aggregates host metrics, SQL statistics, and system logs into one centralized location.
+
+- **Reduced operational fisk:** With features like the interactive HBA editor and automatic configuration backups, WEM provides a safety net for critical administrative changes.
+
+- **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.
+
+- **Proactive resilience:** Integrated Canary checks and automated alerting ensure you are notified of potential bottlenecks or connectivity issues before they impact your users.
+
+
+### Key capabilities
+
+WEM introduces a robust suite of tools for the modern database administrator and developer:
+
+- **Observability & health**
+    - **Real-time & historical metrics:** Monitor live cluster pulse via the integrated Exporter or analyze long-term trends using Prometheus data.
+
+    - **Cluster overview:** A dedicated dashboard for the immediate health status of your coordinator and segment architecture.
+
+    - **Log management:** Searchable, aggregated log streams powered by Loki for rapid root-cause analysis.
+
+- **Intelligence & analysis**
+    - **Query monitor & editor:** A full-featured SQL editor featuring an AI Assistant to help write, optimize, and explain distributed queries.
+
+    - **Data skew analysis:** Deep-dive tools to analyze table distribution and storage efficiency across the cluster segments.
+
+- **Cluster administration**
+    - **Access management:** An interactive HBA editor for `pg_hba.conf` and a centralized user interface for user/password management.
+
+    - **Resource management:** Real-time tracking of CPU, Memory, and I/O consumption across the entire cluster.
+
+    - **System settings audit:** A searchable interface to verify and audit cluster-level configuration parameters.
+
+- **Data protection**
+    - **Backup & recovery:** Centralized monitoring of backup schedules, recovery points, and success rates.
+
+    - **Canary checks:** Automated "heartbeat" tests that proactively verify cluster connectivity and query responsiveness.

advocacy_docs/supported-open-source/warehousepg/wem/installing/collector.mdx

@@ -0,0 +1,97 @@
+---
+title: Installing Collector
+navTitle: Installing Collector
+description: Learn how to install the WarehousePG Enterprise Manager Collector on your WarehousePG cluster.
+---
+
+Install the WarehousePG (WHPG) Collector on your WHPG cluster coordinator.
+
+## Downloading and installing WHPG Collector
+
+1. On the coordinator, download the packages from the EDB repository:
+
+    ```bash
+    export EDB_SUBSCRIPTION_TOKEN=<your-token>
+    export EDB_REPO=gpsupp
+    curl -1sSLf "https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/$EDB_REPO/setup.rpm.sh" | sudo -E bash
+    sudo dnf download edb-whpg-observability-collector
+    ```
+
+1. On the coordinator, create a file `all_hosts`, which lists all hosts in the WHPG cluster. For example:
+
+    ```ini
+    cdw
+    scdw
+    sdw1
+    sdw2
+    sdw3
+    ```
+
+1. From the coordinator, transfer and install the Collector package on all hosts in the WHPG cluster:
+
+    <TabContainer syncKey="install">
+    <Tab title="RHEL 8, 9">
+
+    ```bash 
+    gpssh -f all_hosts -u gpadmin -e "scp gpadmin@$(hostname):edb-whpg-observability-collector*.rpm /tmp/ && sudo dnf install -y /tmp/edb-whpg-observability-collector*.rpm"
+    ```
+
+    </Tab>
+    <Tab title="RHEL 7">
+
+    ```bash 
+    gpssh -f all_hosts -u gpadmin -e "scp gpadmin@$(hostname):edb-whpg-observability-collector*.rpm /tmp/ && sudo yum install -y /tmp/edb-whpg-observability-collector*.rpm"
+
+    ```
+
+    </Tab>
+    </TabContainer>
+
+## Configuring WEM Collector 
+
+Once the Collector package are installed, edit the file `/var/lib/whpg-observability-collector/collector.conf` on the coordinator and configure the following parameters:
+
+- `WHPG_OBS_DSN`: Specify your WHPG cluster connection details. For example:
+
+    ```ini
+    WHPG_OBS_DSN="host=whpg-coordinator-host port=5432 dbname=postgres user=gpadmin password=postgres sslmode=disable"
+    ```
+
+    !!! Note
+        You can specify any database on your WHPG cluster. However, the user must hold the superuser role.
+
+- `LOKI_ENDPOINT`: Point to your configured Loki API endpoint for log aggregation. For example:
+
+    ```ini
+    LOKI_ENDPOINT="http://loki.hostname:3100/loki/api/v1/push"
+    ```
+
+- `PROMETHEUS_ENDPOINT`: Point to your configured Prometheus API endpoint for host-level metrics via remote write. For example:
+
+    ```ini
+    PROMETHEUS_ENDPOINT="http://prometheus.hostname:9090/api/v1/write"
+    ```
+
+
+## Starting the Collector service
+
+On the coordinator, run the following commands to deploy the configuration and start the service on every host in the WHPG cluster:
+
+ ```bash
+ cd /var/lib/whpg-observability-collector
+ ./deploy-observability 
+ ```
+
+The Collector service now runs in the background on each host as the `alloy` service. You can manage this service using `systemctl` commands. For example:
+
+To check the service status:
+
+```bash
+sudo systemctl status alloy
+```
+
+To enable on boot:
+
+```bash
+sudo systemctl enable alloy
+```

advocacy_docs/supported-open-source/warehousepg/wem/installing/index.mdx

@@ -0,0 +1,20 @@
+---
+title: Installing WarehousePG Enterprise Manager
+navTitle: Installing
+description: Learn how to install WarehousePG Enterprise Manager.
+navigation:
+- prerequisites
+- collector
+- wem
+---
+
+
+!!! Note
+These instructions assume you have installed Prometheus and Loki.  You can deploy dedicated instances for WEM or integrate with your existing enterprise monitoring stack. 
+!!!
+
+The installation process consists of the following steps:
+
+1. Verify the [prerequisites](prerequisites).
+1. [Install WHPG Collector](collector) on your WarehousePG (WHPG) cluster.
+1. [Install and configure WEM](wem) on your dedicated host.

advocacy_docs/supported-open-source/warehousepg/wem/installing/prerequisites.mdx

@@ -0,0 +1,36 @@
+---
+title: WarehousePG Enterprise Manager prerequisites
+navTitle: Prerequisites
+description: Understand the prerequisites before installing the WarehousePG Observability components.
+---
+
+!!! Note
+These instructions assumes you have installed Prometheus and Loki. You can deploy dedicated instances for WEM or integrate with your existing enterprise monitoring stack.
+!!!
+
+## Prerequisites
+
+- WarehousePG (WHPG) version 6.x running on RHEL 7 or RHEL 8.
+- WHPG version 7.x running on RHEL 8 or RHEL 9.
+- A separate host for WarehousePG Enterprise Manager (WEM), running RHEL 8 or RHEL 9.
+- [Loki](https://grafana.com/docs/loki/latest/setup/install/) 3.5 or later.  You can deploy a dedicated instance for WEM or integrate with your existing enterprise monitoring stack.
+- [Prometheus](https://prometheus.io/docs/prometheus/latest/installation/) 3.5.0 or later with [remote_write](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) enabled. You can deploy a dedicated instance for WEM or integrate with your existing enterprise monitoring stack.
+- A database user that holds the superuser role and is able to connect to your WHPG cluster from the WEM host.
+- Optional: An active Anthropic account and a valid API key are required to enable the AI Assistant for query writing and optimization.
+- 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.
+
+!!! Warning 
+    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.
+
+## Network requirements
+
+The following table lists the connection requirements among the different components. The ports listed are default values, you can customize them according to your environment:
+
+| Source | Destination | Use  
+| ------ | ----------- | ---
+| WHPG Coordinator | Prometheus:9090 | Push host level metrics
+| WHPG Coordinator | Loki:3100       | Push log files
+| WEM          | Prometheus:9090 | Retrieve host level metrics
+| WEM          | Loki:3100       | Retrieve log metrics
+| End user         | WEM:8080    | Access to WEM console
+