Configuration of ESSearchTest

This test auto-discovers the indices in the Elasticsearch cluster, and reports the time taken to process the search requests, using which administrators can initiate remedial measure if the slowness is detected. This test also reports the number of evictions performed in the query cache and the field data cache and the size of the query cache and field data cache. Using these revelations, admininistrators can detect the inconsistencies in the sizing of the cache in each index.

The default parameters associated with this test are as follows:

• The TEST PERIOD list box helps the user to decide how often this test needs to be executed.

• In the HOST text box, the host for which the test is to be configured has to be specified.

• In the PORT text box, enter the port number at which the target host being monitored listens. By default, this is set to 9200.

• By default, the CLOUD INSTANCE URL is set to none. If the target Elasticsearch cluster is hosted on the cloud environment, then you need to specify the URL of the cluster on cloud against this parameter. For example: 64bd966328067fd89e0c9b4c3bb8b042.us-east-1.aws.found.io. When the cloud URL is specified, the eG agent will use the cloud URL to monitor the target cluster rather than using the host specified in the HOST text box.

• By default, the ELASTIC SEARCH USER and ELASTIC SEARCH PASSWORD parameters are set to none indicating that the eG agent doesn't require authentication to collect metrics from the Elasticsearch cluster. If authentication is required to access the target Elasticsearch cluster, then specify the valid credentials against these parameters.

• Confirm the ELASTIC SEARCH PASSWORD by retyping it in the CONFIRM PASSWORD text box.

• By default, the SSL flag is set to No. If the Elasticsearch cluster is SSL-enabled by default or hosted on the cluster, then set this flag to Yes. This indicates that the eG agent will communicate with the target cluster via HTTPS by default.

• If multiple components of the same component type are awaiting configuration, then an APPLY TO OTHER COMPONENTS check box will appear in this page. Clicking on this check box will allow you to apply the configuration to all/selected components of that type.

• Once the necessary values have been provided, clicking on the UPDATE button will register the changes made.

When changing the configuration for specific servers, a “*” beside the text box corresponding to the parameter signifies that these values have to be manually configured by the user. The parameter values that require to be configured will typically be prefixed with a “$” or contain a series of “*”. A value of “none” in the parameter value indicates that the corresponding parameter value can be changed if required.