Agents Administration - Tests
 

Configuration of JvmMemoryLeakTest

This test continuously monitors the JVM heap usage and promptly alerts administrators when memory usage crosses a configured limit.

Note:

This test will work only if the following pre-requisites are fulfilled:

  • The test should be executed in an agent-based manner only.

  • The target Java application should use the JDK/JRE offered by one of the following vendors only: Oracle, Sun, OpenJDK. IBM JDK/JRE is not supported.

  • The monitored Java application should use JDK/JRE 1.6 or higher.

  • For this test to run and report metrics, the eG agent install user should be the same as the Java application (or) Java web/application server install user.

  • By default , this test programmatically dumps a heap dump (.hprof files) in the folder  <EG_AGENT_INSTALL_DIR>\agent\logs folder. To enable the eG agent to read/analyse such files, you need to add the eG agent install user to the Java application (or) Java web/application server install user group. If this is not done, then the dump files will be created, but will not be processed by the eG agent, thus ending up unnecessarily occupying disk space (note that .hprof files are normally 1-5 GB in size).

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. By default, this is set to 1 hour.

  • In the HOST text box, the host name of the server for which the test is to be configured has to be specified.

  • The port number at which the specified HOST listens should be specified in the PORT listbox.

  • This test counts all those classes that are consuming memory beyond the limit (in percentage) specified against PCT HEAP LIMIT as ‘memory leak suspects’. This count is reported as the value of the Leak suspect classes measure. By default, 30 (%) is the PCT HEAP LIMIT. This implies that the test, by default, reports each class that consumes over 30% of the Allocated heap memory as a Leak suspect class. Such classes are listed as part of detailed diagnostics.

  • For the eG agent to collect metrics from the target IBM WebSphere Liberty server, the local connector should be enabled on the target server. Once the connector is enabled, a com.ibm.ws.jmx.local.address file will be created in the ${server.output.dir}/logs/state folder. The eG agent uses this file to connect to the target server and collect the required metrics from it. Therefore, specify the exact path to this file in the SERVICE URL PATH text box. For example, in case of Windows environments, the Service URL Path can be C:\wlp\usr\servers\server1\logs\state and in case of Linux environments, the SERVICE URL PATH can be /opt/wlp/ur/servers/server1/logs/state.

  • Specify the duration (in seconds) for which this test should wait for a response from the target Java application. If there is no response from the target beyond the configured duration, the test will timeout. By default, the TIMEOUT parameter is set to 240 seconds.

  • The DD FREQUENCY refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against this parameter.

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

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

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