Configuring the Elasticsearch monitor profile
To configure the KM, set the following preferences on the Add Monitoring Configuration dialog.
The following monitor types that are part of Elasticsearch Monitor are also loaded when you configure the KM.
- Elasticsearch System
|Monitoring Solution||Version||Monitor Profile||Monitor Type|
Click to add the Elasticsearch host details.
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:
If the host is present in the AWS environment, you need to add
Note: Square brackets are mandatory for IPv6 address.
|Port Number||Enter the port number of the Elasticsearch service. Default port number is 9200.|
Select the connection protocol.
|Read Timeout (seconds)|
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.
|Maximum Thread Pool Size|
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.
|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. Collector prefers client nodes for connection when failover is initiated.
Default value is three retry attempts.
Select the following options for instances.
|Node instance format|
Select the following values to include in the PATROL event details description. This also changes the node instance ID.
Type the additional Java Virtual Machine arguments for the Java collector. For example, for Java memory settings:
Note: If you have AWS-hosted Elasticsearch, enter
|Username||Enter the username.|
|Password||Enter the password.|
|Client Certificate File Path (.pfx)|
Enter the path (along with the filename and .pfx extension) where the certificate file is located.
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,
|Client Certificate Password||Enter a password for the certificate file.|
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.
|Exclude Index||Enter the Elasticsearch index name that you want to exclude from monitoring. Enter a regular expression to exclude multiple indices. Separate regular expressions by using pipe (|).|
|Enable PSL Debug|
Select the check box to enable the PSL debug.
The debug file is located at
|Java Collector Debug|
Select the check box to enable the Java collector debug.
The debug file is located at $PATROL_HOME/esk/log directory. The file name format is <EnvName>_ESKCollector.log.*
Enter the JAVA home details before you save the configuration.
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
Note: If you have specified a different path in this field, restart the PATROL Agent to apply the changes.
|Enable device mapping|
Clear the check box to disable device mapping. Enabling device mapping consolidates Elasticsearch monitoring at device level.