Configuring the Elasticsearch monitor profile

Enter a display name for the monitored cluster. A container is created with the display name.

Enter the hostname or IP address of any node within the Elasticsearch cluster.

For IPv6 address, use the following format:

[<IPv6 address>]

If the host is present in the AWS environment, you need to add -DES_ENV=AWS in the JVM Arguments field.

Note: Square brackets are mandatory for IPv6 address.

Select the connection protocol.

• http
• https

Enter the timeout period for the HTTP connection. If no data is available at the end of this interval, the collector returns an error and proceeds to the next scheduled poll. Default value is 50 seconds.

This value indicates the maximum number of threads the performance collector can spawn for data collection. For large number of indices (more than 1000), this value must be greater than 50.

Default value is 50 threads.

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. Collector prefers client nodes for connection when failover is initiated.

Default value is three retry attempts.

Type the additional Java Virtual Machine arguments for the Java collector. For example, for Java memory settings: -Xms256m -Xmx1024m.

Note: If you have AWS-hosted Elasticsearch, enter -DES_ENV=AWS in the field.

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

Enter the Elasticsearch index name that you want to include for monitoring. Enter a regular expression to include multiple indices. Separate regular expressions by using pipe (|). By default, all indices are included for monitoring.

Select the check box to enable the PSL debug. 

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

Select the 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

The debug file is located at $PATROL_HOME/esk/log directory. The file name format is <EnvName>_ESKCollector.log.*

JAVA Home

By default, PATROL for Elasticsearch uses JAVA Runtime Environment (JRE) that is installed with the PATROL Agent. To use your own JRE that is installed in a different location, specify the path for the JAVA home directory.

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.

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

Clear the check box to disable device mapping. Enabling device mapping consolidates Elasticsearch monitoring at device level.