Install Environment Watch Monitoring Agents

This document outlines the steps to install the Environment Watch monitoring agent.

Prerequisites

• For Install certificates from the BCP share (default): elastic-certs.zip is on the BCP share at <BCP share>\EnvironmentWatch\, for example \\<sql-primary>\BCPPath\EnvironmentWatch\elastic-certs.zip. To find the BCP path, open the Server tab in Relativity and check the BCP path of the SQL - Primary server. For details, see Custom JSON Troubleshooting.
• For Use existing Elastic certificates: the Elastic CA certificate is already installed in Local Machine > Trusted Root Certification Authorities on the server. See Elastic certificate setup.
• Read access to elastic-certs.zip for the computer account of the server (DOMAIN\<server>$) or the Domain Computers group, when you select Install certificates from the BCP share. The installer reads the share as the Local System account, not as the Relativity Service Account.
• Access to Elastic Stack, Primary SQL Server, and Secret Store (Whitelisted for Secret Store access. For information on whitelisting, see Configuring clients.)
• The Server-bundle zip file has been downloaded and extracted to C:\Server.Bundle.x.y.z
• Environment Watch has been set up using the Relativity Server CLI
• LDAP port 389 (TCP) must be open from the target server to the domain controller(s), per the Default Port Reference table. The Environment Watch Installer uses this port to validate the Relativity Service Account. If the installer fails on this check, see Domain Controller Unreachable.
• The Relativity Service Account credentials, if Relativity is not installed on the server or if you want to use a different service account (see step 2 of Install the Monitoring Agent).

Steps

Install the Monitoring Agent

1. From the extracted Server Bundle, run Relativity.EnvironmentWatch.Installer.xx.x.xxxx.exe. The license page opens.
2. Click Options on the license page to open the options page. Click OK to save your selections and return to the license page, or Cancel to leave the installer. The options page has the following settings:
   • Installation Folder (optional): The folder where Environment Watch is installed. Use Browse to choose a different folder.
   • Service Account: By default the installer uses the Relativity Service Account. To use other credentials, select Use a custom service account, then enter the Username (domain\Username) and Password. The fields are enabled only when the option is selected. The service account must be provided here when Relativity is not installed on the host.
   • Elastic Certificate Setup: Environment Watch communicates with Elasticsearch, APM Server, and Kibana over TLS, so the server must trust the Elastic CA certificate. This setting controls whether the installer installs the certificate or uses one that is already in place. Keep the default option when elastic-certs.zip is on the BCP share. Otherwise, select Use existing Elastic certificates. The options are described in Elastic certificate setup.
3. Select I accept the license terms and conditions. The Install button is disabled until the license terms are accepted.
4. Click Install. The installer validates the prerequisites and sets up the Elastic certificates before it installs any file. If a check fails, an error message appears and the installation stops. See the Monitoring Agent Troubleshooting Guide.
5. After the installation completes, click Close.

Verify the Installation

• Open Services and verify that the Relativity Environment Watch service is running.

  

• Open Task Manager and verify that the following processes are running:

  • rel-envwatch-service.exe
  • rel-infrawatch-agent.exe
  • otelcol-relativity.exe

• Verify that new log files are created in the following folder:

  Copy

  C:\ProgramData\Relativity\EnvironmentWatch\Services\InfraWatchAgent\Logs
  

• Verify that the otelcol-config-auto-generated.yaml configuration file is generated in the following folder:

  Copy

  C:\ProgramData\Relativity\EnvironmentWatch\Services\InfraWatchAgent\
  

• If you selected Install certificates from the BCP share, verify that the Elastic CA certificate is listed in Local Machine > Trusted Root Certification Authorities (certlm.msc) and that the files listed in Install certificates from the BCP share (default) exist.

Verify Metrics in Kibana

1. In Kibana, navigate to Dashboards and open the [Relativity] Host Infrastructure Overview dashboard.

2. Verify that CPU, RAM, and Disk metrics are visible for the newly added host.

   

3. Open the [Relativity] Monitoring Agent dashboard and verify the following:

   • The installed monitoring agent version is displayed correctly.
   • Host information and other important fields are displayed correctly.
   • Agent status and health metrics show current data.

Repeat the Installation on Other Servers

After verifying the first installation, repeat these steps for the remaining servers in the following order:

1. SQL Distributed Servers
2. Web Servers
3. Agent Servers
4. Other Servers (for example, File Share, Analytics, and Worker servers)

Elastic certificate setup

The installer can install the certificate authority (CA) certificate for you, or use certificates that are already in place. Select one of the following options in the Elastic Certificate Setup section of the options page.

Options overview

Option	Use when	What the installer does	Registry result
Install certificates from the BCP share (default)	elastic-certs.zip is on the BCP share (generated with relsvr.exe generate-certs, or with relsvr.exe install for a multi-node Elastic Stack).	Reads elastic-certs.zip from <BCP share>\EnvironmentWatch\, copies the CA certificate to the Elasticsearch, APM Server, and Kibana certificate folders, and imports it into the Local Machine > Trusted Root Certification Authorities store. Then validates the Elastic Stack connection over TLS.	ConfiguredBy=ZipInstalled
Use existing Elastic certificates	The Elastic CA certificate is already installed on this server (for example, by your own automation), or elastic-certs.zip is not available (for example, the Elastic Stack was installed in the default all-in-one mode, which does not produce this file).	Does not install any certificate. Validates the Elastic Stack connection over TLS.	ConfiguredBy=External
Skip certificate setup (appears only when Use existing Elastic certificates is selected)	TLS is already configured for all Elastic components and you do not want the installer to validate the Elastic Stack.	Skips all certificate setup and the Elastic Stack validation.	No registry entry is written

If an installation fails at the Elastic Stack validation, the ElasticCerts registry key remains, because the installer writes the key before the validation and does not remove it when the validation fails. On the next run the installer skips the certificate installation, whichever certificate option is selected. To select a different option after a failed installation, delete the key first. For the steps, see Elastic Stack validation failed after the certificate setup.

Install certificates from the BCP share (default)

When this option is selected, the installer copies the CA certificate (ca.crt in the archive) to the following files. The Elasticsearch copy is named http_ca.crt:

Component	Destination
Elasticsearch	C:\elastic\elasticsearch\config\certs\http_ca.crt
APM Server	C:\elastic\apm-server\certs\ca.crt
Kibana	C:\elastic\kibana\config\certs\ca.crt

Use existing Elastic certificates

Select this option when the Elastic CA certificate is already installed on the server. The installer does not install any certificate.

The installer validates the Elastic Stack over TLS using the Windows certificate store, so the CA certificate must be in Local Machine > Trusted Root Certification Authorities. To check, open certlm.msc, expand Trusted Root Certification Authorities > Certificates, and verify that the Elastic CA certificate (the CA certificate file, ca.crt or http_ca.crt) is listed. To add it, import the CA certificate file into this store.

Skip certificate setup

The Skip certificate setup check box appears only after you select Use existing Elastic certificates. Select it to skip all certificate setup and the Elastic Stack validation.

Next Step

Click here for the next step