Skip to main content
Version: 5.3

Module Installation

Prerequisites​

The following files are required for installation:

  • archive log-manager-installer-1.0.0.tar.gz containing the module files logmanagersm, which includes:
    • installation script for OpenSearch
    • installation script for OpenSearch Dashboards

Installation Process​

Extract the archive to a folder of your choice.

OpenSearch​

To install the module component for OpenSearch servers with the data role, navigate to the data folder and run the script using the command:

sudo bash install.sh

Before starting the installation, provide the following parameters:

  • OpenSearch home directory - address of the OpenSearch root directory. Default value: /app/opensearch
  • LogManager license key - special access key for the module. Mandatory and must be provided. Supplied by the vendor. Without it, OpenSearch will not start after module installation. No default value
  • Server IP – IP address of the current server. Default value: IP address taken from the current server's network settings
  • Port – port on which the WebSocket will run. Default value: 8080
  • Certificate path – path to the SSL/TLS certificate in pem format. Default value: OpenSearch home directory + /config/node-cert.pem
  • Key path – path to the private key corresponding to the SSL/TLS certificate. Default value: OpenSearch home directory + /config/node-key.pem
  • Key password – password for the private key. Default value: empty
  • Timeout (seconds) – maximum connection timeout to the server in seconds. Default value: 20
  • Keepalive interval (minute) – interval in minutes between sending empty packets to the server to maintain the SSH connection. Default value: 1
  • Max sessions – maximum number of sessions within a single SSH connection. Default value: 5
  • User role – user role that will act as the plugin administrator. Default value: all_access
  • User name – username under which indexes with plugin settings will be created. Default value: admin
  • User password – user password. Default value: Se@rch88AnyWheRe

Each parameter must be confirmed by pressing y and Enter after input. Pressing n will allow you to re-enter the parameter.

After installation, the license key value and broker list can be changed in the file {root directory OpenSearch}/config/nn2/log_manager_plugin.yml.

During installation, additional confirmation is required. To proceed, press y and then Enter. Upon completion, a success message will appear.

Also, to enable WebSocket functionality, the port must be opened in the server firewall. Instructions on how to do this are displayed before the success message.

OpenSearch Dashboards​

To install the module component for opensearch-dashboards, navigate to the web folder and run the script using the command::

bash install.sh

Before starting the installation, provide the following parameters:

  • Opensearch-dashboards home directory - address of the opensearch-dashboards root directory. Default value:  /app/opensearch-dashboards

Each parameter must be confirmed by pressing y and Enter after input. Pressing n will allow you to re-enter the parameter. Upon completion, a success message will appear.

After installation, create a link to the plugin in the menu. This is done in the following section Smart Monitor: Main menu - Settings - Management - Menu Settings.