Elasticsearch Server Availability Test

An Elasticsearch cluster is a group of one or more Elasticsearch nodes that are connected together. Each node is a server (either virtual or physical) that stores cluster data and participates in the indexing and searching capabilities of the cluster. This means that the node will participate in a given search query by searching the data that it stores. Therefore, the availability and active participation of the node is important for the fast search performance in the target cluster. If a node fails to connect with the cluster, then such a node cannot service search requests. This in turn adversely impacts the user experience with the cluster. In order to prevent this, administrators should monitor the availability of the node round the clock. This is where the Elasticsearch Server Availability test comes in handy!

This test periodically monitors the target Elasticsearch cluster and reports whether/not the server is connected with the cluster. This way, administrators can promptly detect the connection issues, initiate investigations to find out the reason behind the issues, and fix them even before the users notice and complain.

Target of the test : An Elasticsearch Cluster

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for the target 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, this set to none. This is because, by default, the eG agent will connect to the cluster IP address provided against Host, to collect performance metrics. If the target Elasticsearch cluster is hosted on a cloud, then you need to specify the URL of the cloud instance that hosts the cluster, against this parameter. For example: 64bd966328067fd89e0c9b4c3bb8b042.us-east-1.aws.found.io. When the cloud instance URL is specified, the eG agent will automatically connect to the specified cloud instance to pull performance metrics.
Elastic Search User and Elastic Search Password	By default, the Elastic Search User and Elastic Search Password parameters are set to none. In some high security environments, eG agent will not be able to communicate with the target server and collect metrics without valid credentials and 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, then set this flag to Yes.

Measurements made by the test

Measurement	Description	Measurement Unit	Interpretation
Elasticsearch server connectivity	Indicates whether the server is connected successfully or not.		The numeric values that correspond to the measure values mentioned above are as follows: Measure Value Numeric Value Success 1 Failure 0 Note: This test typically reports the Measure Values listed in the table above to indicate the current connectivity status of the target server. However, the graph of this measure is represented using the numeric equivalents only.