Skip to content

Commit 986a2f2

Browse files
shalinisundarprakshshalinisundarpraksh
authored
Merge pull request #34 from relativitydev/REL-1158395-Rename-Alert-document
REL-1158395: Renamed alert-overview file
2 parents c3c4ffa + 169e509 commit 986a2f2

File tree

1 file changed

+130
-130
lines changed

1 file changed

+130
-130
lines changed

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

Lines changed: 130 additions & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -1,130 +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-
---
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+
---

0 commit comments

Comments
 (0)