How to Install Analytics Applications

How to Install Elasticsearch for Analytics

Note: Do not confuse this Elasticsearch instance with your Elasticsearch search index (backend), if you are using an Elasticsearch search index.

Tip: The Elasticsearch instance described in this topic is required by the SmartHub application and can be either the same or a separate instance of Elasticsearch.

This is the search engine where all the recorded user activity is stored.

• Documentation: To see the Elastic documentation, go to Elasticsearch Documentation.

To run the installation operation:

1. Go to Elasticsearch Downloads page and download the .msi package of Elasticsearch.
   
2. Follow the steps from the installation Elasticsearch page to install Elasticsearch as a Windows service.
   
3. Set the following properties in the YML file \config\elasticsearch.yml:
   1. network.host: 0.0.0.0
      Set the value to one of the following:
      • An IP address attached to an individual network device such as NIC.
      • This IP address must resolve to your elastic server (or a DNS which does).
      • Once set, you can only access Elastic through this network interface device. 
      • 127.0.0.1 to make elastic accessible from this server only by using "localhost"
      • 0.0.0.0 to make elastic accessible from any address/IP.
   2. http.port: 9200: Leave this set at the default value of 9200
   3. discovery.type: single-node: Set this property if you are using a single server for your elastic instance.  
      
      
      
4. Go to Windows services and start the Elastic service, which is running as a Local System service.
   

5. Verify the Elastic node status by going to http://localhost:9200.
   

   Note: You must have an instance of Elasticsearch up and running.

   Make sure that JSON is loaded.
   See the following graphic as an example only.
   
   

   Note: Keep the Elastic window open while you install Kibana.

   Elasticsearch 7.10 has a security vulnerability due to the log4j v2.11.1 dependency. You can read more about the vulnerability here. You can mitigate this risk by following the steps described here.

How to Install Kibana for Analytics

How to Install Kibana as a Windows Service

• Kibana v7.10-8.x is the data visualization engine for Elasticsearch.
• SmartHub Analytics uses reports that are built on top of Elastic Kibana.

Use the Elastic prerequisites to install Elastic Kibana either on the same server where the SmartHub Analytics reporting site is installed, or a different server. For more information, see the  Kibana page.

To install Kibana as a Windows service, follow these steps:

1. Download and unzip Kibana

2. Go to NSSM Download page, download and unzip the file.

3. Use the command prompt with administrator permissions to navigate to the folder which contains nssm.exe:
   cd path_to_nssm/nssm-2.24/win64
     or 
   path_to_nssm/nssm-2.24/win32

4. Run the install Kibana command for your version of Kibana (v7.10.2 is used below):
   nssm install kibana-7.10.2

   In the "NSSM service installer" window:

   1. Application tab: Set kibana.bat as Application Path

   2. Details tab: Enter display name, description, startup type

   3. Dependencies tab: Enter Elasticsearch service name.
      • This name is found under the Windows Elastic service properties. For example, elastic-service-x64.
   4. Click the Install Service.
5. You receive a service "installed successfully!" message.
6. Update the port, host information, and the Elastic node URL in the kibana.yml file found at <path_to_kibana>\config\kibana.yml. For more information see Configuring Kibana.
   1. server.port: 5601
   2. server.host: "localhost" or "0.0.0.0"
   3. elasticsearch.hosts:  Set the URL of your Elasticsearch instance between square brackets. For example, [http://localhost:9200"]
   4. kibana.index: ".kibana"

      Note: If your SmartHub is configured to use HTTPS, Kibana must also be set to use HTTPS.

      To do this, follow the steps in How to Set Kibana to HTTPS.

7. Go to the Windows services application and start the Kibana service.

   The starting process for the Kibana service does not finish immediately. As a result, the startup may take a minute to complete and you should wait before testing.

8. Verify Kibana by going to http://localhost:5601/
   1. If you already have Elasticsearch and Elastic Kibana running, or if you have installed either of these applications, you can continue to use these Elasticsearch applications.
      This is possible because SmartHub Analytics creates a new Elasticsearch index.

How to Set Kibana to HTTPS

To encrypt traffic between the browser and Kibana, follow these steps:

1. Obtain a server certificate and private key for Kibana:

   Note: If you already have an SSL certificate and its private key, skip this step.

   Generate a certificate and private key using the elasticsearch-certutil tool:

   1. Open a command prompt as administrator.
   2. Navigate to the bin folder of Elasticsearch.
   3. Run the following command:
      elasticsearch-certutil cert --name <name_of_certificate> --pem
   4. When asked "Please enter the desired output file [certificate-bundle.zip]" provide a name for your certificate .zip file, for example: kibanaCertificate.zip
   5. Extract the files from the newly created .zip file.
   6. Copy the <name_of_certificate> folder to your Kibana config folder.
2. Update the SSL enable setting, server certificate, private key and host information in the kibana.yml file found at <path_to_kibana>\config\kibana.yml:
   1. server.ssl.enabled: true
   2. server.ssl.certificate: "/path/to/kibana-server.crt" 
   3. server.ssl.key: "/path/to/kibana-server.key"
   4. server.host: (optional) enter a host name that matches the host name (host names) associated with the SSL certificate.
      NOTE: When configuring windows paths in Kibana's configuration file, you must use a double-backslash.
      Example: server.ssl.certificate: C:\\Elastic\\Certificates\\server.crt
3. Restart the Kibana service.
4. Access SmartHub Administration page at https://<hostname>:<port>/_admin.
5. Go to the Additional Settings Configuration page and replace the Kibana Server Address with the new address shown in the screenshot below:
   
   • For more information see Encrypting communications in Kibana.