Agents Administration - Tests
 

Default Parameters for ESClusterTest

This test continuously monitors the cluster, and the health of the cluster at regular intervals. In addition, this test also reports the count of active shards and the number of shards in the unassigned/initializing/relocating state. These revelations help administrators to track the balance of the cluster continously.

This page depicts the default parameters that need to be configured for the ESClusterTest test.

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

  • 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.

  • Once the above values are provided, click on the UPDATE button to register the changes made.

When changing default configurations of tests, the values with “$” indicate variables that will be replaced by the eG system according to the specific server being managed - for instance, $hostName is the host/nickname of the target host, $port is the port number of the server being monitored. E.g., for a server xyz:80, $hostName will be changed automatically by the eG manager to “xyz*” and $port will be changed to “80” when configuring a test.