com.jprofiler.api.agent.mbean
Interface ControllerMBean

All Known Implementing Classes:

Controller

public interface ControllerMBean

This is JProfiler's MBean interface. For direct calls from your code in the same JVM, rather use the Controller class.

Method Summary

void	addBookmark(java.lang.String description) Adds a bookmark at the current time.
void	enableTriggerGroup(boolean enabled, java.lang.String groupId) Enable or disable all triggers with a specified group ID.
void	enableTriggers(boolean enabled) Enable or disable all triggers.
void	saveSnapshot(java.lang.String file) Saves a snapshot of all profiling data to disk.
void	saveSnapshotOnExit(java.lang.String file) Saves a snapshot of all profiling data to disk when the VM shuts down.
void	startAllocRecording(boolean reset) Starts recording of memory allocations.
void	startCPURecording(boolean reset) Starts recording CPU data.
void	startThreadProfiling() Starts recording of thread states and monitor usage.
void	startVMTelemetryRecording() Starts recording of VM telemetry data.
void	stopAllocRecording() Stops recording of memory allocations.
void	stopCPURecording() Stops CPU recording.
void	stopThreadProfiling() Stops recording of thread states and monitor usage.
void	stopVMTelemetryRecording() Stops recording of VM telemetry data.
void	triggerHeapDump() Triggers a heap dump.
void	triggerHeapDumpWithOptions(boolean fullGc, boolean onlyRecorded, boolean primitiveData, boolean calculateRetainedSizes) Triggers a heap dump.

Method Detail

startCPURecording

void startCPURecording(boolean reset)

Starts recording CPU data. This method can be called repeatedly and alternatingly with stopCPURecording(). With these methods you can restrict CPU profiling to certain regions of your code.

Parameters:

reset - if true, any previously accumulated CPU profiling data will be discarded. If false, CPU data will be accumulated accross pairs of invocations of startCPURecording() and stopCPURecording().

stopCPURecording

void stopCPURecording()

Stops CPU recording. This method can be called after startCPURecording() has been called. However, you do not have to call it since CPU profiling can run until the JVM exits.

startAllocRecording

void startAllocRecording(boolean reset)

Starts recording of memory allocations. This method can be called repeatedly and alternatingly with stopAllocRecording(). With these methods you can restrict memory allocation profiling to certain regions of your code. This is especially useful for profiling an application running within an application server.

Parameters:

reset - if true, any previously recorded profiling data will be discarded. If false, allocations within all pairs of invocations of startAllocRecording() and stopAllocRecording() will be recorded.

stopAllocRecording

void stopAllocRecording()

Stops recording of memory allocations. This method can be called after startAllocRecording() has been called. However, you do not have to call it since memory profiling can run until the JVM exits.

addBookmark

void addBookmark(java.lang.String description)

Adds a bookmark at the current time. The bookmark will be displayed in all JProfiler graphs with a time axis. The description will be displayed in the tooltip for the bookmark.

Parameters:

description - the name of the bookmark, may also be null

triggerHeapDumpWithOptions

void triggerHeapDumpWithOptions(boolean fullGc,
                                boolean onlyRecorded,
                                boolean primitiveData,
                                boolean calculateRetainedSizes)

Triggers a heap dump. If you want to analyze a heap dump with the heap walker in a snapshot saved with the saveSnapshot method, you should call this method from your source code at an appropriate time.

ATTENTION: Taking a heap dump takes a long time (on the order of seconds). If you call this method to often, your application might become unusable or take an excessively long time to finish.

Parameters:

fullGc - if true, a full garbage collection will be performed.

onlyRecorded - if true, only objects recorded between startAllocRecording and stopAllocRecording will be inlucded in the dump.

primitiveData - if true, primitive data will also be recorded. This has no effect for JVMTI 1.0 (Java 5).

calculateRetainedSizes - if true, the retained sizes of all objects will be calculated. This requires fullGc=true.

triggerHeapDump

void triggerHeapDump()

Triggers a heap dump. Calls triggerHeapDumpWithOptions(true, false, true, true).

See Also:

triggerHeapDumpWithOptions(boolean, boolean, boolean, boolean)

saveSnapshot

void saveSnapshot(java.lang.String file)

Saves a snapshot of all profiling data to disk. This is especially important for offline profiling. You should choose the standard extension .jps for the file parameter, since JProfiler's GUI frontend filters the corresponding file choosers for that extension. If you want to save several snapshots during one profiling run, please take care to provide unique file parameters since snapshot files will be overwritten otherwise.

ATTENTION: Saving a snapshot takes a long time (on the order of seconds). If you call this method to often, your application might become unusable or take an excessively long time to finish, and your hard disk might run out of space.

Parameters:

file - the file to which the snapshot should be saved.

startThreadProfiling

void startThreadProfiling()

Starts recording of thread states and monitor usage. This method can be called repeatedly and alternatingly with stopThreadProfiling(). For an offline session, thread profiling is switched on by default.

stopThreadProfiling

void stopThreadProfiling()

Stops recording of thread states and monitor usage. This method can be called repeatedly and alternatingly with startThreadProfiling(). However, you do not have to call it since thread profiling can run until the JVM exits.

startVMTelemetryRecording

void startVMTelemetryRecording()

Starts recording of VM telemetry data. This method can be called repeatedly and alternatingly with stopVMTelemetryRecording(). For an offline session, VM telemetry recording is switched on by default.

stopVMTelemetryRecording

void stopVMTelemetryRecording()

Stops recording of VM telemetry data. This method can be called repeatedly and alternatingly with startVMTelemetryRecording(). However, you do not have to call it since VM telemetry recording can run until the JVM exits.

saveSnapshotOnExit

void saveSnapshotOnExit(java.lang.String file)

Saves a snapshot of all profiling data to disk when the VM shuts down. This is especially important for offline profiling. You should choose the standard extension .jps for the file parameter, since JProfiler's GUI frontend filters the corresponding file choosers for that extension.

ATTENTION: Saving a snapshot can take quite some time (on the order fo seconds). When the VM is shut down during a user logout or a system shutdown, the OS may terminate the VM before saving is completed.

Parameters:

file - the file to which the snapshot should be saved.

enableTriggerGroup

void enableTriggerGroup(boolean enabled,
                        java.lang.String groupId)
                        throws java.lang.IllegalArgumentException

Enable or disable all triggers with a specified group ID. The group ID can be entered in the "Group ID" step of the trigger configuration wizard in the JProfiler GUI.

Parameters:

enabled - if the triggers should be enabled

groupId - the group ID

Throws:

java.lang.IllegalArgumentException - if no trigger with the specified group ID exists

enableTriggers

void enableTriggers(boolean enabled)

Enable or disable all triggers. The enabled/disabled state of the single triggers will not be lost, disabling all triggers with this method overrides the enabled/disabled state of the single triggers.

Parameters:

enabled - if the triggers should be enabled