Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
7335f1c
REL-1158490- 1. Updated README to include links for upgrade and Fresh…
Divyavenkataraju Sep 1, 2025
0ebd914
REL-1158490: Added spacing for title in troubleshooting.md
Divyavenkataraju Sep 2, 2025
036e635
REL-1158490: Moved secret store verification details from troubleshoo…
Divyavenkataraju Sep 2, 2025
e2f55d0
REL-1158490: Added port and secret store troubleshooting links in ew_…
Divyavenkataraju Sep 2, 2025
4927725
REL-1158490: Removed duplicate title in Table of Contents for monitor…
Divyavenkataraju Sep 2, 2025
8ba2913
REL-1158490-Updated document with review comments shared by shalini
Divyavenkataraju Sep 2, 2025
849b685
REL-1158490: Rename port troubleshooting filename and reference links
Divyavenkataraju Sep 2, 2025
a567d77
REL-1158490:Updated review comments for README.md file
Divyavenkataraju Sep 2, 2025
717ac2d
REL-1158490- Added single pre-requisite troubleshooting file to inclu…
Divyavenkataraju Sep 2, 2025
687cd72
REL-1158490-Update troubleshooting documentation
Divyavenkataraju Sep 4, 2025
574a029
REL-1158490-Updated troubleshooting document with Review comments sha…
Divyavenkataraju Sep 4, 2025
cd05ca3
REL-1158490: Addressed review comments
Divyavenkataraju Sep 4, 2025
148f848
REL-1158490-Removed duplicate line in pre-installation
Divyavenkataraju Sep 5, 2025
e8bb1c5
REL-1158490: Included official OpenTelemetry documentation that descr…
Divyavenkataraju Sep 8, 2025
f181e63
REL-1158490: Updated review comments
Divyavenkataraju Sep 8, 2025
cef43ce
REL-1158490: updated port related table as per the review comments
Divyavenkataraju Sep 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Server Bundle Release

This bundle provides packages to set up two optional Relativity Server features:
This release bundle contains packages that are required to set up or upgrade two optional Relativity Server features:

- **Environment Watch**: [Click here to learn more about Environment Watch](docs/environment_watch_product_overview.md)

Expand All @@ -20,5 +20,8 @@ This bundle provides packages to set up two optional Relativity Server features:

## Getting Started

- [Environment Watch and Data Grid Audit Installation](docs/environment_watch_installation.md)
- [Troubleshooting Guide](/docs/environment_watch_troubleshooting.md)
- **First-Time Installation**: [Click here for installation instructions](docs/environment_watch_installation.md).

- **Upgrade**: [Click here for upgrade instructions](docs/environment_watch_upgrade.md).

- **Troubleshooting**: [Click here for the troubleshooting guide](/docs/environment_watch_troubleshooting.md).
4 changes: 2 additions & 2 deletions docs/datagrid_audit_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ After installing the required Elastic components for Data Grid Audit, the integr

Follow these steps to set up Data Grid Audit using the Relativity Server CLI. All setup will occur on the SQL Primary server.

**Step 1** - Open elevated command prompt/powershell. Navigate to the directory where the CLI is extracted, and run ".\relsvr.exe setup". Select Datagrid
**Step 1** - Open elevated command prompt/powershell. Run below command. Select Datagrid

```
C:\Server.Bundle.x.y.z> .\relsvr.exe setup
C:\Server.Bundle.x.y.z\relsvr.exe setup

Relativity Server CLI - 24.0.1196
Copyright (c) 2025, Relativity ODA LLC
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@

## Table of Contents

- [Post-Install Verification for Monitoring Agents](#post-install-verification-for-monitoring-agents)
- [Verify Monitoring Agent Dashboard Exists](#verify-monitoring-agent-dashboard-exists)
- [Verify Monitoring Agents Dashboard Tags](#verify-monitoring-agents-dashboard-tags)
- [Verify Dashboard Filters Populate with Data](#verify-dashboard-filters-populate-with-data)
- [Verify Data Population by Changing Filters and Time Ranges](#verify-data-population-by-changing-filters-and-time-ranges)
- [Verify Hosts and Agent Versions](#verify-hosts-and-agent-versions)
- [Verify Data in Discover](#verify-data-in-discover)
- [Verify Monitoring Agent Dashboard Exists](#verify-monitoring-agent-dashboard-exists)
- [Verify Monitoring Agents Dashboard Tags](#verify-monitoring-agents-dashboard-tags)
- [Verify Dashboard Filters Populate with Data](#verify-dashboard-filters-populate-with-data)
- [Verify Data Population by Changing Filters and Time Ranges](#verify-data-population-by-changing-filters-and-time-ranges)
- [Verify Hosts and Agent Versions](#verify-hosts-and-agent-versions)
- [Verify Data in Discover](#verify-data-in-discover)

---

Expand Down Expand Up @@ -149,5 +148,3 @@ Ensure dashboard data is reflected in Discover.
![Screenshot: Discover view 02](../../../resources/post-install-verification-images/monitoring-agents/discover-view.png)
---

## Next Step

18 changes: 11 additions & 7 deletions docs/environment_watch_troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# EnvironmentWatch Troubleshooting Guide
# Environment Watch Troubleshooting Guide

This document provides quick reference links to detailed troubleshooting guides for all components in the Relativity Server Bundle environment.

## Component Troubleshooting Guides

### [Elasticsearch Troubleshooting](troubleshooting/elasticsearch.md)
### [Pre-requisite Troubleshooting](troubleshooting/pre-requisite-troubleshooting.md)

### [Kibana Troubleshooting](troubleshooting/kibana.md)
### [Elasticsearch Troubleshooting](troubleshooting/elasticsearch.md)

### [APM Server Troubleshooting](troubleshooting/apm-server.md)
### [Kibana Troubleshooting](troubleshooting/kibana.md)

### [Environment Watch Monitoring Agent and Open Telemetry Collector Troubleshooting →](troubleshooting/monitoring-agent-and-otel-collector.md)
### [APM Server Troubleshooting](troubleshooting/apm-server.md)

### [Environment Watch Monitoring Agent and Open Telemetry Collector Troubleshooting](troubleshooting/monitoring-agent-and-otel-collector.md)

### [Relativity Server CLI Troubleshooting](troubleshooting/relativity-server-cli.md)

### [Relativity Alerts Troubleshooting](troubleshooting/relativity_alerts_troubleshooting.md)

### [Relativity Server CLI Troubleshooting →](troubleshooting/relativity-server-cli.md)

### [Relativity Alerts Troubleshooting →](troubleshooting/relativity_alerts_troubleshooting.md)


119 changes: 119 additions & 0 deletions docs/environment_watch_upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# Upgrade Environment Watch

This document provides the necessary steps to upgrade the Environment Watch components in a Relativity environment. It includes upgrading the Environment Watch using the CLI and upgrading the Environment Watch Installer.

## Upgrade CLI

This section guides you through upgrading Environment Watch using the Relativity Server CLI.

### Prerequisites

1. The new Server-bundle zip file has been downloaded and extracted to `C:\Server.Bundle.x.y.z`

### Upgrade Instructions

**Step 1** - Open elevated command prompt/powershell. Run the below command. Select Environment Watch.

```
C:\Server.Bundle.x.y.z\relsvr.exe setup

Relativity Server CLI - 24.0.1196
Copyright (c) 2025, Relativity ODA LLC

What would you like to setup?
DataGrid
> Environment watch
Exit
```

**Step 2** - Enter 'y' to proceed.
```
Confirm you would like to perform the 'Environment Watch' setup [y/n] (y): y
```

**Step 3** - The CLI will detect that setup has already been performed. Select the **Upgrade** option to proceed.

```
Setup is already performed. Select an option to proceed:
> Upgrade
Rerun Setup
Exit
```

**Step 4** - The CLI will retrieve the existing settings and perform the upgrade. Please wait for the process to finish.

```
Retrieved existing settings
The Relativity Environment Watch Kibana Upgrade setup is executing in silent or unattended mode.
API Key creation and validation completed ------------------------- 100%
OAuth2 client exists ---------------------------------------------- 100%
Relativity secret store updated ----------------------------------- 100%
Relativity logging updated ---------------------------------------- 100%
Relativity toggles updated ---------------------------------------- 100%
Relativity AppDomain monitoring enabled --------------------------- 100%
APM settings updated ---------------------------------------------- 100%
Elasticsearch indexes updated ------------------------------------- 100%
Kibana Tag imported ----------------------------------------------- 100%
Kibana IndexPattern imported -------------------------------------- 100%
Kibana SavedSearch imported --------------------------------------- 100%
Kibana Dashboard imported ----------------------------------------- 100%
Kibana Alert imported --------------------------------------------- 100%
Kibana Custom Role created. --------------------------------------- 100%
Relativity installation SQL record updated ------------------------ 100%

The Environment Watch setup has been completed. The Relativity Environment Watch installer package should now be installed within each server contained within this Relativity instance. As each server is setup for monitoring, restart all Relativity services within the machine including "kCura Edds Agent Manager," "kCura Edds Web Processing Manager," and "kCura Service Host Manager" to begin sending telemetry to Elasticsearch.
```

Successful completion indicates that Environment Watch is configured for the new version.

Refer to the [Troubleshooting Guide](troubleshooting/relativity-server-cli.md) if you encounter any issues.

---

## Upgrade Environment Watch Installer

This document outlines the steps to upgrade the Environment Watch monitoring agent. It is recommended to first upgrade the agent on the SQL Primary server, verify the installation, and then repeat the steps for all other servers in the environment.

### Prerequisites

1. The Environment Watch CLI upgrade has been completed.
2. The new Server-bundle zip file has been downloaded and extracted.

### Step 1: Install the Upgraded Monitoring Agent

1. From the new extracted Server Bundle, run `Relativity.EnvironmentWatch.Installer.xx.x.xxxx.exe`.
2. Accept the license terms and click **Install**.
3. Once the installation is complete, click **Close**.

### Step 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 updated in:
`C:\ProgramData\Relativity\EnvironmentWatch\Services\InfraWatchAgent\`

### Step 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 upgraded host.
![Host metrics visible in Kibana](../resources/Installer_hostmetric.png)
3. Navigate to the **[Relativity] Monitoring Agent** dashboard to verify:
- The monitoring agent version is updated to the new version.
- Host information and other important fields are properly reflected.
- Agent status and health metrics are showing current data.

### Step 4: Repeat Installation for Other Servers

After verifying the first upgrade, 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](troubleshooting/monitoring-agent-and-otel-collector.md).

4 changes: 2 additions & 2 deletions docs/relativity_server_cli_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@

### Set up instructions

**Step 1** - Open elevated command prompt/powershell. Navigate to the directory where the CLI is extracted, and run ".\relsvr.exe setup". Select Environment Watch
**Step 1** - Open elevated command prompt/powershell. Run the below command. Select Environment Watch

```
C:\Server.Bundle.x.y.z> .\relsvr.exe setup
C:\Server.Bundle.x.y.z\relsvr.exe setup

Relativity Server CLI - 24.0.1196
Copyright (c) 2025, Relativity ODA LLC
Expand Down
Loading