Interface PerfLogMBean

All Superinterfaces:
NotificationBroadcaster, NotificationEmitter
All Known Implementing Classes:
PerfLogMBeanImpl
@ClassVersion(sourceVersion="$Id: PerfLogMBean.java 1258 2026-06-04 18:33:06Z tquadrat $") @API(status=STABLE, since="0.25.0") public interface PerfLogMBean extends NotificationEmitter

This interface describes the MBean for the Foundation Performance Logging and Monitoring.

Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: PerfLogMBean.java 1258 2026-06-04 18:33:06Z tquadrat $
Since:
0.25.0
UML Diagram
UML Diagram for "org.tquadrat.foundation.perflog.PerfLogMBean"⁠

UML Diagram for "org.tquadrat.foundation.perflog.PerfLogMBean"

UML Diagram for "org.tquadrat.foundation.perflog.PerfLogMBean"⁠

  • Field Details

  • Method Details

    • addPerformanceSection

      void addPerformanceSection(PerformanceSection definition)
      Adds the definition for a performance section.
      Parameters:
      definition - The definition for the performance section.

    • disablePerformanceSection

      String disablePerformanceSection(String name)

      Disables the performance section.

      This is an operation for the MBean.

      Parameters:
      name - The name of the performance section.
      Returns:
      A message indicating success or failure of the operation, as a JSON String.

    • enablePerformanceSection

      String enablePerformanceSection(String name)

      Enables the performance section.

      This is an operation for the MBean.

      Parameters:
      name - The name of the performance section.
      Returns:
      A message indicating success or failure of the operation, as a JSON String.

    • getNotificationExceptions

      String[] getNotificationExceptions()
      Returns the exceptions that caused a notification thread to abort.
      Returns:
      A list of exceptions that let a notification thread go down.

    • getNotificationSequenceNumber

      long getNotificationSequenceNumber()
      Returns the notification sequence number.
      Returns:
      The last used sequence number.

    • getPerformanceSection

      Optional<PerformanceSection> getPerformanceSection(PerformanceSectionName name)

      Returns the performance section specified by the given name.

      Parameters:
      name - The name of the performance section.
      Returns:
      An instance of Optional that holds the retrieved performance section.

    • getPerformanceSections

      String[] getPerformanceSections()

      Returns a list of the currently defined performance sections.

      This is an attribute for the MBean.

      Returns:
      The list of the performance section names.

    • retrievePerformanceSection

      PerformanceSection retrievePerformanceSection(PerformanceSectionName name)

      Retrieves the performance section for the given name.

      If there is no performance section for the given name, a new one is created, with the threshold and the timeout disabled. Obviously, it should not be ignored.

      Parameters:
      name - The name of the performance section.
      Returns:
      The performance section; will never be null.

    • receivePerformanceReport

      void receivePerformanceReport(PerformanceReport report)
      Takes the performance report and transfers it further.
      Parameters:
      report - The performance report.

    • showPerformanceSection

      String showPerformanceSection(String name)

      Shows the performance section status.

      This is an operation for the MBean.

      Parameters:
      name - The name of the performance section.
      Returns:
      The status of the performance section, or a message indicating what failed in case of error, as a JSON String.