Agents Administration - Tests
 

Default Parameters for TomcatCacheTest

This test is used to monitor the usage of the Tomcat server cache.

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

  • The TEST PERIOD list box helps the user to decide how often this test needs to be executed.
  • In the HOSTtext box, the host name of the server for which the test is to be configured has to be specified.
  • Specify the port at which the Tomcat web server listens in the PORT text box.
  • This test can extract metrics from Tomcat using either of the following mechanisms:

    • By deploying the egtomcat.war file in the <EG_INSTALL_DIR>\lib directory of the eG agent host on the Tomcat server;
    • By contacting the Java runtime (JRE) of Tomcat via JMX

    To configure the test to use egtomcat.war file, first, set the MEASUREMENT MODE to War File. Then, refer to the Configuring and Monitoring Application Servers document to know how to deploy the WAR file on the target Tomcat server.

    On the other hand, if you want the test to use JMX instead, then first, select the JMX option. Then, follow the procedure detailed in the Configuring and Monitoring Application Servers document to configure the test to use JMX. By default, the MEASUREMENT MODE is set to JMX.

  • The JNDINAME parameter appears only if the MEASUREMENT MODE is set to JMX. The JNDINAME is a lookup name for connecting to the JMX connector. By default, this is jmxrmi. If you have resgistered the JMX connector in the RMI registery using a different lookup name, then you can change this default value to reflect the same.

  • The JMX REMOTE PORT parameter appers only if the MEASUREMENT MODE is set to JMX. Here, specify the port at which the JMX listens for requests from remote hosts. Ensure that you specify the same port that you configured in the catalina.sh (or catalina.bat file) file in the <CATALINA_HOME_DIR>/bin folder of the target Tomcat server (refer to the Configuring and Monitoring Application Servers document for more details).

  • The JMX USER, JMX PASSWORD, and CONFIRM PASSWORD parameters appear only if the MEASUREMENT MODE is set to JMX. If JMX requires authentication only (but no security), then ensure that the JMX USER has the credentials of a user with read-write access to JMX. To know how to create this user, refer to the Configuring and Monitoring Application Servers document.

  • Enter the password of the specified JMX USER in the JMX PASSWORD text box.

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

  • The SSL parameter appears only if the MEASUREMENT MODE is set to War File. Indicate YES if the Tomcat server is SSL-enabled.

  • The URL parameter appears only if the MEASUREMENT MODE is set to War File. Specify the URL of the managed Tomcat server to enable the test to connect to it and extract measures from it. The URL specification should be of the format: http://{TomcatIP}:{TomcatPort}.

  • The USERNAME, PASSWORD, and CONFIRM PASSWORD parameters appear only if the MEASUREMENT MODE is set to War File. In the USERNAME text box, specify a name of a user who has been assigned the Manager role on the Tomcat server to be monitored; these users are typically allowed to control web applications deployed on the Tomcat server. Specify the PASSWORD of this user, and confirm the password by retyping it in the CONFIRM PASSWORD text box.

  • Enter the password of the specified USERNAME in the PASSWORD text box.
  • Confirm the password by retyping it in the CONFIRM PASSWORD text box.
  • The ENCRYPTPASS parameter appears only if the MEASUREMENT MODE is set to War File. Select Yes if you want to encrypt the password.

  • Once the necessary values have been provided, clicking on the UPDATE button will 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.