Skip to content

Commit 8ff24aa

Browse files
committed
REL-1284788: update caat instrumentation documentation
1 parent d90f2cc commit 8ff24aa

1 file changed

Lines changed: 23 additions & 31 deletions

File tree

elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-02-caat.md

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -23,48 +23,40 @@ For other Other integrations, refer to the [Environment Watch Install other Inte
2323
### Prerequisites
2424

2525
- Existing CAAT(5.1.4.A1) installer package
26+
- CAAT EW bundle (contains `startup.cmd`)
2627
- Administrative access to the server
2728

2829
### Installation Steps
2930

30-
1. Copy the CAAT EW bundle to your server and unzip it
31-
2. Copy the following files from the CAAT EW bundle to the CAAT installer directory:
31+
1. Install/upgrade CAAT latest installer.If this has already been completed, skip this step.
32+
2. Ensure no analytics jobs are currently running, then stop the **Relativity Analytics Engine** service
33+
3. Stop the **Relativity Environment Watch** service in analytics server.
34+
4. Copy and replace the following file from the CAAT EW bundle to the bin folder CAAT installer directory:
3235
- `startup.cmd`
33-
- `replace_startup.bat`
34-
3. Replace `response-file.properties` with your master copy
35-
4. Ensure no analytics jobs are currently running, then stop the **Relativity Analytics Engine** service
36-
5. Stop the **Relativity Environment Watch** service before starting installation
37-
6. Open PowerShell as an administrator
38-
7. Run `.\Install.cmd`
39-
8. Once the installation is complete, start the **Relativity Analytics Engine** and **Relativity Environment Watch** services and verify the engine is active
40-
9. Open Kibana and search for `service.name: "relsvr_caat"` in the `metrics-*` data view to confirm telemetry is being collected
41-
42-
43-
## CAAT Instrumentation Configuration
44-
45-
**Important**
46-
47-
- CAAT instrumentation is **disabled by default** starting with this update.
48-
- Customers using Environment Watch (EW) must **manually enable instrumentation** after applying the patch.
49-
50-
**Steps to Enable Instrumentation**
51-
52-
1. Navigate to the CAAT/bin directory.
53-
2. Open the startup.cmd file.
54-
3. Add the following lines towards the end of the JVM options section (before the final -jar entry):
36+
5. Once the copying is complete, start the **Relativity Analytics Engine** and **Relativity Environment Watch** services and verify the engine is active
37+
6. Open Kibana and search for `service.name: "relsvr_caat"` in the `metrics-*` data view to confirm telemetry is being collected
38+
39+
40+
## What's updated
41+
42+
- 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.
43+
- Check for these lines within `startup.cmd`:
5544
```
56-
-javaagent:..bin\opentelemetry-javaagent.jar
57-
-Dotel.service.name="relsvr.caat"
58-
-Dotel.metrics.exporter=otlp
59-
-Dotel.exporter.otlp.endpoint="http://localhost:4318"
45+
-javaagent:..bin\opentelemetry-javaagent.jar
46+
-Dotel.service.name="relsvr.caat"
47+
-Dotel.metrics.exporter=otlp
48+
-Dotel.exporter.otlp.endpoint="http://localhost:4318"
6049
-Dotel.instrumentation.runtime-metrics.enabled=true
6150
-Dotel.instrumentation.java-util-logging.enabled=false
6251
```
63-
4. Save the file.
64-
5. Restart the Analytics Service to apply the change
6552
6653
## How to verify the changes
6754
6855
1. **Check Application Logs:** On startup, the agent logs its initialization. Look for lines mentioning `opentelemetry-javaagent` in the CAAT logs.
6956
2. **Verify Telemetry Export:** Confirm that traces and metrics are being sent to your configured backend (e.g., OpenTelemetry Collector, Jaeger, Azure Monitor).
70-
3. **Check Service Name:** Ensure the service appears as `Relativity Analytics Engine` (or your configured name) in your observability backend.
57+
3. **Check Service Name:** Ensure the service appears as `Relativity Analytics Engine` (or your configured name) in your observability backend.
58+
59+
## Important
60+
61+
CAAT instrumentation is disabled by default starting with this update.
62+
Customers using Environment Watch (EW) can manually enable instrumentation after applying the patch.

0 commit comments

Comments
 (0)