Agents Administration - Tests
 

Configuration of JbJVMTest

The JbJVMTest monitors the heap usage and thread usage of the Java Virtual Machine on which the JBoss application server runs.

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 name of the server for which the test is to be configured has to be specified.
  • Specify the port at which the JBoss server listens in the PORT text box.
  • 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 JBoss 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 JBoss server is SSL-enabled.

  • The URL parameter appears only if the MEASUREMENT MODE is set to War File. Specify the URL to be accessed to collect metrics pertaining to the JBoss server. By default, this test connects to a managed JBoss server and attempts to obtain the metrics of interest by accessing the local Mbeans of the server. Accordingly, by default, this parameter is set to http://<JBossServerIP>:<JbossServerPort>.

  • - The ENCRYPTPASS parameter appears only if the MEASUREMENT MODE is set to War File. Select Yes if you want to encrypt the password.
  • 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 JBoss server listens in the PORT text box.
  • This test can extract metrics from JBoss using either of the following mechanisms:

    • By deploying the EgJBossAgent.sar and egjboss.war files on the target JBoss server;
    • By contacting the Java runtime (JRE) of JBoss via JMX

    To configure the test to use EgJBossAgent.sarand egjboss.war files, first, set the MEASUREMENT MODE to War File. Then, refer to the Configuring and Monitoring Application Servers document to know how to deploy these files on the target JBoss 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 JMX option is chosen here.

  • 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 JBoss 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 JBoss server is SSL-enabled.

  • The URL parameter appears only if the MEASUREMENT MODE is set to War File. Specify the URL to be accessed to collect metrics pertaining to the JBoss server. By default, this test connects to a managed JBoss server and attempts to obtain the metrics of interest by accessing the local Mbeans of the server. Accordingly, by default, this parameter is set to http://<JBossServerIP>:<JbossServerPort>.

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.