Install Relativity Alerts

This step is required for Environment Watch.

Summary

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 Open Telemetry based implementation with Elastic Stack 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.

Permissions

  • To install the application, access it, and receive alerts, the user must be part of the Relativity System Administrators Group.
  • To access Kibana dashboards and saved searches a new account must be created for each user and be assigned to the custom Kibana role which is installed during the Environment Watch CLI setup. See Create Kibana Users for Dashboard Access for more information.

Installation

To install the Relativity Alerts application on your Relativity instance:

  1. Log in to Relativity as a System Administrator.

  2. Navigate to the Application Library tab.

  3. Click Upload Application
    relativity_alerts_installation_001

  4. Click Select File.
    relativity_alerts_installation_002

  5. The Environment Watch bundle contains a RAPs folder with subfolders organized by Relativity Server version. Each subfolder Server202X contains the corresponding Relativity Alerts RAP file for that Relativity Server version.

    relativity_alerts_installation_007

    Navigate to the subfolder that matches your Relativity Server version, select the Relativity Alerts RAP file, and then click Open.
    relativity_alerts_installation_003

  6. Click Save to upload the file to the Application Library.
    relativity_alerts_installation_004relativity_alerts_installation_005relativity_alerts_installation_006

A list of common install issues and their resolutions are available at the troubleshooting guide.

Verification

  1. Navigate to the Alerts tab, you should see all alerts available in Kibana.
    relativity_alerts_verification_001

  2. Navigate to Logs & Dashboards tab, you should see all Environment Watch dashboards and saved searches available in Kibana.
    relativity_alerts_verification_002

  3. When on Logs & Dashboards tab, find **Alerts Overview88 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 logged in into Kibana yet, you will be prompted with a Kibana login page. Please login with your Kibana user account with privileges.
    relativity_alerts_verification_003_001relativity_alerts_verification_003_002relativity_alerts_verification_003_003

  4. To confirm that the alerting functionality is operational, please do the following:

    1. Go to the Agents tab

    2. Select File Deletion Manager agent and disable it.
      relativity_alerts_verification_004_001

    3. Within the next 30-60 seconds, the bell icon, in the top-right corner, will indicate that there is a new Alert.
      relativity_alerts_verification_004_002

    4. Click on the bell icon, and you should be able to see the active One or more agents are disabled alert in the alert flyout.
      relativity_alerts_verification_004_003

    5. 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.
      relativity_alerts_verification_004_004
      relativity_alerts_verification_004_005

    6. 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.
      relativity_alerts_verification_004_006

    7. While on Agents tab, please remember to enable the File Deletion Manager agent.

If any of the previous steps have failed, or any errors were displayed, please see troubleshooting guide for more information.

Create Kibana Users and Assign Roles

To access Kibana dashboards and saved searches, a new account must be created for each user and be assigned to the custom Kibana role that was installed during the Environment Watch CLI setup.

Creating Kibana Users with Dashboard Access

To create a Kibana user and assign the custom Kibana role:

  1. Log in to Kibana as a user with administrative privileges.
  2. Navigate to Stack Management > Security > Users.
  3. Click Create user.
  4. Fill out the following:
    • Username: A unique login name (e.g., alerts_dashboard_user).
    • Password: Set a strong password.
    • Full name / Email address: Optional but recommended.
  5. Under Roles, search for and assign the relativity_dashboard_user role.
  6. Click Create user to save.

Users must log in with this account to access the Kibana dashboards and saved searches provided by Environment Watch.

Congratulations!

You have reached the end of the setup process. If you are still running into any issues, please refer to the Troubleshooting Guides for further assistance.

Next Step

Click here for the next step

Return to top of the page
Feedback