Skip to content

Commit 9aa6bec

Browse files
Chaitan2681Chaitan2681
authored
Merge pull request #30 from relativitydev/REL-1143512-Create-Environment-Watch-Post-Install-Verification-Documentation
REL-1143512: EW Documentation - Create Environment Watch post install verification Documentation
2 parents 389213a + 6609739 commit 9aa6bec

27 files changed

Lines changed: 448 additions & 1 deletion

‎docs/environment-watch/post-install-verification/alerts-overview.md‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/environment-watch/post-install-verification/alerts.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Post-Install Verification for Alerts
2+
![Post-Install Verification Banner](../../../resources/post-install-verification-images/Post-installation-verification.svg)
3+
4+
## Table of Contents
5+
6+
- [Verify Dashboard Exists](#verify-dashboard-exists)
7+
- [Verify Dashboard Tag](#verify-dashboard-tag)
8+
- [Verify Health Indicators Are Displayed](#verify-health-indicators-are-displayed)
9+
- [Verify Individual Health Indicator Status](#verify-individual-health-indicator-status)
10+
- [Verify Dashboard in a Time Range](#verify-dashboard-in-a-time-range)
11+
12+
---
13+
> [!NOTE]
14+
> The below Health Indicators will be available from September 8th 2025 release.
15+
## Verify Dashboard Exists
16+
17+
**Description:**
18+
Ensure that the `[Relativity] Alerts Overview` dashboard is successfully installed and visible in Kibana.
19+
20+
**Steps:**
21+
1. Open **Microsoft Edge**.
22+
2. Navigate to Kibana.
23+
3. Go to **Observability → Dashboards**.
24+
4. Search for `[Relativity] Alerts Overview` in the dashboard list.
25+
26+
<details>
27+
<summary><strong>Expected Result</strong></summary>
28+
29+
- `[Relativity] Alerts Overview` appears in the dashboard list.
30+
- The dashboard is accessible without errors.
31+
</details>
32+
33+
**Screenshot:**
34+
![Screenshot: Dashboard listed in Kibana](../../../resources/post-install-verification-images/alerts-overview/dashboard-listed.png)
35+
36+
---
37+
38+
## Verify Dashboard Tag
39+
40+
**Description:**
41+
Confirm that the correct tag is applied to the dashboard for proper categorization.
42+
43+
**Steps:**
44+
1. In Kibana, go to **Observability → Dashboards**.
45+
2. Locate `[Relativity] Alerts Overview`.
46+
3. Verify that the tag `Relativity Environment Watch` is displayed.
47+
48+
<details>
49+
<summary><strong>Expected Result</strong></summary>
50+
51+
- The dashboard includes the `Relativity Environment Watch` tag.
52+
</details>
53+
54+
**Screenshot:**
55+
![Screenshot: Dashboard tag](../../../resources/post-install-verification-images/alerts-overview/dashboard-tag.png)
56+
57+
---
58+
59+
## Verify Health Indicators Are Displayed
60+
61+
**Description:**
62+
Ensure that the health indicators section is visible at the top of the dashboard and follows the correct layout.
63+
64+
**Steps:**
65+
1. Click into `[Relativity] Alerts Overview` dashboard.
66+
2. Confirm that the health indicators appear at the top of the main content area.
67+
3. Confirm all tiles include a **title**, **subtitle ("Healthy Alerts")**, and **color status**.
68+
69+
<details>
70+
<summary><strong>Expected Result</strong></summary>
71+
72+
- Health indicators are present and aligned at the top.
73+
- All indicators include:
74+
- Title (e.g., "Agents", "Monitoring")
75+
- Subtitle: *Healthy Alerts*
76+
- Color: Green or Red based on alert state.
77+
</details>
78+
79+
**Screenshot:**
80+
![Screenshot: Health indicators at top](../../../resources/post-install-verification-images/alerts-overview/health-indicators-overview.png)
81+
82+
---
83+
84+
## Verify Individual Health Indicator Status
85+
86+
**Description:**
87+
Verify the status and formatting of each health indicator tile, based on alert-driven logic and the color coding conventions.
88+
89+
**Steps:**
90+
1. Open the `[Relativity] Alerts Overview` dashboard.
91+
2. Locate each of the following indicators and confirm the title, subtitle, and color.
92+
93+
<details>
94+
<summary><strong>Expected Result</strong></summary>
95+
96+
- **Green** = No active alerts (Healthy)
97+
- **Red** = Active alerts present (Unhealthy)
98+
</details>
99+
100+
> [!NOTE]
101+
> All health indicators should display either Green or Red status after the initial wait period. If any health indicators aren't displaying correctly after waiting the full 10-15 minutes, verify that all related services are running properly and data collection is functioning correctly.
102+
103+
**Example Screenshot:**
104+
![All Health Indicators](../../../resources/post-install-verification-images/alerts-overview/all-health-indicators.png)
105+
106+
---
107+
108+
## Verify Dashboard in a Time Range
109+
110+
**Description:**
111+
Ensure that the dashboard is using a custom 15-minute time range as required for health indicators.
112+
113+
**Steps:**
114+
1. On the dashboard, locate the time filter at the top right.
115+
2. Click on the time range selector.
116+
3. Select **"Apply custom time range"**.
117+
4. Set the range to the **last 15 minutes**.
118+
5. Apply changes.
119+
120+
<details>
121+
<summary><strong>Expected Result</strong></summary>
122+
123+
- The time range reflects the last 15 minutes.
124+
- Health indicators update dynamically based on this range.
125+
</details>
126+
127+
**Screenshot:**
128+
![Screenshot: Time range 15 minutes](../../../resources/post-install-verification-images/alerts-overview/time-range-15-minutes.png)
129+
130+
---

‎docs/environment-watch/post-install-verification/elasticsearch-cluster-health.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# Post-Install Verification for Elastic Cluster Health
2+
![Post-Install Verification Banner](../../../resources/post-install-verification-images/Post-installation-verification.svg)
3+
4+
## Table of Contents
5+
6+
* [Verify Dashboard Exists](#verify-dashboard-exists)
7+
* [Verify Cluster Health Summary](#verify-cluster-health-summary)
8+
* [Verify Node Metrics](#verify-node-metrics)
9+
* [Verify Index Statistics](#verify-index-statistics)
10+
* [Verify Disk and Storage Utilization](#verify-disk-and-storage-utilization)
11+
12+
---
13+
> [!NOTE]
14+
> The below Cluster Dashboard will be available starting from September 8th 2025 release.
15+
## Verify Dashboard Exists
16+
17+
**Description:**
18+
Navigate to the Elasticsearch cluster health monitoring dashboard.
19+
20+
**Steps:**
21+
1. Navigate to Kibana.
22+
2. Go to **Dashboards → Monitoring Agent Dashboard** in the navigation panel.
23+
3. Click on **Cluster Overview**.
24+
4. Alternatively, visit this direct link: http://<hostname_or_ip>:5601/app/monitoring#
25+
26+
<details>
27+
<summary><strong>Expected Result</strong></summary>
28+
29+
- Successfully access the Elasticsearch monitoring dashboard.
30+
- Cluster health panels and metrics are visible.
31+
- Dashboard loads without errors.
32+
</details>
33+
34+
---
35+
36+
## Verify Cluster Health Summary
37+
38+
**Description:**
39+
Confirm cluster health status, total nodes, shards, indices, and document count are displayed and accurate.
40+
41+
**Steps:**
42+
1. Locate the **Cluster Health Summary** panel.
43+
2. Validate:
44+
- Cluster status (Green, Yellow, Red) — expect Green for healthy cluster.
45+
- Number of nodes.
46+
- Number of indices.
47+
- Total shards and unassigned shards.
48+
- Total documents.
49+
- Data size.
50+
51+
<details>
52+
<summary><strong>Expected Result</strong></summary>
53+
54+
- Cluster health is **Green (Healthy)**.
55+
- Nodes, shards, indices, and documents display current, non-zero values.
56+
- No unassigned shards.
57+
- Data size is displayed accurately.
58+
</details>
59+
60+
**Screenshot:**
61+
![Screenshot: Cluster Health Summary](../../../resources/post-install-verification-images/elasticsearch-cluster-health/cluster-health-summary.png)
62+
63+
---
64+
65+
## Verify Node Metrics
66+
67+
**Description:**
68+
Ensure node-level metrics such as CPU usage, JVM heap usage, and disk space are reported per node.
69+
70+
**Steps:**
71+
1. Open the **Node Metrics** or **Elasticsearch Nodes** panel.
72+
2. Confirm each node shows:
73+
- Status (Online).
74+
- CPU usage (percentage).
75+
- JVM heap usage (percentage).
76+
- Disk free space.
77+
- Load Average (may be unavailable, verify if data present).
78+
79+
<details>
80+
<summary><strong>Expected Result</strong></summary>
81+
82+
- All nodes listed.
83+
- CPU, JVM heap %, and disk free space values present.
84+
- Load average may show as N/A if unsupported but should be monitored for future inclusion.
85+
</details>
86+
87+
**Screenshot:**
88+
![Screenshot: Node Metrics](../../../resources/post-install-verification-images/elasticsearch-cluster-health/node-metrics.png)
89+
90+
---
91+
92+
## Verify Index Statistics
93+
94+
**Description:**
95+
Validate index-level metrics including document counts, data size, indexing rate, and search rate.
96+
97+
**Steps:**
98+
1. Open the **Indices** panel.
99+
2. Review per-index data such as:
100+
- Document count.
101+
- Data size.
102+
- Indexing rate (docs per second).
103+
- Search rate (queries per second).
104+
- Unassigned shards (should be zero).
105+
3. Check for any alerts or warnings on indices.
106+
107+
<details>
108+
<summary><strong>Expected Result</strong></summary>
109+
110+
- Per-index document counts and data sizes are populated.
111+
- Indexing and search rates update regularly.
112+
- No unassigned shards.
113+
- Alerts show clear or no issues on indices.
114+
</details>
115+
116+
**Screenshot:**
117+
![Screenshot: Index Statistics](../../../resources/post-install-verification-images/elasticsearch-cluster-health/index-stats.png)
118+
119+
---
120+
121+
122+
## Verify Disk and Storage Utilization
123+
124+
**Description:**
125+
Ensure disk free space and usage metrics are visible for each node.
126+
127+
**Steps:**
128+
1. Check disk free space shown per node in the **Node Metrics** panel.
129+
2. Confirm reported disk free space aligns with expectations.
130+
131+
<details>
132+
<summary><strong>Expected Result</strong></summary>
133+
134+
- Disk free space values displayed for all nodes.
135+
- No fields marked as N/A for disk metrics.
136+
</details>
137+
138+
**Screenshot:**
139+
![Screenshot: Disk and Storage Utilization](../../../resources/post-install-verification-images/elasticsearch-cluster-health/disk-storage-utilization.png)
140+
141+
---
142+

0 commit comments

Comments
 (0)