You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| Elastic Stack | 8.17.3 is required for Environment Watch.<br/>7.17.x can be used but for Data Grid Audit only. |
18
-
| 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. |
18
+
| 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. |
19
19
20
20
21
21
## Getting Started
@@ -24,4 +24,4 @@ This release bundle contains packages that are required to set up or upgrade two
24
24
25
25
-**Upgrade**: [Click here for upgrade instructions](docs/environment_watch_upgrade.md).
26
26
27
-
-**Troubleshooting**: [Click here for the troubleshooting guide](/docs/environment_watch_troubleshooting.md).
27
+
-**Troubleshooting**: [Click here for the troubleshooting guide](docs/environment_watch_troubleshooting.md).
Copy file name to clipboardExpand all lines: docs/analytics/caat_environment_watch_setup.md
+26-41Lines changed: 26 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,62 +3,47 @@
3
3
4
4
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.
5
5
6
-
For other Other integrations, refer to the [Environment Watch Install other Integrations Guide](environment_watch_install_other_integrations.md).
6
+
For other Other integrations, refer to the [Environment Watch Install other Integrations Guide](../environment_watch_install_other_integrations.md).
7
7
8
-
---
9
-
10
-
## 1. Why Use `opentelemetry-javaagent`?
8
+
## Why use opentelemetry-javaagent?
11
9
12
10
-**Automatic Instrumentation:** The OpenTelemetry Java Agent automatically instruments supported libraries and frameworks, capturing telemetry data (traces, metrics, logs) without code changes.
13
11
-**Observability:** It provides deep visibility into application performance, dependencies, and bottlenecks.
14
12
-**Standardization:** OpenTelemetry is a vendor-neutral standard, ensuring compatibility with various observability backends (e.g., Azure Monitor, Jaeger, Zipkin).
15
13
16
-
---
14
+
## Why Auto-Instrumentation is safe
17
15
18
-
## 2. How to install/update CAAT
16
+
-**Non-Intrusive:** The agent works by attaching to the JVM at startup, using bytecode manipulation. It does not require code changes or recompilation.
17
+
-**Widely Adopted:** OpenTelemetry Java Agent is used in production by many organizations and is actively maintained.
18
+
-**Configurable:** Instrumentation can be enabled/disabled for specific libraries, and the agent can be removed by simply omitting the `-javaagent` flag.
19
+
-**No Persistent Changes:** The agent does not persistently modify your application or its dependencies.
19
20
20
-
1. Copy CAAT Bundle to your server
21
-
2. Unzip the folder
22
-
3. Replace response-file.properties with master copy
23
-
4. Open Powershell as an administrator
24
-
5. Run .\Install.cmd
25
-
6. Once the installation is done, start “Relativity Analytics Engine” and check if the page is loading.
26
-
7. Open ElasticSearch and search for service.name: “relsvr_caat” in metrics-* data view
21
+
## How to install/update CAAT
27
22
23
+
1. Copy CAAT Bundle to your server
24
+
2. Unzip the folder
25
+
3. Replace response-file.properties with master copy
26
+
4. Open Powershell as an administrator
27
+
5. Run `.\Install.cmd`
28
+
6. Once the installation is done, start **Relativity Analytics Engine** and check if the page is loading.
29
+
7. Open ElasticSearch and search for service.name: “relsvr_caat” in metrics-* data view
28
30
29
-
---
30
31
31
-
## 3. What's updated
32
+
## What's updated
32
33
33
-
- 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.
34
+
-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.
-**Non-Intrusive:** The agent works by attaching to the JVM at startup, using bytecode manipulation. It does not require code changes or recompilation.
47
-
-**Widely Adopted:** OpenTelemetry Java Agent is used in production by many organizations and is actively maintained.
48
-
-**Configurable:** Instrumentation can be enabled/disabled for specific libraries, and the agent can be removed by simply omitting the `-javaagent` flag.
49
-
-**No Persistent Changes:** The agent does not persistently modify your application or its dependencies.
1. **Check Application Logs:** On startup, the agent logs its initialization. Look for lines mentioning `opentelemetry-javaagent` in the CAAT logs.
56
47
2. **Verify Telemetry Export:** Confirm that traces and metrics are being sent to your configured backend (e.g., OpenTelemetry Collector, Jaeger, Azure Monitor).
57
48
3. **Check Service Name:** Ensure the service appears as `caat-analytics-engine` (or your configured name) in your observability backend.
58
-
4.**Disable to Compare:** Temporarily remove the `-javaagent` flag and confirm that telemetry stops, verifying the agent is responsible for the data.
59
-
60
-
---
61
-
62
-
> [!NOTE]
63
-
> This documentation uses the active document as context because you have the checkmark checked.
64
-
> You can include additional context using **#** references. Typing **#** opens a completion list of available context.
49
+
4. **Disable to Compare:** Temporarily remove the `-javaagent` flag and confirm that telemetry stops, verifying the agent is responsible for the data.
@@ -13,18 +13,17 @@ To create a Kibana user and assign the custom Kibana role:
13
13
2. Navigate to **Stack Management** > **Security** > **Users**.
14
14
3. Click **Create user**.
15
15
4. Fill out the following:
16
-
-**Username**: A unique login name (e.g., `alerts_dashboard_user`).<br/>
17
-
-**Password**: Set a strong password.<br/>
18
-
-**Full name / Email address**: Optional but recommended.<br/>
16
+
-**Username**: A unique login name (e.g., `alerts_dashboard_user`).<br/>
17
+
-**Password**: Set a strong password.<br/>
18
+
-**Full name / Email address**: Optional but recommended.<br/>
19
19
5. Under **Roles**, search for and assign the `relativity_dashboard_user` role.
20
20
6. Click **Create user** to save.
21
21
22
-
23
-
> [!WARNING]
24
-
> **Important:** Users must log in with this account to access the Kibana dashboards and saved searches provided by Environment Watch.
25
22
26
-
---
23
+
> [!WARNING]
24
+
> Users must log in with this account to access the Kibana dashboards and saved searches provided by Environment Watch.
25
+
27
26
28
27
### Congratulations!
29
28
30
-
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.
29
+
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.
> This section applies to Datagrid Only and the Audit setup via CLI should be run only once per environment.
6
+
> This section applies to Datagrid Only.
7
+
8
+
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.
9
+
10
+
7
11
> Please review the following important information before proceeding:
8
12
> ***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.
9
13
> * 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).
10
14
> * Always verify the minimum required Elasticsearch version in your specific release bundle, as it may differ from the versions mentioned here.
11
15
12
-
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.
13
-
14
16
### Prerequisites
15
17
16
-
17
18
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.
18
19
19
20
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
22
23
23
24
24
25
25
-
####Set up instructions
26
+
### Set up instructions
26
27
27
28
Follow these steps to set up Data Grid Audit using the Relativity Server CLI. All setup will occur on the SQL Primary server.
28
29
29
-
**Step 1** - Open elevated command prompt/powershell. Run below command. Select Datagrid
30
-
31
-
```
32
-
C:\Server.Bundle.x.y.z\relsvr.exe setup
33
-
34
-
Relativity Server CLI - 24.0.1196
35
-
Copyright (c) 2025, Relativity ODA LLC
30
+
1. Open elevated command prompt/powershell. Run below command. Select **Datagrid**
31
+
```
32
+
C:\Server.Bundle.x.y.z\relsvr.exe setup
33
+
Relativity Server CLI - 24.0.1196
34
+
Copyright (c) 2025, Relativity ODA LLC
36
35
37
-
What would you like to setup?
38
-
> DataGrid
39
-
Environment watch
40
-
Exit
41
-
```
36
+
What would you like to setup?
37
+
> DataGrid
38
+
Environment watch
39
+
Exit
40
+
```
42
41
43
-
**Step 2** - Enter the required Relativity and Elasticsearch parameters.
42
+
2. Enter the required Relativity and Elasticsearch parameters.
44
43
45
-
```
46
-
Confirm you would like to perform the 'DataGrid' setup [y/n] (y): y
44
+
```
45
+
Confirm you would like to perform the 'DataGrid' setup [y/n] (y): y
47
46
48
-
Existing settings do not exist
49
-
Enter the Relativity admin username (relativity.admin@kcura.com): relativity.admin@kcura.com
50
-
Enter the Relativity admin password: *********
51
-
Enter the Relativity instance url (https://emttest/Relativity): https://emttest/Relativity
52
-
Relativity instance is verified
53
-
Enter the Elasticsearch admin username (elastic): elastic
54
-
Enter the Elasticsearch admin password: *********
55
-
Enter the Elasticsearch cluster endpoint URL (https://emttest:9200): https://emttest:9200
47
+
Existing settings do not exist
48
+
Enter the Relativity admin username (relativity.admin@kcura.com): relativity.admin@kcura.com
49
+
Enter the Relativity admin password: *********
50
+
Enter the Relativity instance url (https://emttest/Relativity): https://emttest/Relativity
51
+
Relativity instance is verified
52
+
Enter the Elasticsearch admin username (elastic): elastic
53
+
Enter the Elasticsearch admin password: *********
54
+
Enter the Elasticsearch cluster endpoint URL (https://emttest:9200): https://emttest:9200
56
55
57
-
```
56
+
```
58
57
59
-
**Step 3** - Wait for Setup to Complete.
58
+
3. Wait for Setup to Complete.
60
59
61
-
```
62
-
Elasticsearch cluster endpoint URL is verified
63
-
Elasticsearch plugin verified
60
+
```
61
+
Elasticsearch cluster endpoint URL is verified
62
+
Elasticsearch plugin verified
64
63
65
-
API Key creation and 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.
72
-
```
73
-
If the setup completes successfully, Datagrid is now configured for the environment.
70
+
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.
71
+
```
72
+
73
+
If the setup completes successfully, Datagrid is now configured for the environment.
74
74
75
-
**Step 4** - Restart the Relativity services on all machines for the changes to take effect.
75
+
4. Restart the Relativity services on all machines for the changes to take effect.
76
76
77
77
78
-
**Step 5** - Verify Audit Dashboard
79
-
Navigate to the Audit tab in the Relativity environment and confirm that the dashboard and its data are loading correctly.
78
+
5. Verify Audit Dashboard - navigate to the Audit tab in the Relativity environment and confirm that the dashboard and its data are loading correctly.
@@ -286,7 +284,7 @@ If you have used Elasticsearch for the optional Data Grid Audit feature on Relat
286
284
287
285
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.
288
286
289
-
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.
287
+
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.
290
288
291
289
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)).
0 commit comments