public abstract class SplitProbe
extends java.lang.Object
Split
. You can override the methods of this class to configure your probe.
If you return true
in isPayloads()
you can add additional custom telemetries by adding public
static methods to your subclass that return a number type and are annotated with Telemetry
.
Constructor and Description |
---|
SplitProbe() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDescription()
If you return
true in isPayloads() you can override this method to add a description for your probe in JProfiler's probe section. |
java.lang.String |
getName()
If you return
true in isPayloads() you can override this method to specify the display name of your probe. |
boolean |
isDefaultTelemetries()
If you return
true in isPayloads() but want to remove the default payload telemetries you can override this method and return false . |
boolean |
isEvents()
If you return
true in isPayloads() , but want to hide the events view you can override this method and return false . |
boolean |
isPayloads()
You can override this method and return
true to create an entry in the probes section and record your top level
splits as payloads. |
boolean |
isReentrant()
If you want to create nested splits with this probe you can override this method and return
true . |
public boolean isReentrant()
true
. Otherwise, only the
top level call in the stack to the methods in Split
will have an effect.public boolean isPayloads()
true
to create an entry in the probes section and record your top level
splits as payloads.public java.lang.String getName()
true
in isPayloads()
you can override this method to specify the display name of your probe.
In the JProfiler UI, this string is used for the view name in the view selector below the "JEE & probes" section.
If you not override this method, the simple class name of the probe is used.public java.lang.String getDescription()
true
in isPayloads()
you can override this method to add a description for your probe in JProfiler's probe section.public boolean isEvents()
true
in isPayloads()
, but want to hide the events view you can override this method and return false
.public boolean isDefaultTelemetries()
true
in isPayloads()
but want to remove the default payload telemetries you can override this method and return false
.
The default telemetries are the event frequency and the average duration telemetries.