Skip to content

Commit cd1dbd8

Browse files
committed
Changes
1 parent b4c2593 commit cd1dbd8

File tree

21 files changed

+265
-128
lines changed

21 files changed

+265
-128
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ navigation:
77
- observability
88
- flowserver
99
- whpg-copy
10+
- wem
1011
directoryDefaults:
1112
iconName: BigData
1213
---

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

Lines changed: 42 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,34 +19,34 @@ To begin managing your cluster:
1919

2020
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.
2121

22-
## Configuring WEM settings
23-
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:
2522

26-
1. **Method 1: Use the WEM settings tab**
27-
28-
Administrators can modify most operational parameters directly through the browser:
29-
1. Navigate to **User Management** > **Settings**.
30-
1. Update fields such as **Prometheus URL** or **Backup History Database Path**.
31-
1. Save to apply changes immediately.
23+
## Navigating the interface structure
3224

33-
!!! Note
34-
Some low-level system parameters are only accessible via the configuration file.
25+
The WEM interface is organized into the following functional areas:
26+
1. **Panels (left sidebar):** The primary functional modules (e.g., **Cluster**, **Monitoring**, **Access Management**).
27+
1. **Header (top):** View the current page title, system time, and global controls (filters and refresh triggers).
28+
1. **Tabs (top of content):** Specific tools or sub-views within a selected panel.
29+
1. **Main content (center):** Interact with data tables, performance charts, and configuration tools.
3530

36-
2. **Method 2: Edit the configuration file manually**
31+
**Navigation directory**
3732

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`.
33+
Use the following guide to locate specific tools and their corresponding documentation:
4234

35+
| Panel (sidebar) | Key actions |
36+
| --------------- | ------------ |
37+
| Cluster | [Verifying the cluster health](monitoring/cluster-overview/) |
38+
| Query Monitor | [Monitoring and evaluating queries](performance/query-monitor/) |
39+
| Data Analysis | [Analyzing data distribution](performance/data-analysis/) |
40+
| Storage | [Planning storage capacity](performance/storage/) |
41+
| Access Management | [Defining access policies](system-access/access-management/) |
42+
| System Metrics | [Visualizing hardware performance](monitoring/system-metrics/) |
43+
| Resource Management | [Managing system resources](performance/managing-resources/) |
44+
| Backups | [Securing backups](performance/backups/) |
45+
| Logs | [Auditing system logs](monitoring/logs/) |
46+
| Monitoring | [Validating database responsiveness](monitoring/monitoring/) |
47+
| Alerts | [Managing alerts](monitoring/alerts/) |
48+
| User Management | [Provisioning user accounts](system-access/user-management/)
4349

44-
## Navigating the interface structure
45-
46-
The WEM interface is organized into three functional areas:
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.
5050

5151
## Understanding user roles and permissions
5252

@@ -87,6 +87,26 @@ WEM streams live data into three primary charts:
8787

8888
Review the **Recent WHPG Log Alerts** card for WHPG log events. Open the **Logs** panel for a full audit trail.
8989

90+
## Configuring WEM settings
91+
92+
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:
93+
94+
1. **Method 1: Use the WEM settings tab**
95+
96+
Administrators can modify most operational parameters directly through the browser:
97+
1. Navigate to **User Management** > **Settings**.
98+
1. Update fields such as **Prometheus URL** or **Backup History Database Path**.
99+
1. Save to apply changes immediately.
100+
101+
!!! Note
102+
Some low-level system parameters are only accessible via the configuration file.
103+
104+
2. **Method 2: Edit the configuration file manually**
105+
106+
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:
107+
1. Stop the service: `systemctl stop wem` on the WEM host.
108+
1. Edit the file `/etc/wem/wem.conf` and modify the desired parameter.
109+
1. Restart the service: `systemctl start wem`.
90110

91111

92112

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ navigation:
88
- get-started
99
- monitoring
1010
- performance
11-
- security
11+
- system-access
1212
- troubleshooting
1313
- reference
1414
navRootedTo: /supported-open-source/warehousepg/
@@ -54,4 +54,4 @@ WEM introduces a robust suite of tools for the modern database administrator and
5454
- **Data protection**
5555
- **Backup & recovery:** Centralized monitoring of backup schedules, recovery points, and success rates.
5656

57-
- ***Canary checks:** Automated "heartbeat" tests that proactively verify cluster connectivity and query responsiveness.
57+
- **Canary checks:** Automated "heartbeat" tests that proactively verify cluster connectivity and query responsiveness.

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

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,13 @@ Edit the configuration file `/etc/wem/wem.conf` and configure the following para
5353

5454
1. To enable centralized alert handling and notifications with Alertmanager, configure the `ALERTMANAGER_URL` parameter to point to your Alertmanager endpoint.
5555

56-
1. Optionally, set the parameters `WEM_EXPORTER_LOG_LEVEL`, `WEM_EXPORTER_REMOTE_WRITE_INTERVAL`, and `WEM_EXPORTER_REMOTE_WRITE_TIMEOUT` for advanced configuration settings.
56+
1. Optionally, configure advanced settings to fine-tune logging and data transmission:
5757

58+
- `WEM_EXPORTER_LOG_LEVEL`: Sets the verbosity of the Exporter logs ((`debug`, `info`, `warn`, or `error`)) to assist with troubleshooting.
59+
60+
- `WEM_EXPORTER_REMOTE_WRITE_INTERVAL`: Defines how frequently (e.g., 15s, 1m, 5m) the Exporter pushes collected metrics to the remote storage.
61+
62+
- `WEM_EXPORTER_REMOTE_WRITE_TIMEOUT`: Specifies the maximum time (e.g., 30s, 1m, 2m) allowed for a data push to complete before the attempt is considered a failure.
5863

5964
### Configuring WEM portal access
6065

@@ -123,9 +128,16 @@ After starting the service, use these diagnostic tools to ensure all WEM compone
123128
```bash
124129
wem setup --verify
125130
```
131+
See [wem setup command reference](../reference/commands#wem-setup) for details.
126132

127133
- Perform a comprehensive "doctor" check to identify potential configuration errors, missing dependencies, or connectivity issues:
128134

129135
```bash
130136
wem doctor
131137
```
138+
139+
See [wem doctor command reference](../reference/commands#wem-doctor) for details.
140+
141+
142+
!!! Note Post-installation changes:
143+
If you need to modify your environment after the initial setup, refer to the [Configuring WEM settings](../get-started#configuring-wem-settings) section for the appropriate procedures and requirements.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Use the Alerts panel to integrate with Prometheus Alertmanager and
55
deepToC: true
66
---
77

8-
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.
8+
The **Alerts** panel on the left sidebar 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"
1111
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.

advocacy_docs/supported-open-source/warehousepg/wem/monitoring/cluster-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Use the Cluster Overview panel to monitor real-time WarehousePG clu
55
deepToC: true
66
---
77

8-
The **Cluster** panel provides a high-level summary of the WarehousePG (WHPG) cluster configuration and real-time health metrics. This panel is the primary starting point for verifying cluster availability and resource utilization.
8+
The **Cluster** panel on the left sidebar provides a high-level summary of the WarehousePG (WHPG) cluster configuration and real-time health metrics. This panel is the primary starting point for verifying cluster availability and resource utilization.
99

1010
### Confirming core cluster availability
1111

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Use the Log panel to access, filter, and analyze system and databas
55
deepToC: true
66
---
77

8-
The **Logs** panel serves as a centralized diagnostic hub. By consolidating internal database metrics with external log aggregation, it allows you to correlate system-level events with specific query failures.
8+
The **Logs** panel on the left sidebar serves as a centralized diagnostic hub. By consolidating internal database metrics with external log aggregation, it allows you to correlate system-level events with specific query failures.
99

1010
### Understanding log levels
1111

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ description: Use the Monitor panel to track proactive health indicators and auto
55
deepToC: true
66
---
77

8-
The **Monitoring** panel provides proactive verification of cluster health through automated canary checks. Unlike passive metrics, these checks execute active tasks to ensure the database engine is responding correctly and meeting performance baselines.
8+
The **Monitoring** panel on the left sidebar provides proactive verification of cluster health through automated canary checks. Unlike passive metrics, these checks execute active tasks to ensure the database engine is responding correctly and meeting performance baselines.
99

1010
### Performing proactive health checks: canary checks
1111

12-
Canary checks are recurring, automated scripts that simulate real-world operations to verify the end-to-end integrity of the system. You can configure these tests on the [User Management panel](../security/user-management).
12+
Canary checks are recurring, automated scripts that simulate real-world operations to verify the end-to-end integrity of the system. You can configure these tests on the [User Management panel](../system-access/user-management).
1313

1414
Use the **Canary Checks** tab to verify that the database can successfully execute core operations.
1515
- **Assess overall probe health:** Review the header metrics to get an instant snapshot of system integrity. Compare the **Successful** count against the **Total Checks** count to identify if a specific subset of your monitoring is failing.
1616
- **Verify scheduler activity:** Check the status of the scheduler to ensure it is running. This confirms that the WarehousePG Enterprise Manager (WEM) engine is actively triggering your background probes. If the scheduler is stopped, your health data will become stale and you will lose proactive visibility.
17-
- **Run health checks on demand:** Trigger an immediate execution of any check in the list to verify a fix or test real-time connectivity. While you must go to the [User Management panel](../security/user-management) to create or edit a check, the **Monitoring** panel allows you to run and stop them at any time to get an instant status update.
17+
- **Run health checks on demand:** Trigger an immediate execution of any check in the list to verify a fix or test real-time connectivity. While you must go to the [User Management panel](../system-access/user-management) to create or edit a check, the **Monitoring** panel allows you to run and stop them at any time to get an instant status update.
1818
- **Benchmark execution speed:** Monitor the **Average Duration** metric to establish a baseline for expected responsiveness. A sudden spike in this metric, even if checks are still successful, serves as an early warning of resource saturation or network latency.
1919
- **Investigate specific check failures:** Audit the **Health Checks** table to isolate the root cause of a failure. By checking which specific probe is non-passing, you can determine if the issue is a total service outage or a localized subsystem failure.
2020

advocacy_docs/supported-open-source/warehousepg/wem/monitoring/system-metrics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Use the System Metrics panel to track physical host metrics, identi
55
deepToC: true
66
---
77

8-
The **System Metrics** panel provides a comprehensive view of the hardware and database performance telemetry across the WarehousePG (WHPG) cluster. This data is essential for identifying resource saturation, diagnosing performance degradation, and performing capacity planning.
8+
The **System Metrics** panel on the left sidebar provides a comprehensive view of the hardware and database performance telemetry across the WarehousePG (WHPG) cluster. This data is essential for identifying resource saturation, diagnosing performance degradation, and performing capacity planning.
99

1010
### Monitoring real-time host health
1111

advocacy_docs/supported-open-source/warehousepg/wem/performance/backups.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Use the Backups panel to monitor data protection lifecycles, audit
55
deepToC: true
66
---
77

8-
The **Backups** panel serves as a centralized monitoring hub for your data protection lifecycle. Use these actions to verify the integrity of your snapshots and ensure that your recovery point objectives (RPO) are being met across the WarehousePG cluster.
8+
The **Backups** panel on the left sidebar serves as a centralized monitoring hub for your data protection lifecycle. Use these actions to verify the integrity of your snapshots and ensure that your recovery point objectives (RPO) are being met across the WarehousePG cluster.
99

1010
!!! Note
1111
This panel requires a functional `gpbackup_manager` utility configuration to display data.

0 commit comments

Comments
 (0)