Installation Guide

Contents Objective ....................................................................................................................................................... 2

Pre-installation .............................................................................................................................................. 2

What is Kibana? ........................................................................................................................................ 2

What is Elasticsearch?............................................................................................................................... 2

Pulse with Kibana ...................................................................................................................................... 2

Installation plan ........................................................................................................................................ 3

Prerequisites ............................................................................................................................................. 3

Downloads ................................................................................................................................................ 3

Installation steps ........................................................................................................................................... 4

Elasticsearch Installation ........................................................................................................................... 4

Kibana installation ..................................................................................................................................... 7

Configuration ................................................................................................................................................ 9

Configure Elasticsearch ............................................................................................................................. 9

Configure Pulse to send data to Elasticsearch .......................................................................................... 9

Configure Kibana ..................................................................................................................................... 11

Optional settings ......................................................................................................................................... 15

Import Pulse Kibana objects ................................................................................................................... 15

Create Kibana as a Windows service ...................................................................................................... 18

Make Kibana available outside the server .............................................................................................. 20

Kibana Security with x-pack .................................................................................................................... 21

Kibana Security with custom ................................................................................................................... 21

Objective This document explains the steps to set up Pulse to work with Kibana 6.1. This guide describes the installation steps on a Window environment. Elasticsearchand Kibana can be installed on Linux as well. Default URL:

• Pulse: http://localhost:8099/

• Elastic: http://localhost:9200/

• Kibana: http://localhost:5601/app/kibana

Pre-installation What is Kibana?

Kibana lets you visualize your Elasticsearch data and navigate the Elasticsearch data.

What is Elasticsearch? Elasticsearch is a distributed, JSON-based search and analytics engine designed for horizontal scalability, maximum reliability, and easy management.

Pulse with Kibana With Pulse 5.7, Pulse can now send data to an Elasticsearch database. When you turn the Elasticsearch feature on, Pulse will send the same data to its database and to Elasticsearch. The data that you see in the Pulse Web client is from the Pulse database and the one in Kibana is from Elastic. It is the same data in two different formats:

Installation plan 1. Elasticsearch installation

2. Kibana installation

3. Configure Pulse to send data to Elasticsearch

4. Configure Kibana (Add Pulse indexes)

Prerequisites • Windows or Linux server

• Minimum 10 GB of space

• Java 8

• Oracle JDK version 1.8.0_131 as minimum

• One port number available for Elasticsearch(9200 by default)

• One port number available for Kibana (5601 by default)

Downloads • Elastic: https://www.elastic.co/downloads/elasticsearch

• Kibana: https://www.elastic.co/downloads/kibana

• NSSM: https://nssm.cc/download

Installation steps The screenshots have been taken with Elasticsearch and Kibana v6.1

Elasticsearch Installation The official Elasticsearch installation guide can be found here:

• https://www.elastic.co/guide/en/elasticsearch/reference/current/_installation.html#_installatio

n

1. Download Elasticsearch Windows MSI file:

https://www.elastic.co/downloads/elasticsearch

2. Run the elasticsearch-6.1.0.msi

3. Click Next

4. Next

5. Click Next

6. Uncheck all plugins

7. Elasticsearch is installing

8. Click Exit

9. Check if Elasticsearch is installed properly go to http://localhost:9200/

A new windows service has been created:

Kibana installation The official Kibana getting started guide can be found here: https://www.elastic.co/guide/en/kibana/current/getting-started.html

1. Download Kibana sha file

https://www.elastic.co/downloads/kibana

2. Unzip and copy the folder where you want to install Kibana, for example c:\kibana

3. Open config/kibana.yml in an editor

4. Set elasticsearch.url to point at your Elasticsearch instance

5. Run as administrator C:\kibana\bin\Kibana.bat

A command line will open, you will have to wait a few minutes the first time you start Kibana:

6. To check if Kibana is working go to http://localhost:5601

Configuration

Configure Elasticsearch There is no specific configuration on the Elasticsearch side, just some important Elasticsearch folders to be aware of:

• Data directory: C:\ProgramData\Elastic\Elasticsearch\data

• Config directory: C:\ProgramData\Elastic\Elasticsearch\config

• Logs directory: C:\ProgramData\Elastic\Elasticsearch\logs

Configure Pulse to send data to Elasticsearch The Pulse for TM1 service is the service which sends data to Elasticsearch

1. Stop Pulse services

2. Go to Pulse.cfg, update the config

[ElasticSearch] Nodes = http://localhost:9200 IncludeTM1Top = True IncludeMessageLogs = True

3. Start Pulse services

Pulse is going to start populating the Elasticsearch database. The default location is C:\ProgramData\Elastic\Elasticsearch\data If you go back to Kibana, you will see now that 4 indices are available:

Pulse has 8 indices:

• pulse-disk-*: information about the server disk (servername, diskspace…)

• pulse-instance-*: information about all TM1 instances (CPU, memory…)

• pulse-server-*: information about the TM1 server (CPU, memory…)

• pulse-top-*: information about TM1 top

• pulse-process-*: information about TM1 processes (Start time, Runtime…)

• pulse-chore-*: information about TM1 chores (Start time, End time ….)

• pulse-message-log-*: information about message log (Error messages…)

• pulse-session-*: information about the sessions.

The index will be created only when Pulse finds some data related to it. To create the 4 other missing indices (pulse-process, pulse-chore, pulse-message-log and pulse-session), you will need to login to a TM1 instance and run a chore. After a few minutes, if you refresh Kibana you should be able to see the 8 indices:

Configure Kibana Once all indices are available, you will have now to create them manually.

1. Go to Management and click Index Patterns:

2. Kibana will tell you how many indices it has found, you should have 8 indices:

If you have less indices, just login to Architect and run a TM1 chore to make sure that the chore and process indices will be created and just wait 2 minutes if you can’t see the pulse-session index. 3. To create an index, just type the name pulse-disk- and then click Next Step:

4. The next step is to select a Time Filter field name. One index contains fields and you need to

choose one of these fields to be the Time filter. For pulse-disk- we chose CaptureTime and then

click Create index pattern:

5. Click the create index pattern button, the pulse-disk index has been created

6. To create a new index, just click the “Create Index Pattern button”:

Now you need to create the following 7 indices:

Index name Time Filter field

pulse-server-* CaptureTime

pulse-instance-* CaptureTime

pulse-top-* CaptureTime

pulse-process-* StartTime

pulse-chore-* StartTime

pulse-message-log-* Time

pulse-session-* LogInTime

If Kibana can’t find an index, it will show this message:

Just run a chore for Pulse to create the chore and process index. Once all indices have been created, you should be able to see the 8 indices in the Index Patterns list:

You are ready to use Kibana, you can now click on the Discover button to deep dive into the Elasticsearch data:

Optional settings Import Pulse Kibana objects

To help you to start exploring the Pulse data in Elasticsearch, we provide some Kibana dashboards that we have pre-built, you can follow these steps to upload these objects into Kibana:

1. Download Pulse Kibana Objects.

2. Unzip the Pulse-Kibana-Objects-6-1.zip and you will find the pulse-kibana-objects.json.

3. Click Management > Saved Objects and then Import button

4. Select the pulse-kibana-objects.json file

5. Click Yes,Overwrite all

6. If you get this message, it means that Kibana can’t find the index that the objects are using, it

suggests by default your first index pulse-top-*:

7. In this case, you need to select the following indices

8. Click Confirm all changes and if you got back to saved objects you should be able to see the new

Kibana objects:

Create Kibana as a Windows service

1. Download NSSM

2. Open command line as Administrator

3. Go to the folder location 62 or 32 bits depending on your operating system, in this example we

are using a 64 bit version:

4. Type nssm install Elasticsearch-Kibana

5. Go to the kibana.bat file

6. Service installed

Now you should be able to see the new Windows service:

7. Start service type nssm start Elasticsearch-Kibana

8. Go to http://localhost:5601/app/kibana to check if it started properly

Make Kibana available outside the server

By default, Kibana will only work with localhost in the URL. To be able to access Kibana with the server name or IP Address you need to update the server.host setting in the Kibana\config\kibana.yml

To apply this setting, you have to restart the Elasticsearch – Kibana service.

Kibana Security with x-pack Elasticsearch has a security module which will enable to set up security access to Kibana. This module is called X-Pack and it is not a free module. More information about X-Pack in the link below:

• https://www.elastic.co/en/products/x-pack

Subscribe to X-pack: https://www.elastic.co/subscriptions

Kibana Security with custom Another way to setup security on top of Kibana is to use a server proxy: https://discuss.elastic.co/t/kibana-5-behind-reverse-proxy/75573?source_topic_id=89927