Elasticsearch Search Performance Test

This test auto-discovers the indexes in the Elasticsearch server, and for each index, reports the average time taken to process the search queries and the rate at which queries are processed. This way, administrators can easily identify the index that is currently experiencing processing bottlenecks. Additionally, the test also measures the number of evictions performed in the query cache and the field data cache and the size of these caches. These metrics alert administrators to inconsistencies in the sizing of the caches in each index.

Target of the test : An Elasticsearch Cluster

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for each index in the Elasticsearch cluster being monitored.

Configurable parameters for the test
Parameter	Description
Test Period	How often should the test be executed.
Host	The IP address of the host for which this test is to be configured.
Port	The port number at which the target host being monitored listens. By default, this is set to 9200.
Cloud Instance URL	By default, the 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.
Elastic Search User and Elastic Search Password	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 Password	Confirm the Elastic Search Password by retyping it in the Confirm Password text box.
SSL	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.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Average query latency	Indicates the average time taken for processing the search requests in this index.	Milliseconds	This value is calculated using the following formula: Query latency=Total time taken for processing all queries/Total number of queries received The value of this measure is desired to be low. A high value indicates that the index is taking too long to process the queries. If this condition is allowed to persist, then it may degrade user experience with the Elasticsearch cluster.
Query rate	Indicates the rate at which the search queries were processed in this index.	Queries/sec	This measure helps administrator to know how well/badly the search requests were processed in each index. A very high value for this measure indicates that the index is imposed with many search requests.
Query cache evictions	Indicates the number of cache evictions performed while processing the search queries in this index.	Number	The query cache is responsible for caching the results of queries. When the cache is full, the less-frequently used data is evicted to make way for new data. A high value of this measure could indicate that the index is sized with inadequate query cache. You may want to increase the size of the query cache, to reduce evictions and improve overall search performance.
Query cache size	Indicates the current size of the query cache of this index.	MB
Fielddata cache evictions	Indicates the number of evictions performed in the field data cache while processing the search queries in this index.	Number	The field data cache is used mainly when sorting on or computing aggregations on a field, and loads all the field values to memory in order to provide fast document based access to computed values. Compare the value of this measure across the indexes to identify the index in which the maximum number of evictions were performed in the field data cache.
Fielddata cache size	Indicates the current size of the filed data cache of this index.	MB