public interface Payload
Payload is annotatated into the call tree. If the associated interceptor uses the "payload cap" feature, payload instances are merged into an [Earlier calls] payload if the number of payloads attached to a certain call stack exceeds a user-defined maximum count (by default 20). This cap is handled separately for each payload type. All built-in interceptors use the user-defined cap that can be adjusted on the "Java subsystems" tab in the profiling settings.
Interceptors can decide whether to merge payloads with the same description or not. Depending on this setting, payload descriptions are unique or can occur multiple times for the same call stack. All built-in interceptors merge payloads with equal descriptions.
For built-in interceptors, the type of a payload is one of the PAYLOAD_TYPE_*
constants defined in this interface.
For custom probes, the payload id can be determined from the ProbeInfo
data object.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PAYLOAD_NAME_ALL_CUSTOM_PROBES
Payload name used for toggling recording of all custom probes.
|
static java.lang.String |
PAYLOAD_NAME_EXCEPTION
Payload name for the built-in exception interceptor.
|
static java.lang.String |
PAYLOAD_NAME_JDBC
Payload name for the built-in JDBC interceptor.
|
static java.lang.String |
PAYLOAD_NAME_JMS
Payload name for the built-in JMS interceptor.
|
static java.lang.String |
PAYLOAD_NAME_JNDI
Payload name for the built-in JNDI interceptor.
|
static java.lang.String |
PAYLOAD_NAME_SERVLET
Payload name for the built-in URL interceptor.
|
static int |
PAYLOAD_TYPE_JDBC
Payload type for the built-in JDBC interceptor.
|
static int |
PAYLOAD_TYPE_JMS
Payload type for the built-in JMS interceptor.
|
static int |
PAYLOAD_TYPE_JNDI
Payload type for the built-in JNDI interceptor.
|
static int |
PAYLOAD_TYPE_SERVLET
Payload type for the built-in Servlet interceptor.
|
Modifier and Type | Method and Description |
---|---|
long |
getBlockedMicro()
Returns the time measurement in the "Blocked" thread state associated with this payload.
|
int |
getCount()
Returns the number of times this payload was added.
|
java.lang.String |
getDescription()
Returns the description for this particular payload.
|
long |
getNetioMicro()
Returns the time measurement in the "Net IO" thread state associated with this payload.
|
long |
getRunnableMicro()
Returns the time measurement in the "Runnable" thread state associated with this payload.
|
long |
getTimeStampMicro()
Returns the time stamp when this payload was added to the call tree.
|
int |
getType()
Returns ths type of the payload.
|
long |
getWaitingMicro()
Returns the time measurement in the "Waiting" thread state associated with this payload.
|
static final int PAYLOAD_TYPE_JDBC
static final int PAYLOAD_TYPE_JMS
static final int PAYLOAD_TYPE_JNDI
static final int PAYLOAD_TYPE_SERVLET
static final java.lang.String PAYLOAD_NAME_JDBC
static final java.lang.String PAYLOAD_NAME_JMS
static final java.lang.String PAYLOAD_NAME_JNDI
static final java.lang.String PAYLOAD_NAME_SERVLET
static final java.lang.String PAYLOAD_NAME_EXCEPTION
static final java.lang.String PAYLOAD_NAME_ALL_CUSTOM_PROBES
int getType()
java.lang.String getDescription()
int getCount()
long getRunnableMicro()
ThreadStatus
long getWaitingMicro()
ThreadStatus
long getBlockedMicro()
ThreadStatus
long getNetioMicro()
ThreadStatus
long getTimeStampMicro()