User Guide
|
 |
 |
|
|
 |
 |
The JRockit Management Console can be used to monitor and control running instances of BEA JRockit JVM. It provides real-time information about the running application's characteristics, which can be used both during development—for example, to find where in an application's life cycle it consumes more memory—and in a deployed environment—for example, to monitor the system health of a running application server.
This section includes information on the following subjects:
The extra cost of running the JRockit Management Console against a running BEA JRockit JVM is very small and can almost be disregarded. This provides for a very low cost monitoring and profiling of your application.
Note: It is not recommended that you run the Management Console on the same machine as the VM you are monitoring. If you run the Console on the same machine as the BEA JRockit you are monitoring, the Management Console GUI will steal valuable resources from the application running on the JVM and you risk performance degradation as a result.
Starting the Management Console is a two-step process:
Additionally, you might want to also complete these tasks as part of the start-up process:
Before the Management Console can connect to BEA JRockit JVM, the management server in the VM needs to be started. The server is disabled by default. To enable the management server, start BEA JRockit JVM with the -Xmanagement option:
-Xmanagement
You can use the class= and classpath= parameters with -Xmanagement to specify a management class and its classpath; for example:
-Xmanagement:class=<classname>,classpath=<path>
This option loads the class and causes its empty constructor to be called early in JVM startup. From the constructor, a new thread is then started, from which your management client is run. You should ensure that the constructor returns control quickly because this call is made early in BEA JRockit startup.
Start the JRockit Management Console from the command prompt by typing:
console
Note: Before starting the Management Console, you must specify the JRE path and the classpath to the .jar file.
You can also start the Management Console without using the launcher. At the command line, enter:
java -jar<jrockit-install-directory>/console/ManagementConsole.jar
If you try to start the management server (-Xmanagement option) with a security manager running (-Djava.security.manager option) the management server might not start and you will get error messages such as the following:
"ERROR: failed to initialize class com.jrockit.management.rmp.
RmpSocketListener."
To allow the management server to run under a security manager, add the text shown in Listing 4-1 to your policy file. The standard location of the policy file is:
For more information on policy files please refer to:
http://java.sun.com/products/jdk/1.2/docs/guide/security/PolicyFiles.html
Listing 4-1 Code for Starting the Management Server with a Security Manager
/* --- Permissions for the JRockit management Server --- */
/* TODO 1: Locate the installed managementserver.jar in JAVA_HOME/jre/lib */
grant codeBase "file:C:/MY_JAVA_HOME/jre/lib/managementserver.jar" {
/* TODO 2: Add permissions for your console client to connect. */
permission java.net.SocketPermission "my-console-client.com", "accept,
resolve";
/* TODO 3: Add permissions for the management server to listen for
connections. */
permission java.net.SocketPermission "localhost:7090", "listen,
resolve";
/* Add permissions for management server standard operations. */
permission com.bea.jvm.ManagementPermission "createInstance";
permission java.lang.RuntimePermission "modifyThreadGroup";
permission java.lang.RuntimePermission "modifyThread";
permission java.lang.RuntimePermission "shutdownHooks";
permission java.util.PropertyPermission "*", "read, write";
};
When BEA JRockit JVM is started with the -Xmanagement option set—and provided the VM is not running in "quiet" mode—it should print out a short message following the command line indicating that the management server is running and which port it is using. You can optionally choose which port to use by setting, as a command line argument, the port number in the port property:
java -Djrockit.managementserver.port=<portnumber>
The default port the management server uses to connect is 7090. It is strongly recommended that you block this port in your firewall, otherwise unauthorized users might access the management server.
You can change the number of connections allowed to the server by setting the maxconnect property:
-Djrockit.managementserver.maxconnect=<maximum number of connections>
The default limit is four concurrent connections. While this should be enough for most users, you can change it, if necessary. The connection limit protects against Denial of Service (DoS) attacks by intruders.
When the JRockit Management Console window appears, the console has started, as shown in Figure 4-1:
Figure 4-1 BEA JRockit JVM Management Console
The JRockit Management Console window is divided into two panes: a connection browser tree in the left pane (Figure 4-2) and a tabbed interface in the right pane (Figure 4-3).
Figure 4-3 Information Tabs (Administrator Mode)
The first tab shows an Overview of information for the selected BEA JRockit JVM connection(s) (as highlighted in the connection browser pane). The other tabs contain detailed information about different areas of the VM, as will be described in Information Tabs.
Figure 4-3 shows the information tabs available in the console's Administrator operation mode. When the console is in the Developer mode, additional tabs appear, as shown in Figure 4-4. These two operation modes are described in Setting the Operation Mode.
Figure 4-4 Information Tabs (Developer Mode)
The console includes a toolbar that contains command buttons for some of the menu options (Figure 4-5). To toggle the Toolbar on or off, on the View menu select Tool Bar.
Figure 4-5 Management Console Toolbar
The status bar (Figure 4-6) at the bottom of the window displays informational messages and tool tips when you hover over a toolbar button or select something in a menu. It also indicates whether the JRockit Management Console is connected to one or several BEA JRockit JVM implementations or not. To toggle the Status Bar on or off, on the View menu, select Status Bar.
Once the console is running, you will need to configure it to suit your needs. Configuring—or "setting up"—the console includes these tasks:
The connection browser displays a collection of saved connections to BEA JRockit JVM organized in folders. If necessary, you can add your own folders and connection nodes to the tree structure. Active connections currently connected to a running VM are indicated by a green icon; those disconnected are indicated by a red icon.
To create your own folder in the connection browser, do the following:
Ctrl+N. The Add new folder dialog box (Figure 4-7) appears:
Figure 4-7 Add New Folder Dialog Box
To create a new connection to BEA JRockit JVM in the connection browser, do the following:
The Add new connection dialog box (Figure 4-8) appears:
Figure 4-8 Add New Connection Dialog Box
To connect to BEA JRockit, do the following:
To disconnect a connection from BEA JRockit JVM, do the following:
To rename a connection or a folder of connection, do the following:
F2.The Folder properties dialog box (Figure 4-9) appears:
Figure 4-9 Folder Properties Dialog Box
Note: If you select the last option (click the item label), the Folder properties dialog box will not appear. Instead, the label itself will be enabled for direct editing. Simply type the new name over the old and click away from the label or press Enter.
To remove a connection or folder, do the following:
Sometimes you might want to show just information about active BEA JRockit JVM connections. To hide information about disconnected connections, do one of the following:
To show the information about disconnected connections again, simply deselect Hide Disconnected in same way that you made the selection.
This section describes how to enable various JRockit Management Console settings.
The Management Console can be run in two different operating modes:
To set the operation mode, do the following:
The Preferences dialog box (Figure 4-10) appears:
Figure 4-10 Preferences Menu (General Tab)
Figure 4-11 List of Operation Modes
Depending upon the mode to which you are toggling, the tabs on the console will change. See Figure 4-3 and Figure 4-4 for examples.
In addition to setting the operation mode, you can use the Preferences dialog box to change these settings:
To change either of these values, open the Preferences dialog box from the Tools menu and proceed are described in the following sections:
To change e-mail preferences, do the following:
Figure 4-12 E-mail Preferences Panel
Enabling the persistence means that aspect values are saved to a file and can be reviewed in charts by opening the View menu and selecting View Historical Data (View Historical Data).
Selecting Aspects to Persist To set persistence preferences, do the following:
Note: If you have not disconnected the connections and attempt to use this dialog box, you will be prompted to disconnect.
The checkboxes in the Aspects to persist panel become enabled (Figure 4-13):
Figure 4-13 Aspects to Persist Panel
The selected aspect values are saved to a file that you can review in charts as described in View Historical Data on page 4-28.
Specifying the Persistence Directory In addition to setting preferences for the aspects to persist, you can also specify where to save the file that contains the aspect value (the "Persistence directory"). To do so:
Erasing Persistence Value Logs Finally, you can erase all persistence value logs by clicking Clear all aspect logs. You will see a confirmation message to which you should respond Yes. Be aware that, if you delete all persistence value logs by clicking this button, you will also delete any other files stored in the <USER_HOME>/console/data directory.
You can customize the console and change the way some of the monitoring data is displayed, as described in this section.
The gauges and bars are graphical devices showing memory and processor usage (Figure 4-14).
Figure 4-15 Gauge Context Menu (Bar Display Selected)
The selected gauge will appear as a bar (Figure 4-16).
Figure 4-16 Gauges and Bars with Gauge Converted to a Bar Display
Charts appear on the JRockit Management Console to show specified information about BEA JRockit.
Figure 4-17 Range Selection Radio Buttons
When you exit the JRockit Management Console, your settings are automatically saved in a file called consolesettings.xml. This file is located in the folder:
<user home directory>\ManagementConsole
The exact path to the user home directory will vary on different platforms. On Windows it is usually something like \Documents and Settings\<username>; for example:
C:\Documents and Settings\jsmith\ManagementConsole
If no settings file exists in this directory it will be automatically created the next time the Management Console is closed.
Warning: Do not edit this file by hand! Doing so can make it unusable and may cause the Management Console to crash on startup.
If you are experiencing problems with the settings file, you can always delete it and let the Management Console create a new one for you.
The JRockit Management Console monitors different "aspects" of BEA JRockit JVM. An aspect is data that can be measured; for example, used heap size or VM uptime.
Information tabs are pages containing details about different areas of the monitored BEA JRockit JVM. Display a tab by clicking it or by accessing the View menu. This section describes the tabs available on the JRockit Management Console.
The Overview tab (Figure 4-19) shows an overview of selected connections. To select more than one connection, select the folder containing the connections you want to view. They will appear simultaneously. The page is divided into a "dashboard" with gauges in the upper part and charts in the lower part.
The Memory tab (Figure 4-20) shows information about the memory status of the system, as shown.
At the bottom of the page the following text information is displayed (in kilobytes):
You can manipulate certain memory aspects of the JVM from the Memory Tab. These aspects are described in Table 4-1
Table 4-1 Memory Tab Functionality
|
You can manipulate the heap size in any of the following ways:
Please refer to Setting the Heap Size for heap size requirements. |
|
|
If you are running a generational garbage collector, you can reset the nursery size by typing a new value in New nursery size and click Suggest nursery size. Note: If you are not running a generational collector, these fields will appear disabled. Please refer to Setting the Size of the Nursery for nursery size requirements. |
|
|
If you want to exit the JVM when you encounter an Out of memory (OOM) error, select Exit on OOM. |
The Processor tab (Figure 4-21) shows information about the processor status of the system.
At the bottom of the page the following text information is displayed:
The System tab (Figure 4-22) shows various information about the system status.
-Xgcprio), this value will change when the garbage collector changes. For more information on the dynamic garbage collector, please refer to Running the Dynamic Garbage Collector.Use the Notification tab (Figure 4-23) to define alerts that notify users when certain events occur. You can create your own notification rules based on different triggers, with optional constraints, that alert you with a prescribed notification. This section describes how to create these rules.
After starting the Management Console for the first time, a file named consolesettings.xml will be created in the \ManagementConsole directory in your <user_home> directory. Among the contents of this file are the entries for the default actions and constraints. You can programatically create custom notification actions and constraints, which are also stored in this file. Once added, these actions and constraints will appear on the Notifications tab of the Management Console. For complete information on creating custom notification actions and constraints, see Adding Custom Notification Actions and Constraints.
Figure 4-23 Notification Tab (No Rules Defined)
A notification trigger can be a certain event, for example, that the connection to BEA JRockit JVM was lost, or that an aspect reaches a certain value, for example, the used memory reaches 95%. A notification constraint can limit when a rule is triggered for example by not sending alerts at night or on certain dates.
The notification action is how the alert is communicated to the user. It can be one of the following:
Rules determine when and how to issue a notification. To create a new rule, do the following:
The Name your rule dialog box appears (Figure 4-24):
Figure 4-24 Name Your Rule Dialog Box
The Select trigger dialog box appears (Figure 4-25):
Figure 4-25 Select Trigger Dialog Box
Figure 4-26 Trigger Threshold and Options Text Boxes
The Select Action dialog box appears (Figure 4-27):
Figure 4-27 Select Action Dialog Box
The Select Constraint dialog box appears (Figure 4-28):
Figure 4-28 Select Constraint Dialog Box
The constraint name will appear in the add list, as shown in Figure 4-29.
The new rule appears in the All available rules list on the Notification tab, as shown in Figure 4-30.
To edit a rule, do the following:
To add a rule to BEA JRockit JVM, do the following:
The rule appears in the Active rules for this connection list, as shown in Figure 4-31.
Figure 4-31 Rule Added to Active rules for This Connection List
To remove a rule from BEA JRockit JVM, do the following:
To remove a rule from the Available rules list, do the following:
The historical data window displays a chart where historical data for an aspect can be viewed. This is useful for observing trends over time and, for example, finding when a server running with BEA JRockit JVM has its peak loads.
To open this window, do the following:
Figure 4-32 View Menu with Historical Data Submenu Open
Historical data for the selected aspect appears (Figure 4-33).
Figure 4-33 Historical Data (CPU Load Selected)
To be able to observe historical data, aspect data from BEA JRockit JVM must first have been persisted, that is, written to file. See Setting Other Preferences to enable or disable persistence. The following aspects are possible to persist, and thus display, historical data for:
As soon as data has been created by a connected connection, it is available for historical observation.
This section describes the more advanced features of the Management Console. Some of these are only available when running in the Developer mode, described in Setting the Operation Mode.
The stack dump contains a list of all running threads in BEA JRockit JVM with a method call stack trace for each thread.
To view the thread stack dump, open the Tool menu and select View Thread Stack Dump. A dialog box containing the stack dump appears (Figure 4-34).
Note: You must be in the developer operation mode before you can perform the tasks described in this section. For more information on entering the developer operation mode, see Setting the Operation Mode.
The Method Profiler tab allows the developer to monitor method execution in a non-intrusive way. The Method Profiler can provide information about the average time spent in selected methods and the number of times methods are invoked.
Method Templates are collections of methods that can be re-used on different connections. There is a Default template, but the user may also create new templates.
To add a method to a template, do the following:
The Enter class name dialog box appears (Figure 4-35).
Figure 4-35 Enter Class Name Dialog Box
java.util.Vector, in the text field and click Next.The Select method dialog box appears (Figure 4-36):
Figure 4-36 Select Method Dialog Box
The method name will appear on the Method profiling information list, as shown in Figure 4-37.
Figure 4-37 Method Profiling Information List with Method Added
To remove a method from a template, do the following:
To create a new template, do the following:
The New template dialog box appears (Figure 4-38).
Figure 4-38 New Template Dialog Box
To remove a template, do the following:
To start the method profiling, do the following:
You can switch between using qualified method names or short names in the method profiling table.
The Exception Count tab (Figure 4-39) shows exceptions thrown in BEA JRockit JVM. It counts the number of exceptions of a certain type thrown.
Figure 4-39 Exception Counting Tab
To add an exception to observe, do the following:
java.io.IOException".The exception should now be displayed in the table.
To start the exception count, click Start. The results should now appear next to the name of the exception being counted. Similarly, to stop the exception count, click Stop.
To remove an exception from the count, select the exception to be removed and click Remove.
The BEA JRockit Runtime Analyzer (JRA) is an internal tool used by the BEA JRockit development team to analyze runtime performance of BEA JRockit and Java applications running on it. This tool provides information on internals in BEA JRockit that are useful to the development team and BEA JRockit in general.
One part of the JRA runs inside the JVM, recording information about it and the Java application currently running. This tool is launched from the Management Console, as described in the following procedure. The recorded information is saved to a file which you can view in the analyzer tool, as described in Using the BEA JRockit Runtime Analyzer.
To make a recording, use this procedure:
Note: Before you can make a recording, you need to be working in the Developer mode, as described in Setting the Operation Mode.
The JRA Recording dialog box appears (Figure 4-40).
Figure 4-40 JRA Recording Dialog Box
The JRA Recording Progress box appears (Figure 4-41).
Figure 4-41 JRA Recording Progress Box
To view the recording, use the analyzer tool, as described in Using the BEA JRockit Runtime Analyzer.
To close the JRockit Management Console and disconnect all connections, open the Connection menu and select Exit. Clicking X in the top right corner of the window will also close the JRockit Management Console.
You can run the Management Console, its notification subsystem, and the user actions without using a GUI. This function is referred to running the console in a "headless" mode and can greatly reduce the amount of system overhead required to run BEA JRockit.
To run the Console in the headless mode, start the console as you normally would (see Start the JRockit Management Console for details) but add the -headless command-line option; for example:
java -jar ManagementConsole.jar -headless
You can control the console's behavior by using the command-line options described in Table 4-2.
As it runs, the JVM statistics normally associated with the Management Console can be written to file. The file to which statistics are written will be automatically created, but only if you choose to save, or "persist" data. It will be created in a directory of your choosing.
You can control which JVM statistics are persisted by specifying them in an XML settings file. The settings file is also created automatically, when you exit the application when it is running in GUI mode. By default, it will be created in the <user_home>/.ManagementConsole directory. You can specify another file at another location by using the -settings command-line option.
You can use one of the command-line options listed in Table 4-2to control the behavior of the headless Management Console.
Note: These options are not specific to running the Console in the headless mode; they are also valid when running it with a GUI.
Table 4-2 Headless Management Console Command-line Options
java -jar ManagementConsole.jar -headless -settings
C:\Headless\consolesettings.xml -connectall -autoconnect -uptime 3600
-useraction ctrlbreak 30 60
All notification rules that have been previously added to specific connections will be active.
|
|
|
