Relativity Environment Watch installation

Summary

The Relativity Environment Watch installer package contains a monitoring agent (rel-infrawatch-agent.exe) that collects and transmits telemetry data to Elastic and a Windows service (rel-envwatch-service.exe) that is responsible for launching the monitoring agent process and enables monitoring agent auto-upgrade process. You will install this package on all hosts in your environment that you want to monitor.

Prerequisites

• Elasticsearch, Kibana, and APM Server have been fully set up in accordance with stage 1 of the Environment Watch installation guide.
• Environment Watch has been set up using the Relativity Server CLI and Elastic certificates are installed on all Relativity servers in accordance with stage 2 of the Environment Watch installation guide.
• The Environment Watch monitoring agent must be installed on a supported Windows Server OS including Windows Server 2022, Windows Server 2019, Windows Server 2016. Please see here for information on Windows Server compatibility for Relativity Server.
• Whitelisted for Secret Store access. Please see here for information on whitelisting
• SQL Primary and Distributed access
• Relativity access
• The minimum Relativity major version and patch is installed on all servers in the environment. See the release bundle requirements for the minimum version required.

Setup

Downloading the Environment Watch installer

Download the Server.Bundle.v20xx.yy.zz.gold.zip and extract the ZIP contents to a local directory if this hasn't been done already.

Install the Environment Watch monitoring agent and Windows service on each host

The objective is to first ensure that SQL Primary monitoring is working and confirming metrics are being transmitted to the telemetry backend. After verifying, proceed with installing on all hosts within your Relativity environment that needs to be monitored.

Steps to install Environment Watch

1. Double-click on Relativity.EnvironmentWatch.Installer.xx.x.xxxx.exe or run below command to launch the installer.
   
   Copy

    .\Relativity.EnvironmentWatch.Installer.xx.x.xxxx.exe /log InstallLog.log RELSERVICEACCOUNTUSERNAME="********" RELSERVICEACCOUNTPASSWORD="********"

2. Provide Relativity Service Account details
   1. If any Relativity product(s) have already been installed on the host, existing Relativity Service Account details can be used. In this case, entering the details can be skipped. Otherwise, to configure this service with a different account, please check Configure this Windows service to authenticate with a different user account checkbox and provide Relativity Service Account details
   The Relativity Service Account must be provided when Relativity product is not installed on the host.
3. To specify an installation location, follow the below steps
   1. Click on Options
      
   2. Click Browse to select a directory for the application installation
   3. Click OK.
4. Agree Relativity Environment Watch license terms and conditions
5. Click Install on the setup wizard to start the installation.
6. Click Close when the installation has been completed.

Install Environment Watch in silent mode

Silent mode can be used to run the Environment Watch installer through the command line. Open a command prompt or power shell and run the command below

.\Relativity.EnvironmentWatch.Installer.xx.x.xxxx.exe /silent /log InstallLog.log

use below command to provide Relativity Service Account in silent mode

.\Relativity.EnvironmentWatch.Installer.xx.x.xxxx.exe RELSERVICEACCOUNTUSERNAME="********" RELSERVICEACCOUNTPASSWORD="********"  /silent /log InstallLog.log

Verification

Upon successful installation, it will create a Relativity Environment Watch windows service and it will start automatically.

• The service status should be Running.
• The service runs using the supplied Relativity Service Account.

• The following processes should be running:
  • rel-envwatch-service.exe
  • rel-infrawatch-agent.exe
  • otelcol-relativity.exe
• Logfiles should appear within C:\ProgramData\Relativity\EnvironmentWatch\Services\InfraWatchAgent\Logs

Verify metrics are flowing to the Elasticsearch Open Telemetry backend

• Go to Kibana --> Dashboards
• Open [Relativity] Host Infrastructure Overview dashboard
• Verify CPU/RAM/Disk metrics are visible for this host
  

After successful verification, proceed with the same installation steps for the next server and continue until all servers to be monitored are available with metrics in the above dashboard

The following sequence is suggested:

1. SQL Distributed
2. Web Servers
3. Agent servers
4. Other (Fileshare, Analytics, Message Broker, Worker, etc.)

Repairing or removing Environment Watch installation

The installer can also be run to repair or remove an existing installation of Environment Watch. Run the installer on a machine where the application is installed. Select one of the following options:

• Repair - attempts to fix errors in the most recent installation.
• Uninstall - removes Relativity Environment Watch from the machine.

Installer logfile

During the installation process, two log files are created in the %TEMP% directory that can assist with troubleshooting:

• Bundle logfile (Relativity_Environment_Watch_.log)
  • This log file contains information about the overall installation process handled by the installer bundle. It generally doesn't disclose specific problems and is often less useful when troubleshooting individual installation issues.
• MSI logfile (Relativity_Environment_Watch__000_Relativity.EnvironmentWatch.Setup.msi.log)
  • This log file records detailed information about the Windows Installer (MSI) execution. It is typically the most useful log for diagnosing issues, as it provides granular details about the installation process, including any errors or failures.
    

Handling errors

If any errors are encountered during the installation process, please refer to the troubleshooting guide to resolve the issues.

Next steps

Click here to Install Relativity Alerts Application