Agents Administration - Tests
 

Configuration of ESIndexingTest

This test auto-discovers the indexes in the Elasticsearch cluster, and reports the current health and size of each index. In addition, this test also reveals the count of refresh/merge/flush operations performed in each index and the time taken for performing those operations. With the help of these metrics, administrators can figure out how quickly the refresh/merge/flush operations were performed, detect the slowness in time and proactively prevent the bottleneck. Besides, this test sheds light on the number of documents added to/deleted from each index using which the administrators can find out the growing/declining size of each index. In the process, the details on the shards in each index are also reported.

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.

  • To make diagnosis more efficient and accurate, the eG Enterprise suite embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option.The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

    • The eG manager license should allow the detailed diagnosis capability

    • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.

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