Package com.oracle.bedrock.jprofiler

Class JprofilerProfile

java.lang.Object

com.oracle.bedrock.jprofiler.JprofilerProfile

All Implemented Interfaces:

com.oracle.bedrock.Option, com.oracle.bedrock.runtime.Profile

public class JprofilerProfile
extends Object
implements com.oracle.bedrock.runtime.Profile, com.oracle.bedrock.Option

The JProfiler Profile.

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JprofilerProfile.ListenAddress	The listen address that the application will use to listen for JProfiler connections.

Nested classes/interfaces inherited from interface com.oracle.bedrock.Option

com.oracle.bedrock.Option.Collectable, com.oracle.bedrock.Option.Collector<C extends com.oracle.bedrock.Option.Collectable,T extends com.oracle.bedrock.Option.Collector<C,T>>

Constructor Summary

Constructors

Constructor	Description
JprofilerProfile(boolean enabled, String agentLibraryFile, JprofilerProfile.ListenAddress listenAddress, boolean offline, File configurationFile, int sessionId, boolean startSuspended, boolean verbose, boolean jniInterception, Integer stack, Integer samplingStack)	Constructs a JprofilerProfile.

Method Summary

Modifier and Type	Method	Description
JprofilerProfile	defaultSamplingStack()	Use the default stack size for sampling.
JprofilerProfile	defaultStack()	Use the default stack size for dynamic instrumentation.
static JprofilerProfile	disabled()	Create a JprofilerProfile that is disabled.
static JprofilerProfile	enabled(String agentLibraryFile)	Create a JprofilerProfile that is enabled and will use the JProfiler agent at the specified location.
static JprofilerProfile	enabledNoWait(String agentLibraryFile)	Create a JprofilerProfile that is enabled and will use the JProfiler agent at the specified location.
boolean	equals(Object o)
int	hashCode()
boolean	isEnabled()	Obtain whether JProfiler is enabled.
JprofilerProfile	jniInterception(boolean jniInterception)	Enable the detection of object allocations via JNI calls.
JprofilerProfile	listenMode()	Start the application in listen mode listening on the default address and port.
JprofilerProfile	listenMode(JprofilerProfile.ListenAddress listenAddress)	Start the application in listen mode listening on the specified JprofilerProfile.ListenAddress.
JprofilerProfile	noWait()	Do not wait for JProfiler to connect when the application JVM starts.
JprofilerProfile	offlineMode(int sessionId)	Run JProfiler in offline mode using the specified session ID from the file.
JprofilerProfile	offlineMode(File configurationFile, int sessionId)	Run JProfiler in offline mode using the specified configuration XML file and the specified session ID from the file.
void	onClosing(com.oracle.bedrock.runtime.Platform platform, com.oracle.bedrock.runtime.Application application, com.oracle.bedrock.OptionsByType optionsByType)
void	onLaunched(com.oracle.bedrock.runtime.Platform platform, com.oracle.bedrock.runtime.Application application, com.oracle.bedrock.OptionsByType optionsByType)
void	onLaunching(com.oracle.bedrock.runtime.Platform platform, com.oracle.bedrock.runtime.MetaClass metaClass, com.oracle.bedrock.OptionsByType optionsByType)
JprofilerProfile	samplingStack(int samplingStack)	Set the maximum stack size for sampling.
JprofilerProfile	stack(int stack)	Set the maximum stack size for dynamic instrumentation.
JprofilerProfile	startSuspended()	Start the application suspended and wait for JProfiler to connect.
String	toString()
JprofilerProfile	verbose(boolean verbose)	JProfiler will print the names of all instrumented classes to stderr.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JprofilerProfile

public JprofilerProfile(boolean enabled,
                        String agentLibraryFile,
                        JprofilerProfile.ListenAddress listenAddress,
                        boolean offline,
                        File configurationFile,
                        int sessionId,
                        boolean startSuspended,
                        boolean verbose,
                        boolean jniInterception,
                        Integer stack,
                        Integer samplingStack)

Constructs a JprofilerProfile.

Parameters:

enabled - enabling

agentLibraryFile - the agent library file

listenAddress - the JprofilerProfile.ListenAddress

offline - start offline

configurationFile - the configuration file

sessionId - the session id

startSuspended - start suspended

verbose - verbose output

jniInterception - use JNI interception

stack - the stack

samplingStack - the sampling stack size

Method Detail

isEnabled

public boolean isEnabled()

Obtain whether JProfiler is enabled.

Returns:

true if JProfiler is enabled otherwise false

offlineMode

public JprofilerProfile offlineMode(int sessionId)

Run JProfiler in offline mode using the specified session ID from the file. The configuration file used will be the default JProfiler configuration file located in the .jprofiler directory in the current users home directory.

Parameters:

sessionId - the session id to use from the specified configuration file

Returns:

this JprofilerProfile for fluent method chaining

Throws:

IllegalStateException - if start suspended has been set to true

offlineMode

public JprofilerProfile offlineMode(File configurationFile,
                                    int sessionId)

Run JProfiler in offline mode using the specified configuration XML file and the specified session ID from the file.

Parameters:

configurationFile - the configuration file to use for JProfiler

sessionId - the session id to use from the specified configuration file

Returns:

this JprofilerProfile for fluent method chaining

Throws:

IllegalStateException - if start suspended has been set to true

listenMode

public JprofilerProfile listenMode()

Start the application in listen mode listening on the default address and port.

Returns:

this JprofilerProfile for fluent method chaining

listenMode

public JprofilerProfile listenMode(JprofilerProfile.ListenAddress listenAddress)

Start the application in listen mode listening on the specified JprofilerProfile.ListenAddress.

Parameters:

listenAddress - the JprofilerProfile.ListenAddress

Returns:

this JprofilerProfile for fluent method chaining

noWait

public JprofilerProfile noWait()

Do not wait for JProfiler to connect when the application JVM starts.

Returns:

this JprofilerProfile for fluent method chaining

startSuspended

public JprofilerProfile startSuspended()

Start the application suspended and wait for JProfiler to connect.

Returns:

this JprofilerProfile for fluent method chaining

verbose

public JprofilerProfile verbose(boolean verbose)

JProfiler will print the names of all instrumented classes to stderr.

Parameters:

verbose - true if JProfiler should run in verbose mode

Returns:

this JprofilerProfile for fluent method chaining

jniInterception

public JprofilerProfile jniInterception(boolean jniInterception)

Enable the detection of object allocations via JNI calls.

Parameters:

jniInterception - flag indicating whether to enable JNI interception

Returns:

this JprofilerProfile for fluent method chaining

stack

public JprofilerProfile stack(int stack)

Set the maximum stack size for dynamic instrumentation. Only change this parameter when JProfiler emits corresponding warning messages. The default value is 10000

Parameters:

stack - the maximum stack size for dynamic instrumentation

Returns:

this JprofilerProfile for fluent method chaining

defaultStack

public JprofilerProfile defaultStack()

Use the default stack size for dynamic instrumentation.

Returns:

this JprofilerProfile for fluent method chaining

samplingStack

public JprofilerProfile samplingStack(int samplingStack)

Set the maximum stack size for sampling. Only change this parameter when JProfiler emits corresponding warning messages. The default value is 200.

Parameters:

samplingStack - the samplign stack size

Returns:

this JprofilerProfile for fluent method chaining

defaultSamplingStack

public JprofilerProfile defaultSamplingStack()

Use the default stack size for sampling.

Returns:

this JprofilerProfile for fluent method chaining

onLaunching

public void onLaunching(com.oracle.bedrock.runtime.Platform platform,
                        com.oracle.bedrock.runtime.MetaClass metaClass,
                        com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onLaunching in interface com.oracle.bedrock.runtime.Profile

onLaunched

public void onLaunched(com.oracle.bedrock.runtime.Platform platform,
                       com.oracle.bedrock.runtime.Application application,
                       com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onLaunched in interface com.oracle.bedrock.runtime.Profile

onClosing

public void onClosing(com.oracle.bedrock.runtime.Platform platform,
                      com.oracle.bedrock.runtime.Application application,
                      com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onClosing in interface com.oracle.bedrock.runtime.Profile

enabled

public static JprofilerProfile enabled(String agentLibraryFile)

Create a JprofilerProfile that is enabled and will use the JProfiler agent at the specified location.

Parameters:

agentLibraryFile - the location of the JProfiler agent

Returns:

an enabled JprofilerProfile

enabledNoWait

@Default
public static JprofilerProfile enabledNoWait(String agentLibraryFile)

Create a JprofilerProfile that is enabled and will use the JProfiler agent at the specified location. The JprofilerProfile instance will also be configured with the "nowait" setting that means the application will not wait for JProfiler to connect when the JVM starts. This can be changed by calling startSuspended().

Parameters:

agentLibraryFile - the location of the JProfiler agent

Returns:

an enabled JprofilerProfile

disabled

public static JprofilerProfile disabled()

Create a JprofilerProfile that is disabled.

Returns:

a JprofilerProfile that is disabled.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object