You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Relativity Alerts application is a new application as part of the Relativity Environment Watch suite. Its main functionality is to alert Relativity System Administrators to a variety of Environmental and Application related issues on a Relativity instance within Relativity web interface. It replaces a previous “Legacy Alerts” functionality with a new OTEL based implementation with ELK backend. It allows in real time to notify Relativity System Administrators about issues, redirect them to easily readable dashboards with performance and health information, as well as accompanied by a comprehensive resolution guidelines.
@@ -13,9 +14,9 @@ The Relativity Alerts application is a new application as part of the Relativity
13
14
## Prerequisites
14
15
Requirements for installation of the Relativity Alerts Application:
15
16
• Relativity Server 2024 Patch 1 release.
16
-
• Configure [Elasticsearch, Kibana, and APM server](https://github.com/relativityone/server-environment-watch-releases/blob/main/docs/elasticsearch_setup.md) in an environment.
17
-
• Run the one-time [CLI setup](https://github.com/relativityone/server-environment-watch-releases/blob/main/docs/cli_environmentwatch_setup.md) for Environment Watch.
18
-
• Install [Relativity Environment Watch Agent](https://github.com/relativityone/server-environment-watch-releases/blob/main/docs/environmentwatch_installer.md) in an environment.
17
+
• Configure [Elasticsearch, Kibana, and APM server](https://github.com/relativitydev/server-bundle-release/blob/main/docs/elasticsearch_setup.md) in an environment.
18
+
• Run the one-time [CLI setup](https://github.com/relativitydev/server-bundle-release/blob/main/docs/cli_environmentwatch_setup.md) for Environment Watch.
19
+
• Install [Relativity Environment Watch Agent](https://github.com/relativitydev/server-bundle-release/blob/main/docs/environment_watch_installer.md) in an environment.
19
20
20
21
## Permissions
21
22
* To install the application, access it, and receive alerts, the user must be part of the Relativity System Administrators Group.
@@ -27,54 +28,54 @@ To install the Relativity Alerts application on your Relativity instance:
27
28
2. Navigate to the Application Library tab.
28
29
3. Click Upload Application.
29
30
4. Click Select File.
30
-
5. Navigate to and select your local copy of Relativity Alerts RAP file which was downloaded from the latest [Environment Watch Bundle](https://github.com/relativityone/server-environment-watch-releases/releases), and then click Open.
31
+
5. Navigate to and select your local copy of Relativity Alerts RAP file which was downloaded from the latest [Environment Watch Bundle](https://github.com/relativitydev/server-bundle-release/releases), and then click Open.
31
32
6. Click Save to upload the file to the Application Library.
3. When on "Logs & Dashboards" tab, find "Alerts Overview" dashboard and click the link. A new web browser tab will be created and you should be redirected to "Alerts Overview" dashboard in Kibana. If you have not loged in into Kibana yet, you will be prompted with a Kibana login page. Please login with your Kibana user account with [relativity_dashboard_user](<put a link here>) privileges.
* Click on the question mark icon next to the 'One or more agents are disabled' alert, and you will be redirected to the resolution guidance for this alert in a new tab of your web browser.
* Return to the previous tab in Relativity, then click on the bell icon in the top-right corner. When the alert flyout opens, click on the 'One or more agents are disabled' alert, and you will be redirected to a filtered list of disabled agents in the Agents tab within Relativity.
Copy file name to clipboardExpand all lines: docs/relativity_alerts_troubleshooting.md
+36-36Lines changed: 36 additions & 36 deletions
Original file line number
Diff line number
Diff line change
@@ -8,31 +8,31 @@ This guide will help you resolve common issues that may arise during the install
8
8
9
9
### During Installation
10
10
11
-
### Issue: "Relativity Alert object data is unavailable or stale because Environment Watch is not currently enabled in this instance. Please see {doc page} for instructions on how to deploy and enable Environment Watch." error is displayed.
### Issue 1: "Relativity Alert object data is unavailable or stale because Environment Watch is not currently enabled in this instance. Please see {doc page} for instructions on how to deploy and enable Environment Watch." error is displayed.
1. Relativity Server CLI First-Time Setup not executed properly.
16
16
17
17
#### Steps to troubleshoot:
18
18
1. Please execute the Relativity Server CLI first time setup again to resolve this issue.
19
19
20
-
### Issue: "This operation cannot be completed because an HTTP request to the Elasticsearch server failed. Please try again. If the issue persists, ensure that the Elasticsearch server is accessible and the configuration is correct." error is displayed.
### Issue 2: "This operation cannot be completed because an HTTP request to the Elasticsearch server failed. Please try again. If the issue persists, ensure that the Elasticsearch server is accessible and the configuration is correct." error is displayed.
Once these steps are completed, the "Alert Manager" agent should now be active and functioning correctly.
54
54
55
-
### Issue: "The Alert Manager agent is unable to retrieve current alert state information from Kibana. Please ensure that the Alert Manager agent is enabled. To see accurate alert state information please navigate to Kibana." error is displayed.
### Issue 4: "The Alert Manager agent is unable to retrieve current alert state information from Kibana. Please ensure that the Alert Manager agent is enabled. To see accurate alert state information please navigate to Kibana." error is displayed.
Once these steps are completed, the "Alert Manager" agent should now be Enabled and functioning correctly.
71
71
72
-
### Issue: "The Alert Manager agent interval is currently set to more than 15 minutes. If you want alert state information to be retrieved from Kibana more frequently, please update the agent interval." warning is displayed.
### Issue 5: "The Alert Manager agent interval is currently set to more than 15 minutes. If you want alert state information to be retrieved from Kibana more frequently, please update the agent interval." warning is displayed.
2. Relativity Server CLI First-Time Setup not executed properly.
92
+
####This error occurs for the following reasons:
93
+
1. Missing Setup of Elastic/Kibana/APM Servers.
94
+
2. Relativity Server CLI First-Time Setup not executed properly.
95
95
96
96
#### Steps to troubleshoot:
97
97
1. Ensure that the ElasticSearch, Kibana, and APM Servers are up and running. Verify that these services are properly started and accessible.
98
98
2. Re-run the Relativity Server CLI first-time setup. It may be necessary to execute the setup again to resolve any configuration issues or missing components related to the integration.
99
99
100
-
### Issue: "The user does not have permission to perform this action." error is displayed.
1. User doesn't have System Administrator permissions.
103
+
####This error occurs for the following reason:
104
+
1. User doesn't have System Administrator permissions.
105
105
106
106
#### Steps to troubleshoot:
107
107
1. Please verify that user has the System Administrator permissions to perform the required actions.
108
108
109
-
### Issue: "Relativity Alert object data is unavailable or stale because Environment Watch is not currently enabled in this instance. Please see {doc page} for instructions on how to deploy and enable Environment Watch" error is displayed.
### Issue 8: "Relativity Alert object data is unavailable or stale because Environment Watch is not currently enabled in this instance. Please see {doc page} for instructions on how to deploy and enable Environment Watch" error is displayed.
0 commit comments