hydra

Class JProbePrms

java.lang.Object

hydra.BasePrms

hydra.JProbePrms

public class JProbePrms
extends BasePrms

A class used to store keys for JProbe configuration settings. The settings are used to create instances of JProbeDescription.

The number of instances is gated by names. The remaining parameters have the indicated default values. If fewer non-default values than names are given for these parameters, the remaining instances will use the last value in the list. See $JTESTS/hydra/hydra.txt for more details.

When JProbe is enabled on a VM, hydra launches it via $JPROBE/bin/jplauncher. For more information on hydra's JProbe configuration settings, see Appendix B of a JProbe manual such as $JPROBE/doc/JProbeProfilerGuide.pdf.

JProbe cannot be used to launch VMs with working directories that are different from that of the launcher. For example, hydra clients launched with JProbe must not set HostDescription#userDirs.

Field Summary

Fields

Modifier and Type	Field and Description
static Long	filters (String(s) or List of String(s)) Sets the jprobe filters to control what is monitored.
static Long	finalSnapshot (boolean(s)) Whether to take a final snapshot on exit.
static Long	function (String(s)) Sets the jprobe function to perform.
static Long	garbageKeep (boolean(s)) Whether to include garbage-collected objects in heap snapshots.
static Long	measurement (String(s)) Type of measurement to make, either "elapsed" or "cpu (default)".
static Long	monitor (boolean(s)) Whether the user will monitor the run.
static Long	names (String(s)) Logical names of the jprobe descriptions.
static Long	recordFromStart (boolean(s)) Whether to collect data from the start.
static Long	trackObjects (boolean(s)) Whether object allocation should be tracked for the run.
static Long	triggers (String(s) or List of String(s)) Sets the jprobe triggers to control when monitoring occurs.
static Long	useDeepTraces (boolean(s)) Sets whether to gather full stack traces.

Fields inherited from class hydra.BasePrms

DASH, DEFAULT, NONE

Constructor Summary

Constructors

Constructor and Description
JProbePrms()

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args)

Methods inherited from class hydra.BasePrms

dumpKeys, keyForName, nameForKey, setValues, tab, tasktab

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

names

public static Long names

(String(s)) Logical names of the jprobe descriptions. Each name must be unique. Defaults to null. See the include files in $JTESTS/hydraconfig for common configurations.

The special logical name "none" can be used to avoid jprobe. For example, if a test configuration contains two gemfire systems, gemfire1 and gemfire2, and only gemfire1 is to be probed, set hydra.GemFirePrms#jprobeNames to probe1 none, where probe1 is the logical name of the desired jprobe configuration.

function

public static Long function

(String(s)) Sets the jprobe function to perform. See -jp_function for more information. For example, "performance" or "memory".

measurement

public static Long measurement

(String(s)) Type of measurement to make, either "elapsed" or "cpu (default)".

filters

public static Long filters

(String(s) or List of String(s)) Sets the jprobe filters to control what is monitored. See -jp_collect_data for more information. This parameter must be enclosed in quotes in a hydra configuration file. For example, use * to profile all methods.

triggers

public static Long triggers

(String(s) or List of String(s)) Sets the jprobe triggers to control when monitoring occurs. See -jp_trigger for more information. For example, "hydra.RemoteTestModule.profile():ME:SH:snapshot" will take a snapshot on entry to the method that causes a hydra client to exit.

useDeepTraces

public static Long useDeepTraces

(boolean(s)) Sets whether to gather full stack traces. Defaults to true. See -jp_use_deep_traces for more information.

garbageKeep

public static Long garbageKeep

(boolean(s)) Whether to include garbage-collected objects in heap snapshots. See -jp_garbage_keep for more information.

recordFromStart

public static Long recordFromStart

(boolean(s)) Whether to collect data from the start. See -jp_record_from_start for more information.

finalSnapshot

public static Long finalSnapshot

(boolean(s)) Whether to take a final snapshot on exit. See -jp_final_snapshot for more information.

monitor

public static Long monitor

(boolean(s)) Whether the user will monitor the run. See -jp_socket for more information.

trackObjects

public static Long trackObjects

(boolean(s)) Whether object allocation should be tracked for the run. See -jp_track_objects for more information.

Since:

3.0

Constructor Detail

JProbePrms

public JProbePrms()

Method Detail

main

public static void main(String[] args)