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_pre_installation_overview.md b/docs/elasticsearch_pre_installation_overview.md deleted file mode 100644 index 6f1bf3da..00000000 --- a/docs/elasticsearch_pre_installation_overview.md +++ /dev/null @@ -1,295 +0,0 @@ -# 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: - -| Elastic Component | Environment Watch | Data Grid Audit | -|-------------------|-------------------|------------------| -| **Elasticsearch** | Required | Required | -| **Kibana** | Required | Recommended but optional | -| **APM Server** | Required | Not used | - -> [!NOTE] -> At this stage, there is no integration between any Elastic components and Relativity. Integration will be configured during **Step 2**. - -In **Step 1**, the following actions are performed: -- Set up and verify the **Elasticsearch** cluster -- Set up **Kibana** and/or **APM Server**, depending on the product configuration - -This step covers configuring a **shared Elasticsearch cluster** to be used for both **Environment Watch** and **Data Grid Audit**. - -For detailed software and hardware prerequisites, refer to the [System Requirements section in the README](../README.md). - -Before proceeding, the following section introduces key **Elastic Stack concepts**. - - -## Elastic Key Concepts - -### Elasticsearch - -> [!IMPORTANT] -> Ensure inbound/outbound ports are open for this Elastic stack component. - -[See the port diagram for network requirements.](environment-watch/port-diagram.md) - -Elasticsearch is a distributed search and analytics engine, scalable data store, and vector database built on Apache Lucene. It’s optimized for speed and relevance on production-scale workloads. - -#### Elasticsearch Cluster - -Elasticsearch is built on a distributed architecture made up of many servers or nodes. An Elasticsearch cluster is a group of one or more node instances that are connected together. Clustering enables Elasticsearch nodes to work together to ensure high availability when one or more nodes are down. An Elasticsearch cluster can continue operating normally if some of its nodes are unavailable or disconnected, as long as there are enough well-connected nodes to ensure high resilience and improved search performance. - -See below for more information on Elasticsearch cluster configuration and high availability options: - -- [Cluster configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html) -- [Set up a cluster for high availability](https://www.elastic.co/guide/en/elasticsearch/reference/current/high-availability.html) - -#### Elasticsearch Nodes - -An Elasticsearch node is a single server that is a part of a cluster. If a single node of Elasticsearch is running, then there is a cluster of one node. A node can have one or many roles that define the role(s) it plays within the cluster. The node role(s) is defined within the elasticsearch.yml . If roles are not set, the node is assigned to most available roles. - -See [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html#node-name-settings) for more information on Elasticsearch node settings and roles. - -The two key roles for an Environment Watch and/or Data Grid Audit cluster are master and data. - -- **Master Node**: controls the Elasticsearch cluster and is responsible for all cluster-wide operations like creating/deleting an index and adding/removing nodes. -- **Data Node**: stores data and executes data-related operations such as search and aggregation. - -Every Elasticsearch cluster requires at least one node designated master and data. - -> [!NOTE] -> In a cluster being used for both Environment Watch and Data Grid Audit, you do not designate any given data node as being for one or the other. Any node in the cluster can support operations for either product. - -### Kibana - -> [!IMPORTANT] -> Ensure inbound/outbound ports are open for this Elastic stack component. - -[See the port diagram for network requirements.](environment-watch/port-diagram.md) - -Kibana is a user interface that lets users visualize Elasticsearch data and navigate the Elastic stack. See below for more information on Kibana. - -- [What is Kibana?](https://www.elastic.co/guide/en/kibana/current/introduction.html) -- [Kibana key concepts](https://www.elastic.co/guide/en/kibana/current/kibana-concepts-analysts.html) - -### APM Server - -> [!IMPORTANT] -> Ensure inbound/outbound ports are open for this Elastic stack component. - -[See the port diagram for network requirements.](environment-watch/port-diagram.md) - -The APM Server provides a fully Open Telemetry compliant telemetry backend to periodically receive log, metric, and trace data from each monitored server. - -See [here](https://www.elastic.co/guide/en/observability/current/apm.html) for more information about Elastic’s APM Server. - -## System Requirements and Licensing - -> [!NOTE] -> The documentation below includes several links to instructions in Elastic’s official documentation. Whenever jumping into Elastic documentation, ensure the proper Elasticsearch, Kibana, or APM Server documentation version is selected. - -Setting up the Elastic stack components will require installing Elastic software on one or more servers. This installation guide covers configuring a shared Elasticsearch cluster to use for both Environment Watch and Data Grid Audit. The **_Hardware Recommendations by Environment Size_** section below provides hardware guidance for different deployment scenarios and reference environments. - -![](../resources/elasticsearch_setup_002.png) - -**Small environment size used for Environment Watch and Data Grid Audit_** - -### Software Requirements - -Any server being used to host Elastic components requires: - -- **Operating System** – See [here](https://help.relativity.com/Server2024/Content/System_Guides/Workstation_Configuration/User_hardware_and_software_requirements.htm) for supported operating systems. - -### Hardware Recommendations by Environment Size - -The number of servers and hardware specifications needed to host the Elastic components will vary depending on the size of the Relativity instance and whether the cluster is intended for Environment Watch, Data Grid Audit, or both. Below are recommendations based on four Relativity Server environment sizes. These are only recommendations. The node counts and role blends can be adjusted for the environment based on observed and desired performance and reliability needs. - -**A few other key notes and reminders:** - -- **Tuning for speed** – Review Elastic’s guidance on how to tune the environment for speed [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/tune-for-search-speed.html). -- **Hosting Elastic** – While the guidance below recommends installing the Elastic components on many dedicated servers, there are no hard requirements to isolate Elasticsearch, Kibana, or APM Server on dedicated hosts. As evident with the Development environment specifications, the full Elastic stack can be deployed on a single host if that server can meet the storage needs. - - **Kibana and APM Server hosting:** - - For Small environments, we recommend dedicated servers for Kibana and APM Server, but can consider installing Kibana and/or APM Server on a single server or even on the same server being used as an Elasticsearch node for development and very small environments. - - For Medium environments and above, we strongly recommend installing Kibana and APM Server each on dedicated servers. -- **Nodes in a shared Environment Watch/Data Grid cluster** – In a cluster being used for both Environment Watch and Data Grid Audit, data nodes are not required to be designated for one or the other. Any node in the cluster can support operations for either product, though dedicated node assignments may be needed for certain workloads. - -**Environment Size** - -The environment size is defined by the number of Web, Agent, and Worker servers within the instance. - -| Environment Size| Web Servers | Agent Servers | Workers | -| --------------- | ------------- | ------------- | ------- | -| Development | 1 | 1 | 1 | -| Small | 1 | 4 | 1 | -| Medium | 2-4 | 5-9 | 2-9 | -| Large | 5+ | 10+ | 10+ | - -> Each Elasticsearch server should have at least 4 vCPU and 32 GB RAM. - -#### Environment Size – Development - -> [!NOTE] -> For a development environment, all Elasticsearch components are installed within a single server to minimize complexity and get up and running as quickly as possible. There are no data upgrades performed for this environment. -
- -| Elastic Stack Component | Server Count | -| ----------------------------------------- | ------------ | -| **Environment Watch Only** | | -| Elasticsearch/Kibana/APM Server | 1 | -| **Data Grid Audit Only** | | -| Elasticsearch/Kibana (optional) | 1 | -| **Environment Watch and Data Grid Audit** | | -| Elasticsearch/Kibana/APM Server | 1 | - -| Elastic Stack Component | Server Count | Disk (TB) | -| ----------------------------------------- | ------------ | ---------- | -| **Environment Watch Only** | | | -| Elasticsearch/Kibana/APM Server | 1 | 1 | -| **Data Grid Audit Only** | | | -| Elasticsearch/Kibana (optional) | 1 | 1 | -| **Environment Watch and Data Grid Audit** | | | -| Elasticsearch/Kibana/APM Server | 1 | 1 | - -#### Environment Size – Small - -> [!NOTE] -> For a small environment, we recommend dedicated Kibana and APM Server server, but can consider installing Kibana and/or APM Server on a single server or even on the same server being used as an Elasticsearch node. -
- -| Elastic Stack Component | Server Count | -| ----------------------------------------- | ------------ | -| **Environment Watch Only** | | -| Elasticsearch nodes | 2 | -| Kibana | 1 | -| APM Server | 1 | -| **Data Grid Audit Only** | | -| Elasticsearch nodes | 2 | -| Kibana (optional) | 1 | -| APM Server | N/A | -| **Environment Watch and Data Grid Audit** | | -| Elasticsearch nodes | 3 | -| Kibana | 1 | -| APM Server | 1 | - -| Elastic Stack Component | Server Count | Disk (TB) | -| ----------------------------------------- | ------------ | ---------- | -| **Environment Watch Only** | | | -| Elasticsearch nodes | 2 | 1 | -| Kibana | 1 | 1 | -| APM Server | 1 | 1 | -| **Data Grid Audit Only** | | | -| Elasticsearch nodes | 2 | 1 | -| Kibana (optional) | 1 | 1 | -| APM Server | N/A | - | -| **Environment Watch and Data Grid Audit** | | | -| Elasticsearch nodes | 3 | 1 | -| Kibana | 1 | 1 | -| APM Server | 1 | 1 | - -#### Environment Size – Medium - -> [!NOTE] -> For a medium environment, a few additional nodes are added to the Elasticsearch cluster(s). -
- -| Elastic Stack Component | Server Count | -| ----------------------------------------- | ------------ | -| **Environment Watch Only** | | -| Elasticsearch nodes | 3 | -| Kibana | 1 | -| APM Server | 1 | -| **Data Grid Audit Only** | | -| Elasticsearch nodes | 3 | -| Kibana (optional) | 1 | -| APM Server | N/A | -| **Environment Watch and Data Grid Audit** | | -| Elasticsearch nodes | 6 | -| Kibana | 1 | -| APM Server | 1 | - -| Elastic Stack Component | Server Count | Disk (TB) | -| ----------------------------------------- | ------------ | ---------- | -| **Environment Watch Only** | | | -| Elasticsearch nodes | 3 | 2 | -| Kibana | 1 | 2 | -| APM Server | 1 | 2 | -| **Data Grid Audit Only** | | | -| Elasticsearch nodes | 3 | 2 | -| Kibana (optional) | 1 | 2 | -| APM Server | N/A | - | -| **Environment Watch and Data Grid Audit** | | | -| Elasticsearch nodes | 6 | 2 | -| Kibana | 1 | 2 | -| APM Server | 1 | 2 | - - -#### Environment Size – Large - -> [!NOTE] -> For a large environment, Elasticsearch is scaled horizontally by adding more nodes to the cluster(s). - -| Elastic Stack Component | Server Count | -| ----------------------------------------- | ---------------------- | -| **Environment Watch Only** | | -| Elasticsearch nodes | 4 | -| Kibana | 1 | -| APM Server | 1 | -| **Data Grid Audit Only** | | -| Elasticsearch nodes | 1-15 (scale on demand) | -| Kibana (optional) | 1 | -| APM Server | N/A | -| **Environment Watch and Data Grid Audit** | | -| Elasticsearch nodes | 4-18 (scale on demand) | -| Kibana | 1 | -| APM Server | 1 | - -| Elastic Stack Component | Server Count | Disk (TB) | -| ----------------------------------------- | ---------------------- | ---------- | -| **Environment Watch Only** | | | -| Elasticsearch nodes | 4 | 4 | -| Kibana | 1 | 4 | -| APM Server | 1 | 4 | -| **Data Grid Audit Only** | | | -| Elasticsearch nodes | 1-15 (scale on demand) | 4 | -| Kibana (optional) | 1 | 4 | -| APM Server | N/A | - | -| **Environment Watch and Data Grid Audit** | | | -| Elasticsearch nodes | 4-18 (scale on demand) | 4 | -| Kibana | 1 | 4 | -| APM Server | 1 | 4 | - - -### Licensing - -Environment Watch only requires a free and open ("Basic") Elastic license. By default, new installations have a Basic license that never expires. If you would like to utilize additional Elastic features from the Platinum or Enterprise subscription, you will need to purchase the license separately. - -If you have used Elasticsearch for the optional Data Grid Audit feature on Relativity Server prior to April 2025, you would have been using a Platinum license key provided by Relativity. Effective with Server 2024 Patch 1, the Platinum license is no longer required for Data Grid Audit and Relativity will not provide a Platinum license for any new deployments of Data Grid Audit. All existing Data Grid Audit customers will have until early 2026 to adopt Relativity Server 2024 and update to a Basic Elastic license. - -## Installing the Elastic stack components - -### Before you start - -1. **Plan your cluster** – based on the size of your environment, establish a game plan for how many servers/nodes you intend to use and the role of each node within the cluster. We recommend using a Development environment to test drive Environment Watch in order to get up and running as quickly as possible. - -2. **Review the required ports for Elastic components** – See the [port diagram](environment-watch/port-diagram.md) for network requirements and ensure all necessary ports are open between servers hosting Elasticsearch, Kibana, and APM Server. - -3. **Windows *should* be updated to support long paths** - This is recommended because the Elastic Stack components have dense file paths when fully extracted. In many cases, the product appears to function properly but certain features may fail because files may be missing or cannot be accessed because the path exceeds the max Windows character length. Run "gpedit.msc" to navigate into Local Group Policy Editor → Computer Configuration → Administrative Template → System → Filesystem. Double click on Enable Win32 Long path. Select the Enable radio button, click Apply, and then click OK. - - - https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry#enable-long-paths-in-windows-10-version-1607-and-later - - -3. **Verify the minimum supported version of Elastic** - All Relativity products have been certified with Elastic Stack 8.x or 9.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. - -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. - -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)). - -### Next step - -[Click here to setup an Elastic Stack for a development environment](./elasticsearch_setup_development.md) - -[Click here to setup an Elastic Stack for a production environment](./elasticsearch_setup_production.md) \ No newline at end of file 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_troubleshooting.md b/docs/environment_watch_troubleshooting.md deleted file mode 100644 index 6639846c..00000000 --- a/docs/environment_watch_troubleshooting.md +++ /dev/null @@ -1,14 +0,0 @@ -# Environment Watch Troubleshooting Guide - -This document provides quick reference links to detailed troubleshooting guides for all components in the Relativity Server Bundle environment. - -## Component Troubleshooting Guides - -- [Pre-requisite Troubleshooting](troubleshooting/pre-requisite-troubleshooting.md) -- [Elasticsearch Troubleshooting](troubleshooting/elasticsearch.md) -- [Kibana Troubleshooting](troubleshooting/kibana.md) -- [APM Server Troubleshooting](troubleshooting/apm-server.md) -- [Environment Watch Monitoring Agent and Open Telemetry Collector Troubleshooting](troubleshooting/monitoring-agent-and-otel-collector.md) -- [Relativity Server CLI Troubleshooting](troubleshooting/relativity-server-cli.md) -- [Relativity Alerts Troubleshooting](troubleshooting/relativity_alerts_troubleshooting.md) -- [Custom JSON Configuration Troubleshooting](troubleshooting/custom-json-troubleshooting.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/environment_watch_installation.md b/elastic-stack-setup/elastic-stack-setup-01-installation.md similarity index 75% rename from docs/environment_watch_installation.md rename to elastic-stack-setup/elastic-stack-setup-01-installation.md index 2fe71dee..8b490ca0 100644 --- a/docs/environment_watch_installation.md +++ b/elastic-stack-setup/elastic-stack-setup-01-installation.md @@ -1,5 +1,4 @@ -# Environment Watch and Data Grid Audit Installation - +# Environment Watch and Data Grid Audit Installation ## Installation Overview @@ -10,9 +9,4 @@ The Relativity applications and components that are referenced in this installat 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 +// TODO add link to Elastic stack setup \ 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/elastic-stack-setup-02-environment-watch.md similarity index 92% rename from docs/relativity_server_cli_setup.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/elastic-stack-setup-02-environment-watch.md index 4e0e7e5e..30d45aea 100644 --- a/docs/relativity_server_cli_setup.md +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/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. @@ -83,12 +81,11 @@ 6. Successful completion indicates that Environment Watch is configured. The setup process will automatically retry three times on parameter entry errors before exiting. If it exits, the process must be restarted.. -Refer to the [Troubleshooting Guide](troubleshooting/relativity-server-cli.md) if you encounter any issues. +Refer to the [Troubleshooting Guide](../troubleshooting/relativity-server-cli.md) if you encounter any issues. ## 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](./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 54% 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..1f595cff 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. @@ -10,7 +8,7 @@ The Relativity Alerts application is a new application as part of the Relativity ## Permissions - To install the application, access it, and receive alerts, the user must be part of the Relativity System Administrators Group. -- To access Kibana dashboards and saved searches a new account must be created for each user and be assigned to the custom Kibana role which is installed during the Environment Watch CLI setup. See [Create Kibana Users for Dashboard Access](create_kibana_users.md) for more information. +- To access Kibana dashboards and saved searches a new account must be created for each user and be assigned to the custom Kibana role which is installed during the Environment Watch CLI setup. See [Create Kibana Users for Dashboard Access](#create-kibana-users-and-assign-roles) for more information. ## Installation @@ -18,55 +16,80 @@ To install the Relativity Alerts application on your Relativity instance: 1. Log in to Relativity as a System Administrator. 2. Navigate to the Application Library tab. 3. Click **Upload Application**
- ![relativity_alerts_installation_001](../resources/relativity_alerts_installation_001.png) + ![relativity_alerts_installation_001](../../resources/relativity_alerts_installation_001.png) 4. Click **Select File**.
- ![relativity_alerts_installation_002](../resources/relativity_alerts_installation_002.png) + ![relativity_alerts_installation_002](../../resources/relativity_alerts_installation_002.png) 5. The [Environment Watch bundle](https://github.com/relativitydev/server-bundle-release/releases) contains a RAPs folder with subfolders organized by Relativity Server version. Each subfolder **Server202X** contains the corresponding Relativity Alerts RAP file for that Relativity Server version. - ![relativity_alerts_installation_007](../resources/relativity_alerts_installation_007.png) + ![relativity_alerts_installation_007](../../resources/relativity_alerts_installation_007.png) Navigate to the subfolder that matches your Relativity Server version, select the Relativity Alerts RAP file, and then click **Open**.
- ![relativity_alerts_installation_003](../resources/relativity_alerts_installation_003.png) + ![relativity_alerts_installation_003](../../resources/relativity_alerts_installation_003.png) 6. Click **Save** to upload the file to the Application Library.
- ![relativity_alerts_installation_004](../resources/relativity_alerts_installation_004.png) - ![relativity_alerts_installation_005](../resources/relativity_alerts_installation_005.png) - ![relativity_alerts_installation_006](../resources/relativity_alerts_installation_006.png) + ![relativity_alerts_installation_004](../../resources/relativity_alerts_installation_004.png) + ![relativity_alerts_installation_005](../../resources/relativity_alerts_installation_005.png) + ![relativity_alerts_installation_006](../../resources/relativity_alerts_installation_006.png) A list of common install issues and their resolutions are available at the [troubleshooting guide](../docs/troubleshooting/relativity_alerts_troubleshooting.md). ## Verification 1. Navigate to the **Alerts** tab, you should see all alerts available in Kibana.
- ![relativity_alerts_verification_001](../resources/relativity_alerts_verification_001.png) + ![relativity_alerts_verification_001](../../resources/relativity_alerts_verification_001.png) 2. Navigate to **Logs & Dashboards** tab, you should see all Environment Watch dashboards and saved searches available in Kibana.
- ![relativity_alerts_verification_002](../resources/relativity_alerts_verification_002.png) + ![relativity_alerts_verification_002](../../resources/relativity_alerts_verification_002.png) 3. When on **Logs & Dashboards** tab, find **Alerts Overview88 dashboard and click the link. A new web browser tab will be created and you should be redirected to "Alerts Overview" dashboard in Kibana. If you have not logged in into Kibana yet, you will be prompted with a Kibana login page. Please login with your Kibana user account with privileges.
- ![relativity_alerts_verification_003_001](../resources/relativity_alerts_verification_003_001.png) - ![relativity_alerts_verification_003_002](../resources/relativity_alerts_verification_003_002.png) - ![relativity_alerts_verification_003_003](../resources/relativity_alerts_verification_003_003.png) + ![relativity_alerts_verification_003_001](../../resources/relativity_alerts_verification_003_001.png) + ![relativity_alerts_verification_003_002](../../resources/relativity_alerts_verification_003_002.png) + ![relativity_alerts_verification_003_003](../../resources/relativity_alerts_verification_003_003.png) 4. To confirm that the alerting functionality is operational, please do the following: a. Go to the Agents tab
b. Select **File Deletion Manager** agent and disable it.
- ![relativity_alerts_verification_004_001](../resources/relativity_alerts_verification_004_001.png) + ![relativity_alerts_verification_004_001](../../resources/relativity_alerts_verification_004_001.png) c. Within the next 30-60 seconds, the bell icon, in the top-right corner, will indicate that there is a new Alert.
- ![relativity_alerts_verification_004_002](../resources/relativity_alerts_verification_004_002.png) + ![relativity_alerts_verification_004_002](../../resources/relativity_alerts_verification_004_002.png) d. Click on the bell icon, and you should be able to see the active **One or more agents are disabled** alert in the alert flyout.
- ![relativity_alerts_verification_004_003](../resources/relativity_alerts_verification_004_003.png) + ![relativity_alerts_verification_004_003](../../resources/relativity_alerts_verification_004_003.png) e. Click on the question mark icon next to the **One or more agents are disabled** alert, and you will be redirected to the resolution guidance for this alert in a new tab of your web browser.
- ![relativity_alerts_verification_004_004](../resources/relativity_alerts_verification_004_004.png)
- ![relativity_alerts_verification_004_005](../resources/relativity_alerts_verification_004_005.png) + ![relativity_alerts_verification_004_004](../../resources/relativity_alerts_verification_004_004.png)
+ ![relativity_alerts_verification_004_005](../../resources/relativity_alerts_verification_004_005.png) f. Return to the previous tab in Relativity, then click on the bell icon in the top-right corner. When the alert flyout opens, click on the 'One or more agents are disabled' alert, and you will be redirected to a filtered list of disabled agents in the Agents tab within Relativity.
- ![relativity_alerts_verification_004_006](../resources/relativity_alerts_verification_004_006.png) + ![relativity_alerts_verification_004_006](../../resources/relativity_alerts_verification_004_006.png) g. While on Agents tab, please remember to enable the **File Deletion Manager** agent. 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 + +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](../troubleshooting/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/ew-03-extensibility-configuration.md) diff --git a/docs/environment_watch_install_other_integrations.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-03-extensibility-configuration.md similarity index 53% rename from docs/environment_watch_install_other_integrations.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-03-extensibility-configuration.md index 688f4b22..d04fa848 100644 --- a/docs/environment_watch_install_other_integrations.md +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-03-extensibility-configuration.md @@ -1,7 +1,5 @@ # Install Other Integrations -![](../resources/caat_environment_watch_setup.png) - > [!NOTE] > This step is required for Environment Watch. @@ -9,29 +7,42 @@ This guide provides information on integrating various Relativity components wit ## Available Integrations +### RabbitMQ Integration + +The RabbitMQ integration enables monitoring of RabbitMQ queues, exchanges, and nodes. + +- [Setting Up RabbitMQ Integration](./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](analytics/caat_environment_watch_setup.md) +- [Setting Up OpenTelemetry Java Agent for Relativity Analytics Engine](./ew-extensibility-configuration-02-caat.md) -### RabbitMQ Integration +### Retention Policy -The RabbitMQ integration enables monitoring of RabbitMQ queues, exchanges, and nodes. +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. -- [Setting Up RabbitMQ Integration](rabbitmq/rabbitmq_integration.md) +- [Elasticsearch Retention Policy Guidelines](./ew-extensibility-configuration-03-retention-policy.md) -### Custom-JSON Integration +### IIS Configuration -The Custom-JSON integration enables monitoring of Windows Services, Certificates, Kibana Alerts with Slack Notifications, and SQL Cluster Instances. +Configuring IIS log fields required for proper log ingestion by Environment Watch. + +- [Setting Up IIS configuration](./ew-extensibility-configuration-04-iis.md) -- [Setting Up Custom-JSON Integration](custom-json-configuration/environment_watch_configuration.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) +- [Setting Up Elasticsearch 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-extensibility-configuration-06-json-configuration.md) ## Next Step -[Click here for the next step](./environment-watch/post-install-verification.md) \ No newline at end of file +[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 97% 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 index 2144ebb2..0f388d74 100644 --- 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 @@ -3,7 +3,7 @@ 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. -For other Other integrations, refer to the [Environment Watch Install other Integrations Guide](../environment_watch_install_other_integrations.md). +For other Other integrations, refer to the [Environment Watch Install other Integrations Guide](./ew-03-extensibility-configuration.md). ## Why use opentelemetry-javaagent? 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 98% 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 index a4609c36..8596c761 100644 --- 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 @@ -10,7 +10,7 @@ The Environment Watch monitoring agent uses OpenTelemetry (OTEL) collectors to p - IIS installed on the Server - Administrative access to the IIS Manager -- Environment Watch monitoring agent installed (see [Install Environment Watch Monitoring Agents](install_environment_watch_monitoring_agents.md)) +- Environment Watch monitoring agent installed (see [Install Environment Watch Monitoring Agents](../ew-01-install-monitoring-agents.md)) ## Terminology and Abbreviations @@ -361,7 +361,7 @@ labels.iis_log_http_target:"/Relativity*" 1. Expand one of the log entries by clicking the arrow icon - ![IIS Log Details Arrow](../resources/iis_log_details_arrow.png) + ![IIS Log Details Arrow](../../../resources/iis_log_details_arrow.png) 2. Verify that all IIS log fields are present and populated: - `labels.iis_log_date_time` @@ -371,4 +371,4 @@ labels.iis_log_http_target:"/Relativity*" - `labels.iis_log_http_server_status` - `labels.iis_log_http_server_duration` and all other mapped fields - ![IIS Log Field Mapping](../resources/iis__log_field_mapping.png) + ![IIS Log Field Mapping](../../../resources/iis__log_field_mapping.png) 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 89% 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 index a223215d..3f669856 100644 --- 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 @@ -30,15 +30,15 @@ This documentation provides step-by-step instructions for manually updating Elas 1. Log in to Kibana as a user with administrative privileges. 2. In Kibana, go to **Stack Management** → **Index Management** → **Component Templates**. 3. Use the search box to find the **apm@settings** component template. - ![Screenshot: apm@settings in Kibana](../../resources/post-install-verification-images/elasticsearch-index-settings/apm-settings.png) + ![Screenshot: apm@settings in Kibana](../../../resources/post-install-verification-images/elasticsearch-index-settings/apm-settings.png) 4. Click the **Edit** button in the **Actions** column. 5. In the edit view, navigate to the **Index settings** section. - ![Screenshot: edit apm@settings in Kibana](../../resources/post-install-verification-images/elasticsearch-index-settings/index-settings.png) + ![Screenshot: edit apm@settings in Kibana](../../../resources/post-install-verification-images/elasticsearch-index-settings/index-settings.png) 6. Add or update the field limit setting: - Key: `index.mapping.total_fields.limit` - Value: the required limit (for example, `2500`) - ![Screenshot: update limit in Kibana](../../resources/post-install-verification-images/elasticsearch-index-settings/apm-settings-edit-limit.png) + ![Screenshot: update limit in Kibana](../../../resources/post-install-verification-images/elasticsearch-index-settings/apm-settings-edit-limit.png) > [!NOTE] > - The default value of `index.mapping.total_fields.limit` is `1000`. The `limit` field is not included by default; for a first-time update, add the `limit` field and set it to the required value. @@ -46,7 +46,7 @@ This documentation provides step-by-step instructions for manually updating Elas 7. After updating the field limit, navigate to the **Review** tab and click **Save component template**. 8. Verify that the **apm@settings** component template shows the updated field limit. - ![Screenshot: verify limit in Kibana](../../resources/post-install-verification-images/elasticsearch-index-settings/apm-settings-updated-limit-verify.png) + ![Screenshot: verify limit in Kibana](../../../resources/post-install-verification-images/elasticsearch-index-settings/apm-settings-updated-limit-verify.png) #### Step 2: Perform a Rollover to Apply the New Settings @@ -75,7 +75,7 @@ To apply the new settings, the following steps are required: In the document details, find the value of the `_index` field. Example: `.ds-logs-apm.app.relsvr_logging-default-2025.11.26-000013` - ![Screenshot: data stream in Kibana](../../resources/post-install-verification-images/elasticsearch-index-settings/latest-document.png) + ![Screenshot: data stream in Kibana](../../../resources/post-install-verification-images/elasticsearch-index-settings/latest-document.png) 5. Derive the data stream name diff --git a/docs/custom-json-configuration/environment_watch_configuration.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-extensibility-configuration-06-json-configuration.md similarity index 96% rename from docs/custom-json-configuration/environment_watch_configuration.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-extensibility-configuration-06-json-configuration.md index 4f1603e7..c9c3ae06 100644 --- a/docs/custom-json-configuration/environment_watch_configuration.md +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-extensibility-configuration-06-json-configuration.md @@ -103,21 +103,21 @@ An example of the BCPPath and folder structure is shown below: This section describes the main types of sources that can be monitored using the Environment Watch configuration: Windows services, certificates, Kibana Alerts through Slack notifications, and SQL server instances. Each source type has its own configuration structure and properties. Following are the details for each source type: --- -### Windows Services - -For detailed instructions, see [Windows Service Configuration](windows_services_configuration.md). - ### Certificates -For detailed instructions, see [Certificates Configuration](certificates_configuration.md). +For detailed instructions, see [Certificates Configuration](ew-json-configuration-01-certificates.md). -### SQL Server Instances +### Windows Services -For detailed instructions, see [SQL Server Configuration](../sql-server-configuration/sql-server-configuration.md). +For detailed instructions, see [Windows Service Configuration](ew-json-configuration-02-windows-services.md). ### Slack Alert Notifications -For detailed instructions, see [Alert Notification Handlers](alert_notification_handlers_configuration.md). +For detailed instructions, see [Alert Notification Handlers](ew-json-configuration-03-slack.md). + +### SQL Server Instances + +For detailed instructions, see [SQL Server Configuration](ew-json-configuration-04-sql-server.md). ## Example Configuration diff --git a/docs/custom-json-configuration/certificates_configuration.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-01-certificates.md similarity index 97% rename from docs/custom-json-configuration/certificates_configuration.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-01-certificates.md index c3d8d294..dd592d39 100644 --- a/docs/custom-json-configuration/certificates_configuration.md +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-01-certificates.md @@ -150,4 +150,4 @@ For certificates to monitor, locate "**certificates**" under the desired section ![](/resources/custom-json-images/certificate-dashboard-example.png) ## Troubleshooting -Refer to the [Troubleshooting Guide](../troubleshooting/custom-json-troubleshooting.md) to resolve any custom JSON certificate configuration issues. \ No newline at end of file +Refer to the [Troubleshooting Guide](../../../troubleshooting/custom-json-troubleshooting.md) to resolve any custom JSON certificate configuration issues. \ No newline at end of file diff --git a/docs/custom-json-configuration/windows_services_configuration.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-02-windows-services.md similarity index 96% rename from docs/custom-json-configuration/windows_services_configuration.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-02-windows-services.md index 80b51fba..4c6fa009 100644 --- a/docs/custom-json-configuration/windows_services_configuration.md +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-02-windows-services.md @@ -124,4 +124,4 @@ For services to monitor, locate "**windowsServices**" under the desired section --- ## Troubleshooting -Refer to the [Troubleshooting Guide](../troubleshooting/custom-json-troubleshooting.md) to resolve any custom JSON windows services configuration issues. \ No newline at end of file +Refer to the [Troubleshooting Guide](../../../troubleshooting/custom-json-troubleshooting.md) to resolve any custom JSON windows services configuration issues. \ No newline at end of file diff --git a/docs/custom-json-configuration/alert_notification_handlers_configuration.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-03-slack.md similarity index 93% rename from docs/custom-json-configuration/alert_notification_handlers_configuration.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-03-slack.md index 43e37e05..f83b632d 100644 --- a/docs/custom-json-configuration/alert_notification_handlers_configuration.md +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-03-slack.md @@ -101,8 +101,8 @@ To configure Slack notification in the custom JSON configuration file, locate th ### Slack Notification Example -![Slack Example](../../resources/slackalerts-images/SlackNotification.png) +![Slack Example](/resources/slackalerts-images/SlackNotification.png) ## Troubleshooting -Refer to the [Troubleshooting Guide](../troubleshooting/custom-json-troubleshooting.md) to resolve any custom JSON slack configuration issues. +Refer to the [Troubleshooting Guide](../../../troubleshooting/custom-json-troubleshooting.md) to resolve any custom JSON slack configuration issues. diff --git a/docs/sql-server-configuration/sql-server-configuration.md b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-04-sql-server.md similarity index 96% rename from docs/sql-server-configuration/sql-server-configuration.md rename to elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-04-sql-server.md index 6545ea91..bd956e26 100644 --- a/docs/sql-server-configuration/sql-server-configuration.md +++ b/elastic-stack-setup/elastic-stack-setup-02-environment-watch/ew-03-extensibility-configuration/ew-extensibility-configuration-06-json-configuration/ew-json-configuration-04-sql-server.md @@ -108,4 +108,4 @@ Once the Windows service has been restarted, verify the SQL instances are being --- ## Troubleshooting -Refer to the [Troubleshooting Guide](../troubleshooting/custom-json-troubleshooting.md) to resolve any custom JSON SQL server configuration issues. \ No newline at end of file +Refer to the [Troubleshooting Guide](../../../troubleshooting/custom-json-troubleshooting.md) to resolve any custom JSON SQL server configuration issues. \ No newline at end of file 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..ac6deb5b 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/elastic-stack-setup-04-post-install-verification.md) \ No newline at end of file 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 79% 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..fb598497 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 @@ -19,7 +18,7 @@ Ensure that the **[Relativity] Alerts Overview** dashboard is successfully insta - The dashboard is accessible without errors. **Screenshot:** -![Screenshot: Dashboard listed in Kibana](../../../resources/post-install-verification-images/alerts-overview/dashboard-listed.png) +![Screenshot: Dashboard listed in Kibana](../../resources/post-install-verification-images/alerts-overview/dashboard-listed.png) ## Verify the dashboard tag @@ -37,7 +36,7 @@ Confirm that the correct tag is applied to the dashboard for proper categorizati - The dashboard includes the **Relativity Environment Watch** tag. **Screenshot:** -![Screenshot: Dashboard tag](../../../resources/post-install-verification-images/alerts-overview/dashboard-tag.png) +![Screenshot: Dashboard tag](../../resources/post-install-verification-images/alerts-overview/dashboard-tag.png) ## Verify that health indicators are displayed @@ -57,7 +56,7 @@ Ensure that the health indicators section is visible at the top of the dashboard - Color: Green or Red based on alert state. **Screenshot:** -![Screenshot: Health indicators at top](../../../resources/post-install-verification-images/alerts-overview/health-indicators-overview.png) +![Screenshot: Health indicators at top](../../resources/post-install-verification-images/alerts-overview/health-indicators-overview.png) ## Verify individual health indicator status @@ -75,7 +74,7 @@ Verify the status and formatting of each health indicator tile, based on alert-d > All health indicators should display either Green or Red status after the initial wait period. If any health indicators aren't displaying correctly after waiting the full 10-15 minutes, verify that all related services are running properly and data collection is functioning correctly. **Example Screenshot:** -![All Health Indicators](../../../resources/post-install-verification-images/alerts-overview/all-health-indicators.png) +![All Health Indicators](../../resources/post-install-verification-images/alerts-overview/all-health-indicators.png) ## Verify dashboard in a time range @@ -95,4 +94,4 @@ Ensure that the dashboard is using a custom 15-minute time range as required for - Health indicators update dynamically based on this range. **Screenshot:** -![Screenshot: Time range 15 minutes](../../../resources/post-install-verification-images/alerts-overview/time-range-15-minutes.png) +![Screenshot: Time range 15 minutes](../../resources/post-install-verification-images/alerts-overview/time-range-15-minutes.png) diff --git a/docs/environment-watch/post-install-verification.md b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification/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/elastic-stack-setup-04-post-install-verification.md index 8dab9d2f..e94c80e8 100644 --- a/docs/environment-watch/post-install-verification.md +++ b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification/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](.//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](.//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](.//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/elasticsearch-cluster-health.md b/elastic-stack-setup/elastic-stack-setup-04-post-install-verification/elasticsearch-cluster-health.md similarity index 76% 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..b9912f03 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 @@ -40,8 +39,8 @@ Confirm cluster health status, total nodes, shards, indices, and document count - Data size is displayed accurately. **Screenshot:** -![Screenshot: Cluster Overview](../../../resources/post-install-verification-images/elasticsearch-cluster-health/cluster-overview.png) -![Screenshot: Cluster Health Summary](../../../resources/post-install-verification-images/elasticsearch-cluster-health/cluster-health-summary.png) +![Screenshot: Cluster Overview](../../resources/post-install-verification-images/elasticsearch-cluster-health/cluster-overview.png) +![Screenshot: Cluster Health Summary](../../resources/post-install-verification-images/elasticsearch-cluster-health/cluster-health-summary.png) ## Verify node metrics @@ -63,7 +62,7 @@ Ensure node-level metrics such as CPU usage, JVM heap usage, and disk space are - Load average may show as N/A if unsupported but should be monitored for future inclusion. **Screenshot:** -![Screenshot: Node Metrics](../../../resources/post-install-verification-images/elasticsearch-cluster-health/node-metrics.png) +![Screenshot: Node Metrics](../../resources/post-install-verification-images/elasticsearch-cluster-health/node-metrics.png) ## Verify index statistics @@ -87,7 +86,7 @@ Validate index-level metrics including document counts, data size, indexing rate - Alerts show clear or no issues on indices. **Screenshot:** -![Screenshot: Index Statistics](../../../resources/post-install-verification-images/elasticsearch-cluster-health/index-stats.png) +![Screenshot: Index Statistics](../../resources/post-install-verification-images/elasticsearch-cluster-health/index-stats.png) ## Verify disk and storage utilization @@ -103,4 +102,4 @@ Ensure disk free space and usage metrics are visible for each node. - No fields marked as N/A for disk metrics. **Screenshot:** -![Screenshot: Disk and Storage Utilization](../../../resources/post-install-verification-images/elasticsearch-cluster-health/disk-storage-utilization.png) +![Screenshot: Disk and Storage Utilization](../../resources/post-install-verification-images/elasticsearch-cluster-health/disk-storage-utilization.png) 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 68% 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..eea10fc9 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 @@ -14,7 +13,7 @@ Ensure the Monitoring Agent dashboard is present. - **Monitoring Agent** is listed. **Screenshot:** -![Screenshot: Dashboard exists](../../../resources/post-install-verification-images/monitoring-agents/dashboard-exists.png) +![Screenshot: Dashboard exists](../../resources/post-install-verification-images/monitoring-agents/dashboard-exists.png) ## Verify Monitoring Agents dashboard tags @@ -32,7 +31,7 @@ Ensure the correct tags are assigned to the dashboard. - **FeatureDomain: Monitoring** **Screenshot:** -![Screenshot: Tags](../../../resources/post-install-verification-images/monitoring-agents/dashboard-tags.png) +![Screenshot: Tags](../../resources/post-install-verification-images/monitoring-agents/dashboard-tags.png) ## Verify dashboard filters populate with data @@ -50,7 +49,7 @@ Ensure filter dropdowns are populated with available data. > Filters may take a few minutes to populate after initial data collection begins. **Screenshot:** -![Screenshot: Filter dropdown populated](../../../resources/post-install-verification-images/monitoring-agents/filter-dropdown-populated.png) +![Screenshot: Filter dropdown populated](../../resources/post-install-verification-images/monitoring-agents/filter-dropdown-populated.png) ## Verify data population by changing filters and time ranges @@ -67,7 +66,7 @@ Ensure the dashboard data is loading correctly. * All panels are populated with data. **Screenshot:** -![Screenshot: Populated data](../../../resources/post-install-verification-images/monitoring-agents/data-populated.png) +![Screenshot: Populated data](../../resources/post-install-verification-images/monitoring-agents/data-populated.png) ## Verify Hosts and Agent versions @@ -86,7 +85,7 @@ Ensure hosts and agent versions are correctly displayed. > Verify that the agent version is consistent across all nodes to ensure uniform monitoring capabilities. **Screenshot:** -![Screenshot: Hosts and versions](../../../resources/post-install-verification-images/monitoring-agents/hosts-agent-versions.png) +![Screenshot: Hosts and versions](../../resources/post-install-verification-images/monitoring-agents/hosts-agent-versions.png) ## Verify data in Discover @@ -102,5 +101,5 @@ Ensure dashboard data is reflected in Discover. - Data is visible in Discover. **Screenshot:** -![Screenshot: Discover view 01](../../../resources/post-install-verification-images/monitoring-agents/explore-discover-view.png) -![Screenshot: Discover view 02](../../../resources/post-install-verification-images/monitoring-agents/discover-view.png) \ No newline at end of file +![Screenshot: Discover view 01](../../resources/post-install-verification-images/monitoring-agents/explore-discover-view.png) +![Screenshot: Discover view 02](../../resources/post-install-verification-images/monitoring-agents/discover-view.png) \ No newline at end of file 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/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/custom-json-troubleshooting.md b/elastic-stack-setup/troubleshooting/custom-json-troubleshooting.md similarity index 100% rename from docs/troubleshooting/custom-json-troubleshooting.md rename to elastic-stack-setup/troubleshooting/custom-json-troubleshooting.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/elastic-stack-setup/troubleshooting/environment_watch_troubleshooting.md b/elastic-stack-setup/troubleshooting/environment_watch_troubleshooting.md new file mode 100644 index 00000000..985f1488 --- /dev/null +++ b/elastic-stack-setup/troubleshooting/environment_watch_troubleshooting.md @@ -0,0 +1,14 @@ +# Environment Watch Troubleshooting Guide + +This document provides quick reference links to detailed troubleshooting guides for all components in the Relativity Server Bundle environment. + +## Component Troubleshooting Guides + +- [Pre-requisite Troubleshooting](./pre-requisite-troubleshooting.md) +- [Elasticsearch Troubleshooting](./elasticsearch.md) +- [Kibana Troubleshooting](./kibana.md) +- [APM Server Troubleshooting](./apm-server.md) +- [Environment Watch Monitoring Agent and Open Telemetry Collector Troubleshooting](./monitoring-agent-and-otel-collector.md) +- [Relativity Server CLI Troubleshooting](./relativity-server-cli.md) +- [Relativity Alerts Troubleshooting](./relativity_alerts_troubleshooting.md) +- [Custom JSON Configuration Troubleshooting](./custom-json-troubleshooting.md) \ No newline at end of file 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