Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 0 additions & 29 deletions docs/create_kibana_users.md

This file was deleted.

430 changes: 0 additions & 430 deletions docs/elasticsearch_setup_development.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/elasticsearch_setup_production.md

This file was deleted.

32 changes: 0 additions & 32 deletions docs/environment_watch_install_other_integrations.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/environment_watch_installation.md

This file was deleted.

127 changes: 0 additions & 127 deletions docs/environment_watch_upgrade.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Elasticsearch Pre-Installation Overview

![alt text](../resources/stage_environmentwatch01.png)


## Install Elastic Stack Components

The first step of the **Environment Watch** and/or **Data Grid Audit** setup involves installing required third-party software from the **Elastic Stack**. The following Elastic components are used for these two products:
Expand Down Expand Up @@ -290,6 +287,6 @@ If you have used Elasticsearch for the optional Data Grid Audit feature on Relat

### Next step

[Click here to setup an Elastic Stack for a development environment](./elasticsearch_setup_development.md)
// TODO add link to ElasticSlack installation

[Click here to setup an Elastic Stack for a production environment](./elasticsearch_setup_production.md)
[Click here to setup Environment Watch](./elastic-stack-setup-02-environment-watch.md)
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Set up Environment Watch using the Relativity Server CLI

![Setup Stage](../resources/enable_environmentwatch.png)

> [!NOTE]
> This step is required for Environment Watch.

Expand Down Expand Up @@ -87,8 +85,7 @@ Refer to the [Troubleshooting Guide](troubleshooting/relativity-server-cli.md) i

## Next Steps

* [Click here if setting up Data Grid Audit](datagrid_audit_setup.md)
* [Click here to continue Environment Watch Setup](install_environment_watch_monitoring_agents.md)
* [Click here to continue Environment Watch Setup](elastic-stack-setup-02-environment-watch/ew-01-install-monitoring-agents.md)



Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Install Environment Watch Monitoring Agents

![Setup Stage](../resources/stage_environmentwatch.png)

> [!NOTE]
> This step is required for Environment Watch.
>The Environment Watch monitoring agent installation should start on the SQL Primary server, verify the installation, and then be applied to other servers in the environment. This ensures proper setup and validation before deploying across all servers.
Expand Down Expand Up @@ -60,7 +58,7 @@ After verifying the first installation, repeat these steps for the remaining ser


> [!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).
> 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).

## Next Step
[Click here for the next step](environment_watch_install_other_integrations.md)
[Click here for the next step](./ew-02-relativity-alerts.md)
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Install Relativity Alerts

![](../resources/relativity_alerts_installation_step.png)

> [!NOTE]
> This step is required for Environment Watch.

Expand Down Expand Up @@ -67,6 +65,34 @@ A list of common install issues and their resolutions are available at the [trou

If any of the previous steps have failed, or any errors were displayed, please see [troubleshooting guide](../docs/troubleshooting/relativity_alerts_troubleshooting.md) for more information.

# Create Kibana Users and Assign Roles

> [!NOTE]
> This step is required for Environment Watch.

To access Kibana dashboards and saved searches, a new account must be created for each user and be assigned to the custom Kibana role that was installed during the Environment Watch CLI setup.

### Creating Kibana Users with Dashboard Access
To create a Kibana user and assign the custom Kibana role:
1. Log in to Kibana as a user with administrative privileges.
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/>
5. Under **Roles**, search for and assign the `relativity_dashboard_user` role.
6. Click **Create user** to save.
![](../resources/custom_kibana_role.png)

> [!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](environment_watch_troubleshooting.md) for further assistance.

## Next Step

[Click here for the next step](create_kibana_users.md)
[Click here for the next step](./ew-03-extensibility-configuration.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Install Other Integrations

> [!NOTE]
> This step is required for Environment Watch.

This guide provides information on integrating various Relativity components with Environment Watch. These integrations extend observability capabilities across your environment, enabling comprehensive monitoring and performance analysis.

## Available Integrations

### RabbitMQ Integration

The RabbitMQ integration enables monitoring of RabbitMQ queues, exchanges, and nodes.

- [Setting Up RabbitMQ Integration](./ew-03-extensibility-configuration/ew-extensibility-configuration-01-rabbitmq.md)

### Relativity Analytics Engine (CAAT) Integration

The Relativity Analytics Engine (CAAT) integration provides observability into Analytics operations by implementing OpenTelemetry instrumentation.

- [Setting Up OpenTelemetry Java Agent for Relativity Analytics Engine](./ew-03-extensibility-configuration/ew-extensibility-configuration-02-caat.md)

### Retention Policy

If the default retention periods do not meet your requirements, you can modify them according to your organization's needs. For detailed guidance on retention policies and configuration steps.

- [Elasticsearch Retention Policy Guidelines](./ew-03-extensibility-configuration/ew-extensibility-configuration-03-retention-policy.md)

### IIS Configuration

The RabbitMQ integration enables monitoring of RabbitMQ queues, exchanges, and nodes.

- [Setting Up IIS configuration](./ew-03-extensibility-configuration/ew-extensibility-configuration-04-iis.md)

### Manual Elasticsearch Configuration

The Manual Elasticsearch Configuration helps to update and optimize essential Elasticsearch settings.

- [Setting Up Elasticsearch Configuration](./ew-03-extensibility-configuration/ew-extensibility-configuration-05-elastic-field-limit.md)

### Custom-JSON Integration

The Custom-JSON integration enables monitoring of Windows Services, Certificates, Kibana Alerts with Slack Notifications, and SQL Cluster Instances.

- [Setting Up Custom-JSON Integration](./ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration.md)

## Next Step

[Click here for the next step](./ew-04-tuning.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Environment Watch Performance Tunning

## Next Step

[Click here for the next step](../elastic-stack-setup-03-audit.md)
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Enable Data Grid Audit

![Setup Stage](../resources/enable_environmentwatch.png)

> [!NOTE]
> This section applies to Datagrid Only.

Expand Down Expand Up @@ -80,4 +78,4 @@ Follow these steps to set up Data Grid Audit using the Relativity Server CLI. Al

## Next

[Click here for the next step](install_environment_watch_monitoring_agents.md)
[Click here for the next step](./elastic-stack-setup-04-post-install-verification.md)
Loading