Interface PerfLogManager

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

PerfLogManagerImpl

@ClassVersion(sourceVersion="$Id: PerfLogManager.java 1246 2026-05-16 14:07:00Z tquadrat $")
@API(status=STABLE,
     since="0.25.0")
public sealed interface PerfLogManager
extends AutoCloseable
permits PerfLogManagerImpl

This interface describes the Performance Logging and Monitoring Manager that is the frontend to the Performance Logging and Monitoring MBean that does the work behind the scenes.

Instances of PerfLogManager are thread-safe, so they can be created as static:

…

/**
 *  The interface to the PerfLog MBean.
 */
private static final PerfLogManager PERFLOGMANAGER;

…

static
{
    //---* Initialise the Performance Logging *--------------------------------
    PERFLOGMANAGER = PerfLogUtils.createPerfLogManager();
}
…

or as attributes as well.

Because PerfLogManager implements AutoCloseable it can be used with try-with-resources, too:

…

//---* Initialise the Performance Logging *------------------------------------
try( final var perfLogManager = PerfLogUtils.createPerfLogManager() )
{
    // Do something …

    …
}
…

If an instance is abandoned, it will perform an automatic clean-up.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: PerfLogManager.java 1246 2026-05-16 14:07:00Z tquadrat $

Since:

0.25.0

UML Diagram

⁠

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

⁠

Method Summary

Modifier and Type	Method	Description
void	close()
default Optional<PerformanceTracker>	createPerformanceTracker(String name)	Creates a performance tracker for the PerformanceSection with the given name.
Optional<PerformanceTracker>	createPerformanceTracker(PerformanceSectionName name)	Creates a performance tracker for the PerformanceSection with the given name.
Optional<PerformanceSection>	getPerformanceSection(PerformanceSectionName name)	Returns the performance section specified by the given name.
void	loadPerformanceSectionDefinitions(Iterable<PerformanceSection> definitions)	Loads the Performance Section definitions.
default void	loadPerformanceSectionDefinitions(PerformanceSection... definitions)	Loads the Performance Section definitions.

Method Details

close

void close()

After close() is called, calls to other methods of this instance may result in an IllegalStateException to be thrown.

Specified by:

close in interface AutoCloseable

createPerformanceTracker

default Optional<PerformanceTracker> createPerformanceTracker(String name)
                                                       throws IllegalStateException

Creates a performance tracker for the PerformanceSection with the given name.

The return value will be empty if the performance section is currently ignored.

If there is currently no performance section defined with the given name, one will be created with default values.

Parameters:

name - The name of the performance section.

Returns:

An instance of Optional that holds the new tracker.

Throws:

IllegalStateException - close() was already called on this instance.

createPerformanceTracker

Optional<PerformanceTracker> createPerformanceTracker(PerformanceSectionName name)
                                               throws IllegalStateException

Creates a performance tracker for the PerformanceSection with the given name.

The return value will be empty if the performance section is currently ignored.

If there is currently no performance section defined with the given name, one will be created with default values.

Parameters:

name - The name of the performance section.

Returns:

An instance of Optional that holds the new tracker.

Throws:

IllegalStateException - close() was already called on this instance.

getPerformanceSection

Optional<PerformanceSection> getPerformanceSection(PerformanceSectionName name)
                                            throws IllegalStateException

Returns the performance section specified by the given name.

Delegates to PerfLogMBean.getPerformanceSection(PerformanceSectionName)

Parameters:

name - The name of the performance section.

Returns:

An instance of Optional that holds the retrieved performance section.

Throws:

IllegalStateException - close() was already called on this instance.

loadPerformanceSectionDefinitions

default void loadPerformanceSectionDefinitions(PerformanceSection... definitions)
                                        throws IllegalStateException

Loads the Performance Section definitions.

Because these definitions are stored globally in the Performance Logging and Monitorin MBean, they need to be loaded only once. But overwriting them does not harm, other than performance.

Each instance of PerfLogManager shares the same instances of PerformanceSection.

Parameters:

definitions - The definitions for the performance sections.

Throws:

IllegalStateException - close() was already called on this instance.

loadPerformanceSectionDefinitions

void loadPerformanceSectionDefinitions(Iterable<PerformanceSection> definitions)
                                throws IllegalStateException

Loads the Performance Section definitions.

Because these definitions are stored globally in the Performance Logging and Monitorin MBean, they need to be loaded only once. But overwriting them does not harm, other than performance.

Each instance of PerfLogManager shares the same instances of PerformanceSection.

Parameters:

definitions - The definitions for the performance sections.

Throws:

IllegalStateException - close() was already called on this instance.