Annotation Type Probe

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      The name of the probe in the JProfiler UI.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean controlObjects
      Configures if this probe shows the timeline and control objects views in the JProfiler UI.
      java.lang.Class<? extends java.lang.Enum> customTypes
      You can specify custom types for events.
      boolean defaultTelemetries
      Configures if this probe should record the "Events", "Average Duration" and - if control objects are recorded - the "Recorded Open Control Objects" telemetries.
      java.lang.String description
      An optional description of this probe.
      boolean events
      Configures if this probe shows an events view in the JProfiler UI.
    • Element Detail

      • name

        java.lang.String name
        The name of the probe in the JProfiler UI. In the JProfiler UI, this string is used for the view name in the view selector below the "JEE & probes" section.
        Returns:
        a name
      • description

        java.lang.String description
        An optional description of this probe. It is shown in the probe view below the probe name.
        Returns:
        the description
        Default:
        ""
      • events

        boolean events
        Configures if this probe shows an events view in the JProfiler UI.
        Returns:
        true if events should be shown and recorded.
        Default:
        true
      • controlObjects

        boolean controlObjects
        Configures if this probe shows the timeline and control objects views in the JProfiler UI.

        You must make use of ProbeContext.createPayload(String, Object, Enum) to associate control objects with payloads.

        Returns:
        true if control objects should be shown and recorded.
        Default:
        false
      • defaultTelemetries

        boolean defaultTelemetries
        Configures if this probe should record the "Events", "Average Duration" and - if control objects are recorded - the "Recorded Open Control Objects" telemetries.
        Returns:
        true if default telemetries should be recorded.
        Default:
        true
      • customTypes

        java.lang.Class<? extends java.lang.Enum> customTypes
        You can specify custom types for events. If control objects are recorded, the same types are used for the associated control object states. Specify an Enum class with all your states as constants. The toString() method is used for the event display name. You can further customize your events by implementing TypeCustomizer in the enum class.
        Returns:
        the class of your event enum
        Default:
        java.lang.Enum.class