Skip to content

ew-01-install-monitoring-agents.md

Latest commit

 

History

History
68 lines (51 loc) · 4.36 KB

ew-01-install-monitoring-agents.md

File metadata and controls

68 lines (51 loc) · 4.36 KB
Raw

Install Environment Watch Monitoring Agents

Note

This step is required for Environment Watch. The Environment Watch monitoring agent installation should start on the SQL Primary server, verify the installation, and then be applied to other servers in the environment. This ensures proper setup and validation before deploying across all servers.

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

Prerequisites

  • Elastic Stack Certificates are installed on all Servers
  • Access to Elastic Stack, Primary SQL Server, and Secret Store (Whitelisted for Secret Store access. Please see here for information on whitelisting.)
  • 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
  • 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.
  • 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.

Note

The LDAP port requirement above applies only during install/upgrade of the monitoring agent, to validate the service account against the domain controller. It is not required during normal runtime of the Environment Watch service.

Steps

  1. Install the Monitoring Agent

    1. From the extracted Server Bundle, run Relativity.EnvironmentWatch.Installer.xx.x.xxxx.exe.

    2. If prompted, enter the Relativity Service Account credentials as:

      • Username: domain\Username
      • Password: {password}

      This step may be skipped if other Relativity products are already installed.

    3. (Optional) To specify a custom installation path, click Options, browse to your desired directory, and click OK.

    4. Accept the license terms and click Install.

    5. Once the installation is complete, click Close.

  2. Verify the Installation

    1. Open Services and confirm the Relativity Environment Watch service is running.
    2. Open Task Manager and verify the following processes are running:
      • rel-envwatch-service.exe
      • rel-infrawatch-agent.exe
      • otelcol-relativity.exe
    3. Check for new log files in C:\ProgramData\Relativity\EnvironmentWatch\Services\InfraWatchAgent\Logs.
    4. Verify that the otelcol-config-auto-generated.yaml configuration file is generated in: C:\ProgramData\Relativity\EnvironmentWatch\Services\InfraWatchAgent\

  3. Verify Metrics in Kibana

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

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

      Host metrics visible in Kibana

    3. Navigate to the [Relativity] Monitoring Agent dashboard to verify that:

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

  4. Repeat Installation 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 (e.g., File Share, Analytics, Worker)

Note

For troubleshooting, refer to the installer logs in the %TEMP% directory or see the Monitoring Agent Troubleshooting Guide.

Next Step

Click here for the next step