Package com.jprofiler.api.probe.embedded

Class SplitProbe

java.lang.Object
com.jprofiler.api.probe.embedded.SplitProbe
public abstract class SplitProbe extends Object
For each split probe, you have to create a subtype of this class and pass it as a class literal to the methods in 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 Summary

    Constructors
    Constructor
    Description
    SplitProbe()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SplitProbe

      public SplitProbe()

  • Method Details

    • isReentrant

      public boolean isReentrant()
      If you want to create nested splits with this probe you can override this method and return true. Otherwise, only the top level call in the stack to the methods in Split will have an effect.
      Returns:
      if nested splits will be recorded

    • isPayloads

      public 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.
      Returns:
      if the top level splits should be also recorded as payloads in the probes section

    • getName

      public String getName()
      If you return 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.
      Returns:
      the name of your probe

    • getDescription

      public 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.
      Returns:
      the description of your probe

    • isEvents

      public boolean isEvents()
      If you return true in isPayloads(), but want to hide the events view you can override this method and return false.
      Returns:
      if events are recorded for payloads

    • isDefaultTelemetries

      public boolean isDefaultTelemetries()
      If you return 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.
      Returns:
      if the events view should be displayed