Skip to content

Commit 389213a

Browse files
Merge pull request #31 from relativitydev/REL-1125669-restructure-development-tier-feedback
REL-1125669 restructure development tier feedback
2 parents 0b43e25 + 91e23ed commit 389213a

14 files changed

Lines changed: 127 additions & 95 deletions

docs/elasticsearch_setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Installing Elasticsearch, Kibana, and APM Server
22

3-
![](../resources/elasticsearch_setup_001.png)
3+
![](../resources/troubleshooting-images/setupstage.png)
44

55
This first stage of the Environment Watch and/or Data Grid Audit setup involves installing required third-party software from the Elastic stack. There are three Elastic components used for these two products:
66

docs/elasticsearch_setup_development.md

Lines changed: 121 additions & 91 deletions
Large diffs are not rendered by default.

docs/environment_watch_installation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Environment Watch and Data Grid Audit Installation
22

3+
4+
35
## Installation Overview
46

57
Environment Watch and Data Grid Audit require installation and configuration of third-party and Relativity software. This installation guide covers the full set up for Environment Watch but only the Elasticsearch and Kibana set up for Data Grid Audit. Additional steps for configuring the Audit application within Relativity are covered [here](https://help.relativity.com/Server2024/Content/Relativity/Audit/Audit.htm#InstallingandconfiguringAudit).
@@ -10,7 +12,7 @@ The Server bundle is generally released quarterly but hot fixes are provided for
1012

1113
Environment Watch installation is comprised of the following four stages. **Stages 1 and 2 are also used to set up Elasticsearch and Kibana for using Data Grid Audit. Stages 3 and 4 are only relevant for Environment Watch.**
1214

13-
![](../resources/environment_watch_installation_001.png)
15+
![alt text](../resources/stage_environmentwatch01.png)
1416

1517
<table><tbody><tr><th><p><strong>Stage</strong></p></th><th><p><strong>Name</strong></p></th><th><p><strong>Applicable For</strong></p></th><th><p><strong>Description</strong></p></th><th><p><strong>Environment Watch Bundle Assets</strong></p></th></tr><tr><td><p>1</p></td><td><p>Elasticsearch, Kibana, and APM Server</p></td><td><p>Environment Watch and Data Grid Audit</p></td><td><p>During this step you will install the Elastic stack software that is used for Environment Watch and/or Kibana (Elasticsearch, Kibana, and APM Server).</p><div class="note">APM Server is only used for Environment Watch.</div></td><td><ul> N/A</ul></td></tr><tr><td><p>2</p></td><td><p>Use the Relativity Server CLI to set up Environment Watch and/or Data Grid Audit</p></td><td><p>Environment Watch and Data Grid Audit</p></td><td><p>During this step you will configure the integration between Elastic and Relativity for Environment Watch and/or Data Grid Audit.</p><p>If you are setting up Environment Watch, the Relativity Server CLI also imports all of the Kibana objects (indexes, alerts, saved searches, dashboards, etc.) that Relativity has created and packaged as part of Environment Watch.</p></td><td><ul><li>Relativity.Server.CLI</li></ul></td></tr><tr><td><p>3</p></td><td><p>Install Environment Watch on all hosts</p></td><td><p>Environment Watch only</p></td><td><p>During this step you will install and verify Environment Watch on SQL Primary. Once verified, proceed with installing EW on all hosts that you want to monitor in your Relativity Server environment. The installer package contains a monitoring agent (rel-infrawatch-agent.exe) that collects and transmits telemetry data to Elastic and a Windows service (rel-envwatch-service.exe) that enables the monitoring agent upgrade process.</p></td><td><ul><li>Relativity.EnvironmentWatch.Installer</li><li>Rel-infrawarch-agent</li></ul></td></tr><tr><td><p>4</p></td><td><p>Install/upgrade the Relativity Alerts application</p></td><td><p>Environment Watch only</p></td><td><p>During this step you will install or upgrade the Relativity Alert application (RAP) that provides the Environment Watch in-app alert notifications within Relativity.</p></td><td><ul><li>Relativity.Alerts.VERSION.rap</li></ul></td></tr></tbody></table>
1618

docs/environment_watch_installer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Relativity Environment Watch installation
22

3-
![](../resources/Installer_current_step.png)
3+
![Setup Stage](../resources/stage_environmentwatch.png)
44

55
## Summary
66
The Relativity Environment Watch installer package contains a monitoring agent (rel-infrawatch-agent.exe) that collects and transmits telemetry data to Elastic and a Windows service (rel-envwatch-service.exe) that is responsible for launching the monitoring agent process and enables monitoring agent auto-upgrade process. You will install this package on all hosts in your environment that you want to monitor.

docs/relativity_server_cli_setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Set up Environment Watch and/or Data Grid Audit using the Relativity Server CLI
22

3-
![](../resources/relativity_server_cli_setup_001.png)
3+
![Setup Stage](../resources/enable_environmentwatch.png)
44

55
Now that you have installed the required Elastic components for Environment Watch and/or Data Grid Audit, you will configure the integration between Elastic and Relativity by running the Relativity Server CLI on your Primary SQL Server. For Environment Watch, the Relativity Server CLI will also import all of the indexes, alerts, and dashboards that Relativity has developed and shipped as part of the Environment Watch product.
66

resources/SetupStage02.png

36.3 KB
Loading
38.5 KB
Loading
36.8 KB
Loading
36.8 KB
Loading
-55.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)