Configuring in the PATROL console

When a Knowledge Module (KM) is loaded, its associated menu commands are added to the KM area of a menu. The KM area is below the horizontal line on the menu. Menu commands above the line belong to the PATROL Console. The KM commands for the following application classes are added to the menus below the horizontal line.

After you install PATROL for Elasticsearch, you must load the Knowledge Module (KM) into the PATROL consoles and then configure the product.

Related topic

Installing

Configuring after installation

PATROL for Elasticsearch menu commands

In PATROL console, menu commands (KM commands) are options to configure the knowledge module and discover Elasticsearch components. Right-click an object to access its menu commands. The following table describes the menus used in PATROL for Elasticsearch.

Configure Elasticsearch Monitoring
Configuring Elasticsearch KM (Add Host dialog box)
Configuring JAVA Runtime Environment (JRE Configuration dialog box)

The following menu commands are available in the Elasticsearch (ESK_TOP) application class. To access this menu, right-click the Elasticsearch node and select KM Commands.

Menu command	Action
Configure Elasticsearch Monitoring	Enables you to add or remove an Elasticsearch host from monitoring.
Configure JAVA Home	Enables you to set the Java home directory for your own Java Runtime Environment (JRE) if you are not using the JRE that is installed with the PATROL Agent.

Configure Elasticsearch Monitoring

Use this dialog box to add, modify, and delete an Elasticsearch host from your environment. To access this dialog box, right-click the Elasticsearch node > KM Commands > Configure Elasticsearch Monitoring. This dialog box contains the following items:

Item	Description
Host List	Displays the name of the Elasticsearch host that is being modified or deleted.
Add Host	Displays the Add Host dialog box for adding a new Elasticsearch host.
Modify Host	Displays the Modify Host <hostname> dialog box to modify an existing Elasticsearch host.
Delete Host	Enables you to delete an Elasticsearch host.
Show Details	Displays the host name, port, read timeout, maximum number of thread pools, failover retry attempts, and connection protocol details of the selected host.
OK	Click to apply the changes.
Close	Click to close the dialog box.

Configuring Elasticsearch KM (Add Host dialog box)

Use this dialog box to add an Elasticsearch host to your environment. To access this dialog box, right-click the Elasticsearch node > KM Commands > Configure Elasticsearch Monitoring > Add Host. This dialog box contains the following items:

Item	Description
Label	Enter a display name for the monitored host. A container will be created with the display name.
Hostname	Enter the hostname or IP address of any node within the Elasticsearch cluster. For IPv6 address, use the following format: [<IPv6 address>] Note: Square brackets are mandatory for IPv6 address.
Port Number	Enter the port number of the Elasticsearch service. Default port number is 9200.
Read Timeout (seconds)	Enter the timeout period for the HTTP connection. If no data is available at the end of this interval the collector will return an error and proceed with the next scheduled poll. Default value is 50 seconds.
Maximum Thread Pool Size	This value indicates the maximum number of threads the performance collector can spawn for data collection. Enter the thread pool size of the JAVA collector. In case of large number of indices (more than 1000), this value must be greater than 50. Default value is 50 threads.
Failover Retry Attempts	Enter the failover retry attempts. This value indicates the number of retries after which collector will activate failover. If a connection node in elasticsearch cluster is down (service is not running) the collector will try to select other nodes from cluster after these attempts are exhausted. Default value is three retry attempts.
Connection Protocol	Select the connection protocol. http https
Authentication Details
Native/File
Username	Enter the username.
Password	Enter the password.
PKI
*Client Certificate File Path (.pfx)**	Enter the path (along with the filename and .pfx extension) where the certificate file is located. Note: The client certificate file must reside on the host where the PATROL Agent is running. BMC PATROL default account must have read permission on the directory where the client certificate file is located. The path should be an absolute path to the location where the certificate resides on the PATROL Agent. For example, `/home/patrol/membernode.pfx`
Client Certificate Password	Enter a password for the certificate file.
Add	Click to save the configuration and add the host for monitoring.
Cancel	Click to exit without saving any changes.

Configuring JAVA Runtime Environment (JRE Configuration dialog box)

By default, Elasticsearch KM uses Java Runtime Environment (JRE) that is installed with the PATROL Agent. However, you can configure the KM to use your own JRE. Use this dialog box to specify a different Java home directory.

This dialog box contains the following item:

Item

Description

Specify JRE Version 1.8 or later

Enter the complete path for the Java home directory if you are not using the JRE that is installed with the PATROL Agent.

For example, if your Java executable exists in the /usr/java/jdk1.8.0_45/jre/bin/java path, specify /usr/java/jdk1.8.0_45/jre as the value in this field.

Apply

Click to save the changes

Done

Click to close the dialog box

Note

If you have specified a different path in this field, restart the PATROL Agent to apply the changes.

The following menu commands are available in the Elasticsearch System (ESK_CONT) application class. To access this menu, right-click the container node and select KM Commands.

Menu command Action

Manage Debug

Enable PSL Debug

Select this check box to enable the PSL debug. The debug statements are printed to System Output Windows (SOW) or in the issow.log file.

The debug file is located at $PATROL_HOME/log/trace/<hostname>/<port>/issow.log

Java Collector Debug

Select this check box to enable the Java collector debug.

WARNING - Failures that can affect monitoring
INFO - Failures and exceptions in the collection
ALL - WARNING, INFO and JSON responses of all REST queries

Default log level: WARNING

OK Click to save the changes.

Cancel Click to close the dialog box.

The following menu commands are available in the Cluster (ESK_CLUSTER) application class. To access this menu, right-click the cluster and select KM Commands.

Menu command	Action
Sync Inventory	Destroys the stale or inactive instances and displays the updated inventory.

The following menu commands are available in the Indices (ESK_INDEX_CONT) application class. To access this menu, right-click the Indices node and select KM Commands.

Menu command

Action

Manage Index Filters

Enables you to include or exclude indices from monitoring.

Include Index

Enter the Elasticsearch index name that you want to include for monitoring. Enter a regular expression to include multiple indices. Multiple regular expressions can be given by using pipe as a separator. By default, all the indices are included for monitoring.

Exclude Index

Enter the Elasticsearch index name that you want to exclude from monitoring. Enter a regular expression to exclude multiple indices. Multiple regular expressions can be given by using pipe as a separator.

OK

Click to save the configuration.

Cancel

Click to close the dialog box.

List RED Indices

Displays a list of indices with Red status.

Red status indicates that at least one primary shard (and all of its replicas) is missing.

This means that you are missing data. Searches will return partial results, and indexing into that shard will return an exception.

Page tree

PATROL for Elasticsearch menu commands

Elasticsearch (ESK_TOP) menu

Configure Elasticsearch Monitoring

Configuring Elasticsearch KM (Add Host dialog box)

Configuring JAVA Runtime Environment (JRE Configuration dialog box)

Elasticsearch System (ESK_CONT) menu

Cluster (ESK_CLUSTER) menu

Indices (ESK_INDEX_CONT) menu