Class PerfLogUtils

java.lang.Object

org.tquadrat.foundation.perflog.PerfLogUtils

@ClassVersion(sourceVersion="$Id: PerfLogUtils.java 1258 2026-06-04 18:33:06Z tquadrat $")
@API(status=STABLE,
     since="0.25.0")
@UtilityClass
public final class PerfLogUtils
extends Object

Several tools for the Foundation Performance Logging and Monitoring.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: PerfLogUtils.java 1258 2026-06-04 18:33:06Z tquadrat $

Since:

0.25.0

UML Diagram

⁠

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

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PerfLogUtils.PerformanceTrackerHolder	A holder for PerformanceTracker that allows to use it with try-with-resources.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOMAIN_NAME	The domain name part of the ObjectName identifying the PerfLogMBean in the MBean server: "org.tquadrat.foundation.PerfLog"
static final String	MBEAN_TYPE	The type for the ObjectName identifying the PerfLogMBean in the MBean server: "PerformanceLogging".
static final String	SYSTEM_PROPERTY_UsedDedicatedMBeanServer	The name of the system property that controls whether to use a dedicated MBeanServer: "org.tquadrat.foundation.perflog.UseDedicatedMBeanServer".

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PerfLogUtils()	Not instance allowed for this class!

Method Summary

Modifier and Type	Method	Description
static final PerfLogManager	createPerfLogManager()	Creates an instance of PerfLogManager that handles the connection with the underlying PerfLogMBean.
static final PerfLogManager	createPerfLogManager(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)	Creates an instance of PerfLogManager that handles the connection with the underlying PerfLogMBean.
static final PerfLogManager	createPerfLogManager(MBeanServer mbeanServer)	Creates an instance of PerfLogManager that handles the connection with the underlying PerfLogMBean.
static final PerfLogManager	createPerfLogManager(MBeanServer mbeanServer, Thread.UncaughtExceptionHandler uncaughtExceptionHandler)	Creates an instance of PerfLogManager that handles the connection with the underlying PerfLogMBean.
static PerformanceSectionName	createPerformanceSectionName(String value)	Creates a new instance for an implementation of PerformanceSectionName based on the given value.
static final ObjectName	getPerfLogMBeanObjectName()	Returns the ObjectName for the PerfLogMBean.
static final PerfLogUtils.PerformanceTrackerHolder	hold(String value)	Creates a PerformanceTracker for the PerformanceSection with the given name.
static final PerfLogUtils.PerformanceTrackerHolder	hold(Optional<? extends PerformanceTracker> tracker)	Creates a holder for the given PerformanceTracker.
static final PerfLogUtils.PerformanceTrackerHolder	hold(PerfLogManager manager, PerformanceSectionName name)	Creates a PerformanceTracker for the PerformanceSection with the given name.
static final PerfLogUtils.PerformanceTrackerHolder	hold(PerformanceSectionName name)	Creates a PerformanceTracker for the PerformanceSection with the given name.
static final PerfLogUtils.PerformanceTrackerHolder	holdAndStart(String value)	Creates a PerformanceTracker for the PerformanceSection with the given name and immediately starts it.
static final PerfLogUtils.PerformanceTrackerHolder	holdAndStart(Optional<? extends PerformanceTracker> tracker)	Creates a holder for the given PerformanceTracker and immediately starts it.
static final PerfLogUtils.PerformanceTrackerHolder	holdAndStart(PerfLogManager manager, PerformanceSectionName name)	Creates a PerformanceTracker for the PerformanceSection with the given name and immediately starts it.
static final PerfLogUtils.PerformanceTrackerHolder	holdAndStart(PerformanceSectionName name)	Creates a PerformanceTracker for the PerformanceSection with the given name and immediately starts it.
static final MBeanServer	obtainMBeanServer()	Retrieves the MBeanServer that is used for the registration of the PerfLogMBean.

Methods inherited from class Object

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

Field Details

DOMAIN_NAME

public static final String DOMAIN_NAME

The domain name part of the ObjectName identifying the PerfLogMBean in the MBean server: "org.tquadrat.foundation.PerfLog".

It is also used for the creation of the MBean server, if a dedicated MBean server is needed; usually the Platform MBean server is used.

See Also:

• MBeanServerFactory.createMBeanServer(String)
• ManagementFactory.getPlatformMBeanServer()
• Constant Field Values

MBEAN_TYPE

public static final String MBEAN_TYPE

The type for the ObjectName identifying the PerfLogMBean in the MBean server: "PerformanceLogging".

See Also:

• Constant Field Values

SYSTEM_PROPERTY_UsedDedicatedMBeanServer

public static final String SYSTEM_PROPERTY_UsedDedicatedMBeanServer

The name of the system property that controls whether to use a dedicated MBeanServer: "org.tquadrat.foundation.perflog.UseDedicatedMBeanServer".

If not provided or set to false, the platform MBean server is used.

See Also:

• ManagementFactory.getPlatformMBeanServer()
• Constant Field Values

Constructor Details

PerfLogUtils

private PerfLogUtils()

Not instance allowed for this class!

Method Details

createPerfLogManager

public static final PerfLogManager createPerfLogManager(MBeanServer mbeanServer)

Creates an instance of PerfLogManager that handles the connection with the underlying PerfLogMBean.

When called multiple times with references to different MBean servers, each of these calls will create a new instance of PerfLogMBean.

Parameters:

mbeanServer - The MBean server that holds the PerfLogMBean.

Returns:

The new performance logging manager.

See Also:

• createPerfLogManager()
• createPerfLogManager(UncaughtExceptionHandler)
• obtainMBeanServer()

createPerfLogManager

public static final PerfLogManager createPerfLogManager(MBeanServer mbeanServer,
 Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Creates an instance of PerfLogManager that handles the connection with the underlying PerfLogMBean.

When called multiple times with references to different MBean servers, each of these calls will create a new instance of PerfLogMBean.

Parameters:

mbeanServer - The MBean server that holds the PerfLogMBean.

uncaughtExceptionHandler - The implementation of Thread.UncaughtExceptionHandler that is used for the timeout monitoring thread.

Returns:

The new performance logging manager.

See Also:

• createPerfLogManager()
• createPerfLogManager(UncaughtExceptionHandler)
• obtainMBeanServer()

createPerfLogManager

public static final PerfLogManager createPerfLogManager()

Creates an instance of PerfLogManager that handles the connection with the underlying PerfLogMBean.

The method uses the MBeanServer that is returned from obtainMBeanServer().

Returns:

The new performance logging manager.

createPerfLogManager

public static final PerfLogManager createPerfLogManager(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Creates an instance of PerfLogManager that handles the connection with the underlying PerfLogMBean.

The method uses the MBeanServer that is returned from obtainMBeanServer().

Parameters:

uncaughtExceptionHandler - The implementation of Thread.UncaughtExceptionHandler that is used for the timeout monitoring thread.

Returns:

The new performance logging manager.

createPerformanceSectionName

public static PerformanceSectionName createPerformanceSectionName(String value)

Creates a new instance for an implementation of PerformanceSectionName based on the given value.

Parameters:

value - The value for the new name.

Returns:

The new name.

getPerfLogMBeanObjectName

public static final ObjectName getPerfLogMBeanObjectName()

Returns the ObjectName for the PerfLogMBean.

Returns:

The object name for the performance logging MBean.

hold

public static final PerfLogUtils.PerformanceTrackerHolder hold(Optional<? extends PerformanceTracker> tracker)

Creates a holder for the given PerformanceTracker.

This is a convenience method that allows to use a performance tracker with try-with-resources.

Parameters:

tracker - An instance of Optional that holds the tracker.

Returns:

A holder for the given tracker.

Throws:

ClassCastException - If called with an instance of Holder instead of a raw PerformanceTracker.

hold

public static final PerfLogUtils.PerformanceTrackerHolder hold(PerformanceSectionName name)

Creates a PerformanceTracker for the PerformanceSection with the given name.

It creates an instance of PerfLogManager on the fly, using the MBeanServer returned by obtainMBeanServer().

This is a convenience method that allows to use a performance tracker with try-with-resources.

Parameters:

name - The name of the performance section.

Returns:

A holder for the given tracker.

hold

public static final PerfLogUtils.PerformanceTrackerHolder hold(PerfLogManager manager,
 PerformanceSectionName name)

Creates a PerformanceTracker for the PerformanceSection with the given name.

This is a convenience method that allows to use a performance tracker with try-with-resources.

Parameters:

manager - The Performance Logging Manager that connects to the PerfLogMBean.

name - The name of the performance section.

Returns:

A holder for the given tracker.

hold

public static final PerfLogUtils.PerformanceTrackerHolder hold(String value)

Creates a PerformanceTracker for the PerformanceSection with the given name.

It creates an instance of PerfLogManager on the fly, using the MBeanServer returned by obtainMBeanServer().

This is a convenience method that allows to use a performance tracker with try-with-resources.

Parameters:

value - The name of the performance section.

Returns:

A holder for the given tracker.

holdAndStart

public static final PerfLogUtils.PerformanceTrackerHolder holdAndStart(Optional<? extends PerformanceTracker> tracker)

Creates a holder for the given PerformanceTracker and immediately starts it.

This is a convenience method that allows to use a performance tracker with try-with-resources.

Parameters:

tracker - An instance of Optional that holds the tracker.

Returns:

A holder for the given tracker.

holdAndStart

public static final PerfLogUtils.PerformanceTrackerHolder holdAndStart(PerformanceSectionName name)

Creates a PerformanceTracker for the PerformanceSection with the given name and immediately starts it.

It creates an instance of PerfLogManager on the fly, using the MBeanServer returned by obtainMBeanServer().

This is a convenience method that allows to use a performance tracker with try-with-resources.

Parameters:

name - The name of the performance section.

Returns:

A holder for the given tracker.

holdAndStart

public static final PerfLogUtils.PerformanceTrackerHolder holdAndStart(PerfLogManager manager,
 PerformanceSectionName name)

Creates a PerformanceTracker for the PerformanceSection with the given name and immediately starts it.

It creates an instance of PerfLogManager on the fly, using the MBeanServer returned by obtainMBeanServer().

This is a convenience method that allows to use a performance tracker with try-with-resources.

Parameters:

manager - The Performance Logging Manager that connects to the PerfLogMBean.

name - The name of the performance section.

Returns:

A holder for the given tracker.

holdAndStart

public static final PerfLogUtils.PerformanceTrackerHolder holdAndStart(String value)

Creates a PerformanceTracker for the PerformanceSection with the given name and immediately starts it.

It creates an instance of PerfLogManager on the fly, using the MBeanServer returned by obtainMBeanServer().

This is a convenience method that allows to use a performance tracker with try-with-resources.

Parameters:

value - The name of the performance section.

Returns:

A holder for the given tracker.

obtainMBeanServer

public static final MBeanServer obtainMBeanServer()

Retrieves the MBeanServer that is used for the registration of the PerfLogMBean.

If the system property "org.tquadrat.foundation.perflog.UseDedicatedMBeanServer" is set to true, a dedicated MBean server for the domain "org.tquadrat.foundation.PerfLog" will be used, otherwise the MBean server that is returned by ManagementFactory.getPlatformMBeanServer() is returned.

Returns:

The MBean server.

See Also:

• SYSTEM_PROPERTY_UsedDedicatedMBeanServer