relativitydev · Nmaa75 · Oct 24, 2025
@@ -15,7 +15,7 @@ This release bundle contains packages that are required to set up or upgrade two
 | --------------------------------- | --------------------------------------------------------- |
 | Relativity Server                 | Server 2024 Patch 2                                       |
 | Elastic Stack                     | 8.17.3 is required for Environment Watch.<br/>7.17.x can be used but for Data Grid Audit only. |
-| Network Ports                     | Ensure required ports are open for Elastic Stack communication. [Refer to the port diagram](/docs/environment-watch/port-diagram.md) for full network configuration details. |
+| Network Ports                     | Ensure required ports are open for Elastic Stack communication. [Refer to the port diagram](docs/environment-watch/port-diagram.md) for full network configuration details. |
 
 
 ## Getting Started
@@ -24,4 +24,4 @@ This release bundle contains packages that are required to set up or upgrade two
 
 - **Upgrade**: [Click here for upgrade instructions](docs/environment_watch_upgrade.md).
 
-- **Troubleshooting**: [Click here for the troubleshooting guide](/docs/environment_watch_troubleshooting.md).
+- **Troubleshooting**: [Click here for the troubleshooting guide](docs/environment_watch_troubleshooting.md).
@@ -3,62 +3,47 @@
 
 This guide provides step-by-step instructions for installing/updating Relativity Analytics Engine (CAAT) along with the OpenTelemetry Java Agent. This enables distributed tracing and observability with minimal code changes.
 
-For other Other integrations, refer to the [Environment Watch Install other Integrations Guide](environment_watch_install_other_integrations.md).
+For other Other integrations, refer to the [Environment Watch Install other Integrations Guide](../environment_watch_install_other_integrations.md).
 
----
-
-## 1. Why Use `opentelemetry-javaagent`?
+## Why use opentelemetry-javaagent?
 
 - **Automatic Instrumentation:** The OpenTelemetry Java Agent automatically instruments supported libraries and frameworks, capturing telemetry data (traces, metrics, logs) without code changes.
 - **Observability:** It provides deep visibility into application performance, dependencies, and bottlenecks.
 - **Standardization:** OpenTelemetry is a vendor-neutral standard, ensuring compatibility with various observability backends (e.g., Azure Monitor, Jaeger, Zipkin).
 
----
+## Why Auto-Instrumentation is safe
 
-## 2. How to install/update CAAT
+- **Non-Intrusive:** The agent works by attaching to the JVM at startup, using bytecode manipulation. It does not require code changes or recompilation.
+- **Widely Adopted:** OpenTelemetry Java Agent is used in production by many organizations and is actively maintained.
+- **Configurable:** Instrumentation can be enabled/disabled for specific libraries, and the agent can be removed by simply omitting the `-javaagent` flag.
+- **No Persistent Changes:** The agent does not persistently modify your application or its dependencies.
 
-    1.  Copy CAAT Bundle to your server
-    2.  Unzip the folder
-    3.  Replace response-file.properties with master copy
-    4.  Open Powershell as an administrator
-    5.  Run .\Install.cmd
-    6.  Once the installation is done, start “Relativity Analytics Engine” and check if the page is loading.
-    7.  Open ElasticSearch and search for service.name: “relsvr_caat” in metrics-* data view
+## How to install/update CAAT
 
+1.  Copy CAAT Bundle to your server
+2.  Unzip the folder
+3.  Replace response-file.properties with master copy
+4.  Open Powershell as an administrator
+5.  Run `.\Install.cmd`
+6.  Once the installation is done, start **Relativity Analytics Engine** and check if the page is loading.
+7.  Open ElasticSearch and search for service.name: “relsvr_caat” in metrics-* data view
 
----
 
-## 3. What's updated
+## What's updated
 
-- Startup.cmd file is updated to include the OpenTelemetry Java Agent. This references the `opentelemetry-javaagent.jar` file, which is used to instrument the CAAT service for telemetry data collection.
+- The Startup.cmd file is updated to include the OpenTelemetry Java Agent. This references the `opentelemetry-javaagent.jar` file, which is used to instrument the CAAT service for telemetry data collection.
 - Check for these lines within `startup.cmd`:
-```
--javaagent:C:\\CAAT\\bin\\opentelemetry-javaagent.jar 
--Dotel.service.name="relsvr.caat" 
--Dotel.metrics.exporter=otlp 
--Dotel.exporter.otlp.endpoint="http://localhost:4318" 
--Dotel.instrumentation.runtime-metrics.enabled=true
-```
----
-
-## 4. Why Auto-Instrumentation is Safe
-
-- **Non-Intrusive:** The agent works by attaching to the JVM at startup, using bytecode manipulation. It does not require code changes or recompilation.
-- **Widely Adopted:** OpenTelemetry Java Agent is used in production by many organizations and is actively maintained.
-- **Configurable:** Instrumentation can be enabled/disabled for specific libraries, and the agent can be removed by simply omitting the `-javaagent` flag.
-- **No Persistent Changes:** The agent does not persistently modify your application or its dependencies.
+    ```
+    -javaagent:C:\\CAAT\\bin\\opentelemetry-javaagent.jar 
+    -Dotel.service.name="relsvr.caat" 
+    -Dotel.metrics.exporter=otlp 
+    -Dotel.exporter.otlp.endpoint="http://localhost:4318" 
+    -Dotel.instrumentation.runtime-metrics.enabled=true
+    ```
 
----
-
-## 5. How to Verify the Changes
+## How to verify the changes
 
 1. **Check Application Logs:** On startup, the agent logs its initialization. Look for lines mentioning `opentelemetry-javaagent` in the CAAT logs.
 2. **Verify Telemetry Export:** Confirm that traces and metrics are being sent to your configured backend (e.g., OpenTelemetry Collector, Jaeger, Azure Monitor).
 3. **Check Service Name:** Ensure the service appears as `caat-analytics-engine` (or your configured name) in your observability backend.
-4. **Disable to Compare:** Temporarily remove the `-javaagent` flag and confirm that telemetry stops, verifying the agent is responsible for the data.
-
----
-
-> [!NOTE]
-> This documentation uses the active document as context because you have the checkmark checked.  
-> You can include additional context using **#** references. Typing **#** opens a completion list of available context.
+4. **Disable to Compare:** Temporarily remove the `-javaagent` flag and confirm that telemetry stops, verifying the agent is responsible for the data.
@@ -1,4 +1,4 @@
-# Step 7: Create Kibana Users and Assign Roles
+# Create Kibana Users and Assign Roles
 
 ![Setup stage](../resources/createuserssetupstage.png)
 
@@ -13,18 +13,17 @@ To create a Kibana user and assign the custom Kibana role:
 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`).<br/>
-- **Password**: Set a strong password.<br/>
-- **Full name / Email address**: Optional but recommended.<br/>
+    - **Username**: A unique login name (e.g., `alerts_dashboard_user`).<br/>
+    - **Password**: Set a strong password.<br/>
+    - **Full name / Email address**: Optional but recommended.<br/>
 5. Under **Roles**, search for and assign the `relativity_dashboard_user` role.
 6. Click **Create user** to save.  
 ![](../resources/custom_kibana_role.png)
-
-> [!WARNING] 
-> **Important:** Users must log in with this account to access the Kibana dashboards and saved searches provided by Environment Watch.
 
----
+> [!WARNING]
+> 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](/docs/environment_watch_troubleshooting.md) for further assistance.
+You have reached the end of the setup process. If you are still running into any issues, please refer to the  [Troubleshooting Guides](environment_watch_troubleshooting.md) for further assistance.
@@ -3,17 +3,18 @@
 ![Setup Stage](../resources/enable_environmentwatch.png)
 
 > [!NOTE]
-> This section applies to Datagrid Only and the Audit setup via CLI should be run only once per environment.
+> This section applies to Datagrid Only.
+
+After installing the required Elastic components for Data Grid Audit, the integration between Elastic and Relativity is configured by running the Relativity Server CLI on the Primary SQL Server.
+
+
 > Please review the following important information before proceeding:
 > * **For Existing Data Grid Audit Customers:** You must be on Elasticsearch 7.17 when initially running this setup. After the setup is complete, you can upgrade to Elasticsearch 8.17.3.
 > * Before upgrading to Elasticsearch 8.17.3, the `ESIndexCreationSetting` may need to be updated. For details, refer to the [Instance setting Details](https://help.relativity.com/Server2024/Content/System_Guides/Instance_Setting_Guide/Instance_setting_descriptions.htm#ESIndexCreationSettings).
 > * Always verify the minimum required Elasticsearch version in your specific release bundle, as it may differ from the versions mentioned here.
 
-After installing the required Elastic components for Data Grid Audit, the integration between Elastic and Relativity is configured by running the Relativity Server CLI. It is recommended to run the CLI from the Primary SQL Server.
-
 ### Prerequisites 
 
-
 1. Install the mapper-size plugin on all nodes in the Elasticsearch cluster (instructions available [here](https://www.elastic.co/guide/en/elasticsearch/plugins/current/mapper-size.html)). The Elasticsearch service must also be restarted after installing the plugin.
 
 2. The Server-bundle zip file has been downloaded and extracted to `C:\Server.Bundle.x.y.z'
@@ -22,61 +23,59 @@ After installing the required Elastic components for Data Grid Audit, the integr
 
 
 
-#### Set up instructions
+### Set up instructions
 
 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. Run below command. Select Datagrid
-
-```
-C:\Server.Bundle.x.y.z\relsvr.exe setup
-
-Relativity Server CLI - 24.0.1196
-Copyright (c) 2025, Relativity ODA LLC
+1. Open elevated command prompt/powershell. Run below command. Select **Datagrid**
+    ```
+    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
-```
+    What would you like to setup?
+    > DataGrid
+      Environment watch
+      Exit
+    ```
 
-**Step 2** - Enter the required Relativity and Elasticsearch parameters.
+2. Enter the required Relativity and Elasticsearch parameters.
 
-```
-Confirm you would like to perform the 'DataGrid' setup [y/n] (y): y
+    ```
+    Confirm you would like to perform the 'DataGrid' setup [y/n] (y): y
 
-Existing settings do not exist
-Enter the Relativity admin username (relativity.admin@kcura.com): relativity.admin@kcura.com
-Enter the Relativity admin password: *********
-Enter the Relativity instance url (https://emttest/Relativity): https://emttest/Relativity
-Relativity instance is verified
-Enter the Elasticsearch admin username (elastic): elastic
-Enter the Elasticsearch admin password: *********
-Enter the Elasticsearch cluster endpoint URL (https://emttest:9200): https://emttest:9200
+    Existing settings do not exist
+    Enter the Relativity admin username (relativity.admin@kcura.com): relativity.admin@kcura.com
+    Enter the Relativity admin password: *********
+    Enter the Relativity instance url (https://emttest/Relativity): https://emttest/Relativity
+    Relativity instance is verified
+    Enter the Elasticsearch admin username (elastic): elastic
+    Enter the Elasticsearch admin password: *********
+    Enter the Elasticsearch cluster endpoint URL (https://emttest:9200): https://emttest:9200
 
-```
+    ```
 
-**Step 3** - Wait for Setup to Complete.
+3. Wait for Setup to Complete.
 
-```
-Elasticsearch cluster endpoint URL is verified
-Elasticsearch plugin verified
+    ```
+    Elasticsearch cluster endpoint URL is verified
+    Elasticsearch plugin verified
 
-API Key creation and validation completed ------------------------- 100%
-Relativity instance setting validation completed ------------------ 100%
-Relativity secret store updated ----------------------------------- 100%
-Elastic Stack settings validation completed ----------------------- 100%
-Relativity toggles validation completed --------------------------- 100%
+    API Key creation and validation completed ------------------------- 100%
+    Relativity instance setting validation completed ------------------ 100%
+    Relativity secret store updated ----------------------------------- 100%
+    Elastic Stack settings validation completed ----------------------- 100%
+    Relativity toggles validation completed --------------------------- 100%
 
-The Relativity Data Grid setup has been completed. Please restart all Relativity services, including "kCura Edds Agent Manager," "kCura Edds Web Processing Manager," and "kCura Service Host Manager" on each server contained within this Relativity instance to complete the setup.
-```
-If the setup completes successfully, Datagrid is now configured for the environment.
+    The Relativity Data Grid setup has been completed. Please restart all Relativity services, including "kCura Edds Agent Manager," "kCura Edds Web Processing Manager," and "kCura Service Host Manager" on each server contained within this Relativity instance to complete the setup.
+    ```
+
+    If the setup completes successfully, Datagrid is now configured for the environment.
 
-**Step 4** - Restart the Relativity services on all machines for the changes to take effect.
+4. Restart the Relativity services on all machines for the changes to take effect.
 
 
-**Step 5** - Verify Audit Dashboard
-Navigate to the Audit tab in the Relativity environment and confirm that the dashboard and its data are loading correctly.
+5. Verify Audit Dashboard - navigate to the Audit tab in the Relativity environment and confirm that the dashboard and its data are loading correctly.
 
 
 ## Next

@@ -127,9 +127,7 @@ The environment size is defined by the number of Web, Agent, and Worker servers
 | Medium          | 2-4           | 5-9           | 2-9     |
 | Large           | 5+            | 10+           | 10+     |
 
-<div style="border:2px solid #0078D4; background-color:#E6F4FF; padding:12px; margin-block-end:12px; font-size:1.1em; font-weight:bold; color:#0078D4; text-align:center;">
-Each Elasticsearch server should have at least <b>4 vCPU</b> and <b>32 GB RAM</b>.
-</div>
+> Each Elasticsearch server should have at least <b>4 vCPU</b> and <b>32 GB RAM</b>.
 
 #### Environment Size – Development
 
@@ -230,8 +228,8 @@ Each Elasticsearch server should have at least <b>4 vCPU</b> and <b>32 GB RAM</b
 
 #### Environment Size – Large
 
-<div class="note">For a large environment, Elasticsearch is scaled horizontally by adding more nodes to the cluster(s).</div>
-<br />
+> [!NOTE]
+> For a large environment, Elasticsearch is scaled horizontally by adding more nodes to the cluster(s).
 
 | Elastic Stack Component                   | Server Count           |
 | ----------------------------------------- | ---------------------- |
@@ -286,7 +284,7 @@ If you have used Elasticsearch for the optional Data Grid Audit feature on Relat
 
 3. **Verify the minimum supported version of Elastic** -  All Relativity products have been certified with Elastic Stack 8.17.x, though Data Grid Audit alone is supported on 7.17.x. If you intend to use a single cluster for both, you must install the same version of Elasticsearch on all nodes in the cluster, and that version must be the higher of the minimum versions for Environment Watch and Data Grid Audit, if different. 
 
-4. **At least the minimum Relativity major version and patch** specified in the Environment Watch bundle you intend to deploy is installed on all servers in the environment. See the [System Requirements](/README.md) for the minimum version required.
+4. **At least the minimum Relativity major version and patch** specified in the Environment Watch bundle you intend to deploy is installed on all servers in the environment. See the [System Requirements](../README.md) for the minimum version required.
 
 5. **At least the minimum supported version of Windows Server** for the major version of Relativity installed in your environment is installed on each target server in your cluster (see [here](https://help.relativity.com/Server2024/Content/System_Guides/Workstation_Configuration/User_hardware_and_software_requirements.htm)).