diff --git a/docs/create_kibana_users.md b/docs/create_kibana_users.md deleted file mode 100644 index a0c3d4cb..00000000 --- a/docs/create_kibana_users.md +++ /dev/null @@ -1,29 +0,0 @@ -# Create Kibana Users and Assign Roles - -![Setup stage](../resources/createuserssetupstage.png) - -> [!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`).
- - **Password**: Set a strong password.
- - **Full name / Email address**: Optional but recommended.
-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. diff --git a/docs/elasticsearch_setup_development.md b/docs/elasticsearch_setup_development.md deleted file mode 100644 index 8e921749..00000000 --- a/docs/elasticsearch_setup_development.md +++ /dev/null @@ -1,430 +0,0 @@ -# Install Elasticsearch, Kibana and APM Server - Development Environment - -![Set Up Stage](../resources/troubleshooting-images/setupstage.png) - -> [!NOTE] -> This step is required for both Environment Watch and Data Grid Audit - -## How to Unblock Downloaded Files -If you download a .zip or other file from the internet, Windows may block the file and prevent it from running correctly. To unblock a file: - -1. Right-click the downloaded file and select **Properties**. -2. In the **General** tab, check the box for **Unblock** at the bottom (if present). -3. Click **Apply** and then **OK**. - - ![Unblock file screenshot](../resources/troubleshooting-images/unblocked.png) - -### Step 1: Download and Install the Windows .zip package for Elasticsearch version 8.x or 9.x on one server -1. Download Elasticsearch 8.x or 9.x - 1. Visit [Elastic’s official download page](https://www.elastic.co/downloads/elasticsearch). - 2. Download the 8.x or 9.x Windows .zip version. - 3. Before extracting, see [How to Unblock Downloaded Files](#how-to-unblock-downloaded-files). - 4. Extract the files to `C:\elastic` -2. Install and Configure Elasticsearch 8.x or 9.x - 1. Open an elevated PowerShell and run the following command to start Elasticsearch and perform the auto installation steps: - ``` - C:\elastic\elasticsearch-{version}\bin\elasticsearch.bat - ``` - - - > When starting Elasticsearch for the first time, security features are enabled and configured by default: - > - Authentication and authorization are enabled, and a password is generated for the elastic built-in superuser. - > - Certificates and keys for TLS are generated for the transport and HTTP layer, and TLS is enabled and configured with these keys and certificates. - > - An enrollment token is generated for Kibana, which is valid for 30 minutes. - - 2. Save the token for future reference. Once the enrollment token is displayed, you need to stop Elasticsearch so you can proceed with the next steps. To do this, return to the PowerShell window where Elasticsearch is running and press `Ctrl+C` on your keyboard. This will safely terminate the process. The enrollment token will look similar to: - ``` - Enrollment token for Kibana: - eyJ2ZXIiOiI4LjE3LjMiLCJ... - ``` - > [!NOTE] - > To stop Elasticsearch after you have copied the enrollment token, click inside the PowerShell window and press `Ctrl` and `C` at the same time. This will end the running process. - - 3. Open an elevated PowerShell and run the following command to install Elasticsearch as a Windows service: - ``` - C:\elastic\elasticsearch-{version}\bin\elasticsearch-service.bat install - ``` - The output will look similar to: - ``` - Installing service : "elasticsearch-service-x64" - Using JAVA_HOME (64-bit): C:\Program Files\Java\jdk-17 - The service 'elasticsearch-service-x64' has been installed. - ``` -3. Run Elasticsearch as a Windows Service - 1. Open an elevated PowerShell and run the following command to start the Elasticsearch service: - ``` - C:\elastic\elasticsearch-{version}\bin\elasticsearch-service.bat start - ``` - The output will look similar to: - ``` - Starting service : "elasticsearch-service-x64" - The service 'elasticsearch-service-x64' has been started. - ``` -4. Enable Stack Monitoring - 1. Navigate to the Elasticsearch configuration folder (e.g., `C:\elastic\elasticsearch-{version}\config`) and open the **elasticsearch.yml** file. - 2. Add the following line to enable Stack Monitoring: - ``` - xpack.monitoring.collection.enabled: true - ``` - 3. Save the changes and restart the Elasticsearch service by opening an elevated PowerShell and running the following command: - ``` - Restart-Service -Name "elasticsearch-service-x64" - ``` -5. Reset the Elastic (Admin) User Password - 1. The following command resets the password for the `elastic` user, which is the default superuser (admin) account in Elasticsearch. This account is required for logging in to Kibana and for performing administrative tasks such as managing users, roles, and system settings. - 2. Navigate to ElasticSearch's bin folder(`C:\elastic\elasticsearch-{version}\bin`) - 3. Open an elevated PowerShell and run the following command: - ``` - .\elasticsearch-reset-password -u elastic - ``` - 4. When prompted, press 'Y' to confirm and reset the password - - ![elastic-reset-password](../resources/troubleshooting-images/elastic-reset-password.png) - - 5. When you run this command, a new password will be generated and displayed in the console output. - > [!IMPORTANT] - > The password is shown only once and cannot be retrieved later. Immediately record and securely store the password according to your organization’s credential management and security policies. You will need this password for future authentication to Elasticsearch and Kibana. - -6. Install the 'mapper-size' plugin - 1. Open an elevated PowerShell and run the following command to install the 'mapper-size' plugin: - ``` - C:\elastic\elasticsearch-{version}\bin\elasticsearch-plugin install mapper-size - ``` - 2. To verify the 'mapper-size' plugin is installed, run: - ``` - C:\elastic\elasticsearch-{version}\bin\elasticsearch-plugin list - ``` - 3. Restart the Elasticsearch Service. To restart the Elasticsearch service, run the following in an elevated PowerShell session: - ``` - Restart-Service -Name "elasticsearch-service-x64" - ``` - The output will look similar to: - ``` - WARNING: Waiting for service 'Elasticsearch 8.x or 9.x (elasticsearch-service-x64) (elasticsearch-service-x64)' to stop... - ``` - -7. Verify Elasticsearch Server - 1. To verify Elasticsearch is running, open an elevated Command Prompt and run the following command (replace ``, ``, and `` with your actual values): - ``` - curl -u : -k https://:9200 - ``` - 2. The response should show basic cluster information in JSON format if the server is running and accessible. - -
- Sample JSON response - - ``` - { - "name" : "emttest", - "cluster_name" : "elasticsearch", - "cluster_uuid" : "q5VtYDCQT2iNHU9dOdqomw", - "version" : { - "number" : "8.17.3", - "build_flavor" : "default", - "build_type" : "zip", - "build_hash" : "a091390de485bd4b127884f7e565c0cad59b10d2", - "build_date" : "2025-02-28T10:07:26.089129809Z", - "build_snapshot" : false, - "lucene_version" : "9.12.0", - "minimum_wire_compatibility_version" : "7.17.0", - "minimum_index_compatibility_version" : "7.0.0" - }, - "tagline" : "You Know, for Search" - } - ``` - -
- -### Step 2: Install and Configure Kibana - -1. Download Kibana 8.x or 9.x - 1. Download and extract the 8.x or 9.x Windows .zip version of Kibana from [Elastic’s official Kibana download page](https://www.elastic.co/downloads/kibana). - 2. Before extracting, see [How to Unblock Downloaded Files](#how-to-unblock-downloaded-files). - -2. Start Kibana from the command line - 1. Navigate to Kibana's `bin` folder (e.g., `C:\elastic\kibana\bin`). - 2. Open an elevated PowerShell and run the following command: - ``` - C:\Kibana\kibana-{version}\bin\kibana.bat - ``` - 3. If successful, you should see output indicating that the Kibana server has started and is listening on port 5601. Look for lines similar to: - ``` - [INFO][server][http] http server running at http://localhost:5601 - ... - kibana has not been configured - Go to https://localhost:5601/?code=xyz to get started - ``` -3. Enroll Kibana - 1. In your terminal, click the generated link to open Kibana in your browser. - 2. In your browser, paste the enrollment token that was generated in the terminal when you started Elasticsearch, then click the Configure Elastic button to connect your Kibana instance with Elasticsearch. - [See where the enrollment token is generated.](#enrollment-token-generation) - 3. If the token has expired, generate a new one by running the following command in the Elasticsearch's bin folder (e.g., `C:\elastic\elasticsearch-{version}\bin`). - ``` - C:\elastic\elasticsearch-{version}\bin\elasticsearch-create-enrollment-token --scope kibana - ``` -
- Sample output - eyJ2ZXIiOiI4LjE0LjAiLCJhZHIiOlsiMTAuMC4yLjI6OTIwMCJdLCJmZ3IiOiI4ZGE1MWZkYTExZmM1ZDAwNDBhZWZlNTJlNmRiYzQ5ZTM2NmYxYTkyOGIwY2NiMzExOGY0MWFjZTczODNkZDliIiwia2V5IjoiOGFfc1BKZ0Jra09qNlh6dngycS06bG5sWkNEMnpSbFNiZjZZclpRSHF6dyJ9 -
- 4. Log in to Kibana as the `elastic` user with the password that was generated when you started Elasticsearch. - 5. See the screenshot below for the login screen: - - ![](../resources/elasticsearch_setup_003.png) - -4. Generate Kibana encryption keys - > [!NOTE] - > Skipping the steps below will cause the Relativity Server CLI to fail. - - 1. Open an elevated PowerShell and run the following command: - ``` - C:\Kibana\kibana-{version}\bin\kibana-encryption-keys generate - ``` - - 2. If successful, you will see output showing the generated encryption keys. For example: - -
- Sample output - - ``` - xpack.encryptedSavedObjects.encryptionKey: "" - xpack.reporting.encryptionKey: "" - xpack.security.encryptionKey: "" - ``` - -
- - 3. Copy the generated encryption keys and paste them at the end of your `kibana.yml` file (e.g., `C:\Kibana\kibana-{version}\config\kibana.yml`). The configuration should look similar to: - -
- Sample kibana.yml configuration - - ```yaml - xpack.encryptedSavedObjects.encryptionKey: "" - xpack.reporting.encryptionKey: "" - xpack.security.encryptionKey: "" - ``` - -
- - 4. Restart the Kibana service, by opening an elevated PowerShell and run the following command: - ``` - C:\Kibana\kibana-{version}\bin\kibana.bat - ``` - - 5. To verify success, check the terminal output for lines indicating that Kibana has started successfully. You can also refer to the screenshots below: - - ![Kibana restart verification](../resources/troubleshooting-images/kibanarerun.png) - - 6. After Kibana has restarted, open a browser and go to `http://:5601`. - 7. Log in using the `elastic` username and the password you generated earlier. This verifies that Kibana is running and your credentials are working. - - ![Kibana restart](../resources/troubleshooting-images/kibanaloginpageresponse.png) - - 8. For more details, refer to the official documentation: https://www.elastic.co/guide/en/kibana/current/kibana-encryption-keys.html - -5. Create Kibana Windows Service - > [!IMPORTANT] - > **Running Kibana as a Windows Service is Optional** - > Environment Watch does NOT require Kibana to run as a Windows service, nor does it require the use of NSSM. NSSM is a commonly used open-source tool to help run applications as services, but it is not mandatory. You can run Kibana manually from the command line if you prefer, and this will work perfectly for development and most production scenarios. - > Only use NSSM if you want Kibana to start automatically as a service on Windows. If you do not wish to use NSSM, simply run `kibana.bat` manually. - > - > ``` - > C:\Kibana\kibana-{version}\bin\kibana.bat - > ``` - - 1. Download the latest NSSM executable from https://nssm.cc/download and place it in the C drive (e.g., `C:\nssm-2.24`). - > [!NOTE] - > Kibana does not install as a Windows service by default. We recommend using NSSM — a commonly used open-source tool—to run Kibana as a Windows service. - - 2. Open an elevated PowerShell and run the following command: - - ``` - C:\nssm-2.24\win64\nssm.exe install kibana - ``` - - This will open a popup to create a Windows service for Kibana. - - 3. In the Application tab, enter the path to `kibana.bat` and its folder as shown below: - - ![Kibana service application tab](../resources/troubleshooting-images/kibanaservice-applicationtab.png) - - - > **Editing Kibana Service Properties:** - > If you accidentally install the Kibana service before completing your configuration (for example, by pressing Return too early in the NSSM dialog), you can easily edit the service properties afterward. This allows you to update the application path, log file settings, or other options without reinstalling the service. - > To edit the service properties, open an elevated PowerShell and run the following command: `C:\nssm-2.24\win64\nssm.exe edit kibana` - - 4. In the I/O tab, enter the full path of a log file where the service logs will be stored. For example, create a folder in the Kibana directory (e.g., `C:\Kibana\kibana-{version}\service_logs`) and a blank log file (e.g., `C:\Kibana\kibana-{version}\service_logs\kibana_service.log`). - - 5. Copy the full log file path into the stdout and stderr sections: - - ![Kibana service I/O tab](../resources/troubleshooting-images/kibanaservice-io-tab.png) - - 6. In the File rotation tab, check all boxes and enter `10485760` bytes so a new log file is generated for every 10 MB of logs: - - ![Kibana service file rotation tab](../resources/troubleshooting-images/kibanaservice-filerotationtab.png) - - 7. Click the Install service button to create the Windows service for Kibana. - - 8. Go to the Services app in Windows, search for the `kibana` service, right click, and start the service. - - 9. Right click on the service and open **Properties** to change the startup type to **Automatic**, so Kibana runs automatically on system startup. - - 10. Verify that Kibana is running by opening it in your browser. - > [!NOTE] - > It is normal for Kibana to take 1-5 minutes to become accessible after starting the service, depending on your system. Please be patient while it starts up. - -6. Verify Kibana Server - 1. Open a browser and go to `http://:5601`. - 2. Log in using the `elastic` credential to verify successful access. - - ![Kibana Login Page](../resources/troubleshooting-images/kibanaloginpage.png) - ![Kibana Login Page Response](../resources/troubleshooting-images/kibanaloginpageresponse.png) - -### Step 3: Install and Configure APM Server - -1. Prerequisites to setup APM Server - - Elastic and Kibana should be configured and services should be up and running. - -2. Download APM Server 8.x or 9.x - 1. Visit [Elastic’s APM Server page](https://www.elastic.co/downloads/apm). - 2. Download and extract the 8.x or 9.x Windows .zip file. - 3. Before extracting, see [How to Unblock Downloaded Files](#how-to-unblock-downloaded-files). - 4. Extract the files to `C:\`. - -3. Configure APM Server (`C:\apm-server-{version}-windows-x86_64\apm-server.yml`) - - 1. An API key is required for configuring both APM and Beats. To create an API key: - 1. Log in to Kibana (`http://:5601`) using the `elastic` credential. - 2. Use the global search at the top of Kibana to search for "API keys" and select it from the results. - 3. Click the **Create API key** button. - 4. Enter a name for your API key (for example, specify if it will be used for Beats or APM). - 5. Click the **Privileges** dropdown and select **Beats** to automatically apply the recommended permissions for Beats. - 6. Click **Create API key**. - 7. Copy and securely save the generated `id` and `api_key` values. - - ![create-apikey](../resources/troubleshooting-images/create-apikey.png) - - > Copy and save `id` and `api_key` values immediately and store them securely according to your organization’s credential management and security policies. - - 2. Navigate to the apm-server folder (e.g., `C:\apm-server-{version}-windows-x86_64`) and open the `apm-server.yml` file using a text editor. - - 3. Update the `apm-server.yml` file to match the following sample configuration. Replace the placeholder values (``, ``, ``, ``) as needed for your environment. Below is a sample configuration: - - ```yaml - apm-server: - host: ":8200" - - output.elasticsearch: - hosts: [":9200"] - protocol: "https" - api_key: ":" - ssl.enabled: true - ssl.verification_mode: none - - instrumentation: - enabled: true - environment: production - hosts: - - "http://:8200" - ``` - -4. Execute required scripts to install APM Server as a Windows service - 1. Open an elevated PowerShell. - 2. Run the following command to install the APM Server as a Windows service: - - ``` - PowerShell.exe -ExecutionPolicy UnRestricted -File C:\apm-server-{version}-windows-x86_64\install-service.ps1 - ``` - The output will look similar to: - - ``` - Installing service apm-server... - Service "apm-server" has been successfully installed. - ``` - -5. Start the APM Server service - 1. Open an elevated PowerShell and run the following command: - - ``` - Start-Service -Name "apm-server" - ``` - - 2. Once the instrumentation is set, you can verify it in Kibana as shown below: - - ![verify-instrumentation](../resources/troubleshooting-images/verify-instrumentation.png) - -6. Verify APM Server - - 1. Open an elevated Command Prompt and run the following command (replace `` with your actual value): - - ``` - curl -k http://:8200 - ``` - - The response should indicate `publish_ready` is `true` and will look similar to: - - ``` - { - "build_date": "2025-02-27T18:17:35Z", - "build_sha": "f6b917b725e1a22af433e5b52c5c6f0ff9164adf", - "publish_ready": true, - "version": "8.17.3" - } - ``` - -### Step 4: Additional Setup and Verification - -1. Add Elastic APM Integration Package - > [!IMPORTANT] - > Skipping the steps below will cause the Relativity Server CLI to fail. - - 1. Login to Kibana and select the Elastic APM under Integration, or in the search bar type "Elastic APM" and select it under Integration. - - ![alt text](../resources/troubleshooting-images/apm-integration.png) - - 2. In the top right, select the Add Elastic APM button. - - ![alt text](../resources/troubleshooting-images/add-apm-integration.png) - - 3. Add an Integration name and for server configuration. Update apm hostname and apm url. - Ex: Host: :8200 - URL: http://:8200 - - 4. Click on **Save** and **Continue**. - - ![alt text](../resources/troubleshooting-images/apm-integration-host-name.png) - - 5. Select **Add Elastic Agent later** button as Agent is not required for the initial setups. - - ![alt text](../resources/troubleshooting-images/agent-button.png) - -2. Verify APM Data View - - Before proceeding with EW CLI, check if the APM Data View is created in Kibana: - - 1. Open a browser and go to http://:5601 - 2. Log in using elastic credentials - 3. Navigate to **Discover**, or type `Discover` in the search bar. - 4. Confirm the APM Data View is present: - - ![dataview](../resources/troubleshooting-images/dataview.png) - -3. Verify Cluster Health - - 1. Open an elevated Command Prompt and run the following command (replace `username`, `password`, and `hostname_or_ip` with your actual values): - - ``` - curl -u : -k https://:9200/_cat/health - ``` - - 2. You should see a response similar to: - - ``` - 1690219200 10:00:00 elasticsearch green 1 1 0 0 0 0 0 0 - 100.0% - ``` - - 3. The word `green` in the response means the cluster is healthy. The word `yellow` in the response means the cluster is partially healthy. If you see `red`, investigate further. - -## Next Step - -[Click here for the next step](relativity_server_cli_setup.md) \ No newline at end of file diff --git a/docs/elasticsearch_setup_production.md b/docs/elasticsearch_setup_production.md deleted file mode 100644 index 98f836fb..00000000 --- a/docs/elasticsearch_setup_production.md +++ /dev/null @@ -1,3 +0,0 @@ -# Install Elasticsearch, Kibana and APM Server - Production Environment - -This page is currently under construction. Please check back soon! \ No newline at end of file diff --git a/docs/environment_watch_install_other_integrations.md b/docs/environment_watch_install_other_integrations.md deleted file mode 100644 index dad18e0f..00000000 --- a/docs/environment_watch_install_other_integrations.md +++ /dev/null @@ -1,32 +0,0 @@ -# Install Other Integrations - -![](../resources/caat_environment_watch_setup.png) - -> [!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 - -### 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](analytics/caat_environment_watch_setup.md) - -### RabbitMQ Integration - -The RabbitMQ integration enables monitoring of RabbitMQ queues, exchanges, and nodes. - -- [Setting Up RabbitMQ Integration](rabbitmq/rabbitmq_integration.md) - -### Manual Elasticsearch Configuration - -The Manual Elasticsearch Configuration helps to update and optimize essential Elasticsearch settings. - -- [Setting Up Elasticsearch Configuration](elasticsearch-configurations/manual-elasticsearch-configuration.md) - -## Next Step - -[Click here for the next step](./environment-watch/post-install-verification.md) \ No newline at end of file diff --git a/docs/environment_watch_installation.md b/docs/environment_watch_installation.md deleted file mode 100644 index 2fe71dee..00000000 --- a/docs/environment_watch_installation.md +++ /dev/null @@ -1,18 +0,0 @@ -# Environment Watch and Data Grid Audit Installation - - -## Installation Overview - -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). - -The Relativity applications and components that are referenced in this installation guide are packaged together in the Server bundle release. You can find the latest bundle on GitHub [here](https://github.com/relativitydev/server-bundle-release/releases). Environment Watch and Data Grid Audit also require Relativity applications that are available in the Relativity Application Library and not packaged in the bundle or covered in this installation guide (e.g. Pagebase and Telemetry for Environment Watch, Audit for Data Grid Audit, and InfraWatch Services for both). These applications are identified as pre-requisites in relevant sections of this installation guide. - - -The Server bundle is generally released quarterly, with hotfixes provided for critical issues as needed. - -Environment Watch installation is comprised of the following seven steps. **Steps 1 and 2 are also used to set up Elasticsearch and Kibana for Data Grid Audit. Steps 3-7 are only relevant for Environment Watch.** - -![alt text](../resources/stage_environmentwatch01.png) - -## Next Step -[Click here for the next step](elasticsearch_pre_installation_overview.md) \ No newline at end of file diff --git a/docs/environment_watch_upgrade.md b/docs/environment_watch_upgrade.md deleted file mode 100644 index 8322da73..00000000 --- a/docs/environment_watch_upgrade.md +++ /dev/null @@ -1,127 +0,0 @@ -# Upgrade Environment Watch - -This document provides the necessary steps to upgrade the Environment Watch components in a Relativity environment. It includes upgrading the Environment Watch using the CLI and upgrading the Environment Watch Installer. - -## Upgrade CLI - -This section guides you through upgrading Environment Watch using the Relativity Server CLI. It is recommended to run the CLI from the Primary SQL Server. - -> [!NOTE] -> The Environment Watch upgrade via CLI should be run only once per environment. The upgrade performs tasks such as importing and updating Kibana resources including alerts, dashboards, saved searches and defect fixes. - -### Prerequisites - -- The new Server-bundle zip file has been downloaded and extracted to `C:\Server.Bundle.x.y.z` - -### Upgrade Instructions - -1. Open elevated command prompt/powershell. Run the below command. Select **Environment Watch**. - - ``` - 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 - ``` - -2. Enter 'y' to proceed. - - ``` - Confirm you would like to perform the 'Environment Watch' setup [y/n] (y): y - ``` - -3. The CLI will detect that setup has already been performed. Select the **Upgrade** option to proceed. - - ``` - Setup is already performed. Select an option to proceed: - > Upgrade - Rerun Setup - Exit - ``` - -4. The CLI will retrieve the existing settings and perform the upgrade. Please wait for the process to finish. - - ``` - Retrieved existing settings - The Relativity Environment Watch Kibana Upgrade setup is executing in silent or unattended mode. - API Key creation and validation completed ------------------------- 100% - OAuth2 client exists ---------------------------------------------- 100% - Relativity secret store updated ----------------------------------- 100% - Relativity logging updated ---------------------------------------- 100% - Relativity toggles updated ---------------------------------------- 100% - Relativity AppDomain monitoring enabled --------------------------- 100% - APM settings updated ---------------------------------------------- 100% - Elasticsearch indexes updated ------------------------------------- 100% - Kibana Tag imported ----------------------------------------------- 100% - Kibana IndexPattern imported -------------------------------------- 100% - Kibana SavedSearch imported --------------------------------------- 100% - Kibana Dashboard imported ----------------------------------------- 100% - Kibana Alert imported --------------------------------------------- 100% - Kibana Custom Role created. --------------------------------------- 100% - Relativity installation SQL record updated ------------------------ 100% - - The Environment Watch setup has been completed. The Relativity Environment Watch installer package should now be installed within each server contained within this Relativity instance. As each server is setup for monitoring, restart all Relativity services within the machine including "kCura Edds Agent Manager," "kCura Edds Web Processing Manager," and "kCura Service Host Manager" to begin sending telemetry to Elasticsearch. - ``` - -Successful completion indicates that Environment Watch is configured for the new version. - -Refer to the [Troubleshooting Guide](troubleshooting/relativity-server-cli.md) if you encounter any issues. - - - -## Upgrade Environment Watch Installer - -> [!NOTE] -> The Environment Watch installer upgrade should start on the SQL Primary server and then be applied to other servers in the environment. This ensures proper upgrade sequence and validation before deploying across all servers. - -This document outlines the steps to upgrade the Environment Watch monitoring agent. - -### Prerequisites - -- The Environment Watch CLI upgrade has been completed. -- The new Server-bundle zip file has been downloaded and extracted. - -1. Install the Upgraded Monitoring Agent - - 1. From the new extracted Server Bundle, run `Relativity.EnvironmentWatch.Installer.xx.x.xxxx.exe`. - 2. Accept the license terms and click **Install**. - 3. Once the installation is complete, click **Close**. - -2. Verify the Installation - - 1. Open **Services** and confirm the **Relativity Environment Watch** service is running. - 2. Open **Task Manager** and verify the following processes are running: - * `rel-envwatch-service.exe` - * `rel-infrawatch-agent.exe` - * `otelcol-relativity.exe` - 3. Check for new log files in `C:\ProgramData\Relativity\EnvironmentWatch\Services\InfraWatchAgent\Logs`. - 4. Verify that the `otelcol-config-auto-generated.yaml` configuration file is updated in - `C:\ProgramData\Relativity\EnvironmentWatch\Services\InfraWatchAgent\` - -3. Verify Metrics in Kibana - - 1. In Kibana, navigate to **Dashboards** and open the **[Relativity] Host Infrastructure Overview** dashboard. - 2. Confirm that CPU, RAM, and Disk metrics are visible for the upgraded host. - - ![Host metrics visible in Kibana](../resources/Installer_hostmetric.png) - 3. Navigate to the **[Relativity] Monitoring Agent** dashboard to verify: - - The monitoring agent version is updated to the new version. - - Host information and other important fields are properly reflected. - - Agent status and health metrics are showing current data. - -4. Repeat Installation for other servers. -After verifying the first upgrade, repeat these steps for the remaining servers in the following order: - - 1. SQL Distributed Servers - 2. Web Servers - 3. Agent Servers - 4. Other Servers (e.g., File Share, Analytics, Worker) - -> [!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). - diff --git a/docs/environment-watch/port-diagram.md b/elastic-stack-setup/elastic-stack-port-diagram.md similarity index 100% rename from docs/environment-watch/port-diagram.md rename to elastic-stack-setup/elastic-stack-port-diagram.md diff --git a/docs/elasticsearch_pre_installation_overview.md b/elastic-stack-setup/elastic-stack-setup-01-installation.md similarity index 98% rename from docs/elasticsearch_pre_installation_overview.md rename to elastic-stack-setup/elastic-stack-setup-01-installation.md index 6f1bf3da..8aa755b6 100644 --- a/docs/elasticsearch_pre_installation_overview.md +++ b/elastic-stack-setup/elastic-stack-setup-01-installation.md @@ -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: @@ -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) \ No newline at end of file +[Click here to setup Environment Watch](./elastic-stack-setup-02-environment-watch.md) \ No newline at end of file diff --git a/docs/relativity_server_cli_setup.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch.md similarity index 94% rename from docs/relativity_server_cli_setup.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch.md index 4e0e7e5e..4265602f 100644 --- a/docs/relativity_server_cli_setup.md +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch.md @@ -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. @@ -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) diff --git a/docs/install_environment_watch_monitoring_agents.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-01-install-monitoring-agents.md similarity index 94% rename from docs/install_environment_watch_monitoring_agents.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-01-install-monitoring-agents.md index e609d6b4..e73b5020 100644 --- a/docs/install_environment_watch_monitoring_agents.md +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-01-install-monitoring-agents.md @@ -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. @@ -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) \ No newline at end of file +[Click here for the next step](./ew-02-relativity-alerts.md) \ No newline at end of file diff --git a/docs/relativity_alerts_installation.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-02-relativity-alerts.md similarity index 80% rename from docs/relativity_alerts_installation.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-02-relativity-alerts.md index 0c7d7285..36545143 100644 --- a/docs/relativity_alerts_installation.md +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-02-relativity-alerts.md @@ -1,7 +1,5 @@ # Install Relativity Alerts -![](../resources/relativity_alerts_installation_step.png) - > [!NOTE] > This step is required for Environment Watch. @@ -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`).
+ - **Password**: Set a strong password.
+ - **Full name / Email address**: Optional but recommended.
+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) diff --git a/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration.md new file mode 100644 index 00000000..0696c49a --- /dev/null +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration.md @@ -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) \ No newline at end of file diff --git a/docs/rabbitmq/rabbitmq_integration.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-01-rabbitmq.md similarity index 100% rename from docs/rabbitmq/rabbitmq_integration.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-01-rabbitmq.md diff --git a/docs/analytics/caat_environment_watch_setup.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-02-caat.md similarity index 100% rename from docs/analytics/caat_environment_watch_setup.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-02-caat.md diff --git a/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-03-retention-policy.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-03-retention-policy.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/iis_log_configuration.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-04-iis.md similarity index 100% rename from docs/iis_log_configuration.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-04-iis.md diff --git a/docs/elasticsearch-configurations/manual-elasticsearch-configuration.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-05-elastic-field-limit.md similarity index 100% rename from docs/elasticsearch-configurations/manual-elasticsearch-configuration.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-05-elastic-field-limit.md diff --git a/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration.md new file mode 100644 index 00000000..e69de29b diff --git a/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-04-tuning.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-04-tuning.md new file mode 100644 index 00000000..f9f019ff --- /dev/null +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-04-tuning.md @@ -0,0 +1,5 @@ +# Environment Watch Performance Tunning + +## Next Step + +[Click here for the next step](../elastic-stack-setup-03-audit.md) \ No newline at end of file diff --git a/docs/datagrid_audit_setup.md b/elastic-stack-setup/elastic-stack-setup-03-audit.md similarity index 96% rename from docs/datagrid_audit_setup.md rename to elastic-stack-setup/elastic-stack-setup-03-audit.md index 78c30467..35ebeb7b 100644 --- a/docs/datagrid_audit_setup.md +++ b/elastic-stack-setup/elastic-stack-setup-03-audit.md @@ -1,7 +1,5 @@ # Enable Data Grid Audit -![Setup Stage](../resources/enable_environmentwatch.png) - > [!NOTE] > This section applies to Datagrid Only. @@ -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) \ No newline at end of file +[Click here for the next step](./elastic-stack-setup-04-post-install-verification.md) \ No newline at end of file diff --git a/docs/environment-watch/post-install-verification.md b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification.md similarity index 74% rename from docs/environment-watch/post-install-verification.md rename to elastic-stack-setup/elastic-stack-setup-04-post-install-verification.md index 8dab9d2f..c6a39bfb 100644 --- a/docs/environment-watch/post-install-verification.md +++ b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification.md @@ -1,7 +1,5 @@ # Post-Install Verification -![Post-Install Verification Banner](../../resources/post-install-verification-images/Post-installation-verification.svg) - > [!NOTE] > This step is required for Environment Watch. @@ -24,22 +22,18 @@ This documentation outlines the step-by-step procedures for verifying that the e ### 1. Elastic Cluster Health This section guides through verifying the health and proper functioning of the Elasticsearch cluster. -[Click here for Elastic Cluster Health Verification](post-install-verification/elasticsearch-cluster-health.md) +[Click here for Elastic Cluster Health Verification](./elastic-stack-setup-04-post-install-verification/elasticsearch-cluster-health.md) ### 2. Monitoring Agents This section outlines the steps to confirm that all monitoring agents are correctly installed, running, and sending data. -[Click here for Monitoring Agents Verification](post-install-verification/monitoring-agents.md) +[Click here for Monitoring Agents Verification](./elastic-stack-setup-04-post-install-verification/monitoring-agents.md) ### 3. Relativity Alerts This section covers how to ensure that the alerting mechanism is working as expected. -[Click here for Alerts Verification](post-install-verification/alert-overview.md) +[Click here for Alerts Verification](./elastic-stack-setup-04-post-install-verification/alert-overview.md) > [!NOTE] > All Kibana dashboards are designed and optimized for **1920x1080** screen resolution to ensure optimal viewing experience and proper layout formatting. - -## Next Step - -[Click here for the next step](../../docs/relativity_alerts_installation.md) diff --git a/docs/environment-watch/post-install-verification/alert-overview.md b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification/alert-overview.md similarity index 96% rename from docs/environment-watch/post-install-verification/alert-overview.md rename to elastic-stack-setup/elastic-stack-setup-04-post-install-verification/alert-overview.md index 6b2dfe3f..d729b6aa 100644 --- a/docs/environment-watch/post-install-verification/alert-overview.md +++ b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification/alert-overview.md @@ -1,5 +1,4 @@ # Post-Install Verification for Alerts -![Post-Install Verification Banner](../../../resources/post-install-verification-images/Post-installation-verification.svg) ## Verify that the dashboard exists diff --git a/docs/environment-watch/post-install-verification/elasticsearch-cluster-health.md b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification/elasticsearch-cluster-health.md similarity index 94% rename from docs/environment-watch/post-install-verification/elasticsearch-cluster-health.md rename to elastic-stack-setup/elastic-stack-setup-04-post-install-verification/elasticsearch-cluster-health.md index ff3657bb..4bfb9193 100644 --- a/docs/environment-watch/post-install-verification/elasticsearch-cluster-health.md +++ b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification/elasticsearch-cluster-health.md @@ -1,5 +1,4 @@ # Post-Install Verification for Elastic Cluster Health -![Post-Install Verification Banner](../../../resources/post-install-verification-images/Post-installation-verification.svg) ## Verify that the dashboard exists diff --git a/docs/environment-watch/post-install-verification/monitoring-agents.md b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification/monitoring-agents.md similarity index 93% rename from docs/environment-watch/post-install-verification/monitoring-agents.md rename to elastic-stack-setup/elastic-stack-setup-04-post-install-verification/monitoring-agents.md index be9a4c45..5d0c5836 100644 --- a/docs/environment-watch/post-install-verification/monitoring-agents.md +++ b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification/monitoring-agents.md @@ -1,5 +1,4 @@ # Post-Install Verification for Monitoring Agents -![Post-Install Verification Banner](../../../resources/post-install-verification-images/Post-installation-verification.svg) ## Verify Monitoring Agent dashboard exists diff --git a/docs/environment_watch_product_overview.md b/elastic-stack-setup/environment_watch_product_overview.md similarity index 100% rename from docs/environment_watch_product_overview.md rename to elastic-stack-setup/environment_watch_product_overview.md diff --git a/docs/environment_watch_troubleshooting.md b/elastic-stack-setup/environment_watch_troubleshooting.md similarity index 100% rename from docs/environment_watch_troubleshooting.md rename to elastic-stack-setup/environment_watch_troubleshooting.md diff --git a/docs/troubleshooting/apm-server.md b/elastic-stack-setup/troubleshooting/apm-server.md similarity index 100% rename from docs/troubleshooting/apm-server.md rename to elastic-stack-setup/troubleshooting/apm-server.md diff --git a/docs/troubleshooting/elasticsearch.md b/elastic-stack-setup/troubleshooting/elasticsearch.md similarity index 100% rename from docs/troubleshooting/elasticsearch.md rename to elastic-stack-setup/troubleshooting/elasticsearch.md diff --git a/docs/troubleshooting/kibana.md b/elastic-stack-setup/troubleshooting/kibana.md similarity index 100% rename from docs/troubleshooting/kibana.md rename to elastic-stack-setup/troubleshooting/kibana.md diff --git a/docs/troubleshooting/monitoring-agent-and-otel-collector.md b/elastic-stack-setup/troubleshooting/monitoring-agent-and-otel-collector.md similarity index 100% rename from docs/troubleshooting/monitoring-agent-and-otel-collector.md rename to elastic-stack-setup/troubleshooting/monitoring-agent-and-otel-collector.md diff --git a/docs/troubleshooting/pre-requisite-troubleshooting.md b/elastic-stack-setup/troubleshooting/pre-requisite-troubleshooting.md similarity index 100% rename from docs/troubleshooting/pre-requisite-troubleshooting.md rename to elastic-stack-setup/troubleshooting/pre-requisite-troubleshooting.md diff --git a/docs/troubleshooting/relativity-server-cli.md b/elastic-stack-setup/troubleshooting/relativity-server-cli.md similarity index 100% rename from docs/troubleshooting/relativity-server-cli.md rename to elastic-stack-setup/troubleshooting/relativity-server-cli.md diff --git a/docs/troubleshooting/relativity_alerts_troubleshooting.md b/elastic-stack-setup/troubleshooting/relativity_alerts_troubleshooting.md similarity index 100% rename from docs/troubleshooting/relativity_alerts_troubleshooting.md rename to elastic-stack-setup/troubleshooting/relativity_alerts_troubleshooting.md diff --git a/docs/environment-watch/Elastic Stack Port Diagram 01.svg b/resources/Elastic Stack Port Diagram 01.svg similarity index 100% rename from docs/environment-watch/Elastic Stack Port Diagram 01.svg rename to resources/Elastic Stack Port Diagram 01.svg