B Command Reference

This appendix serves as a basic reference to the commands you can use with the JRockit Flight Recorder. It contains these sections:

• Section B.1, "Start-up Commands"

• Section B.2, "Diagnostic Command Reference"

B.1 Start-up Commands

Start-up Commands are the -X and -XX command-line options that you enter when you start a Java program. The specific JRockit Flight Recorder command-line options are:

• -XX:+|-FlightRecorder

• -XX:FlightRecorderOptions

• -XX:+|-FlightRecordingDumpOnUnhandledException

• -XX:FlightRecordingDumpPath

• -XX:StartFlightRecording

These commands are described in the Oracle JRockit Command Line Reference, available on the Oracle Technology Network.

Note:

You should use -XX options only if you have a thorough understanding of your system. If you use these commands improperly, you might affect the stability or performance of your system. -XX options are subject to change at any time.

B.2 Diagnostic Command Reference

This is a description of the Diagnostic Commands available to control JRockit Flight Recorder and the parameters available for each command. This information is also available by typing jrcmd <pid> help <command>. The diagnostic commands associated with the JRockit Flight Recorder are:

• start_flightrecording

• check_flightrecording

• stop_flightrecording

• dump_flightrecording

These commands are described in the Oracle JRockit Command Line Reference, available on the Oracle Technology Network.

For more information on using jrcmd, see "Using jrmcd" in the Oracle JRockit JDK Tools.

B.2.1 start_flightrecording

The start_flightrecording diagnostic command starts a flight recording. Table B-1 lists the parameters you can use with this command.

Table B-1 start_flightrecording

Parameter	Description	Type of value	Default
name	Name of recording	String
settings	Server-side template	String
defaultrecording	Starts default recording	Boolean	False
delay	Delay start of recording	Time	0s
duration	Duration of recording	Time	0s (means "forever")
filename	Resulting recording filename	String
compress	GZip compress the resulting recording file	Boolean	False
maxage	Maximum age of buffer data	Time	0s (means "no age limit")
maxsize	Maximum size of buffers in bytes	Long	0 (means "no max size")

B.2.2 check_flightrecording

The check_flightrecording diagnostic command checks running flight recordings. Table B-2 lists the parameters you can use with this command.

Table B-2 check_flightrecording

Parameter	Description	Type of value	Default
name	Recording name	String
recording	Recording id	Long	1
verbose	Print verbose data about the recording(s)	Boolean	False

B.2.3 stop_flightrecording

The stop_flightrecording diagnostic command stops running flight recordings. Table B-3 lists the parameters you can use with this command.

Table B-3 stop_flightrecording

Parameter	Description	Type of value	Default
name	Recording name	String
recording	Recording id	Long	1
discard	Discards the recording data	Boolean
copy_to_file	Copy recording data to file	String
compress_copy	GZip compress "copy_to_file" destination	Boolean	False

B.2.4 dump_flightrecording

The dump_flightrecording diagnostic command dumps flight recordings. Table B-4 lists the parameters you can use with this command.

Table B-4 dump_flightrecording

Parameter	Description	Type of value	Default
name	Recording name	String
recording	Recording id	Long	1
copy_to_file	Copy recording data to file	String
compress_copy	GZip compress "copy_to_file" destination	Boolean	False