Package com.atlassian.diagnostics.ipd.api.meters

Interface CustomMeter<T>

Type Parameters:

T - T is a class which implements an interface annotated with MXBean. Getters on this interface define the exposed JMX attributes.

All Superinterfaces:

IpdMeter

All Known Implementing Classes:

CustomMeter.Noop, CustomMeterImpl

public interface CustomMeter<T>
extends IpdMeter

Interface representing a custom meter, which is a type of IpdMeter. A custom meter is used to expose custom attributes to JMX and log file through the IPD framework.

You can define custom attributes by creating a class which implements an interface annotated with MXBean. Getters on this interface define the exposed JMX attributes.
Your class implementation must be thread safe.

See example implementations:
IpdConnectionState
IpdLongBucketsCounter

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomMeter.MBeanSupplier<BEAN_TYPE>	Helper class which supplies a new instance of CustomMBean.
static class	CustomMeter.Noop<T>

Nested classes/interfaces inherited from interface com.atlassian.diagnostics.ipd.api.meters.IpdMeter

IpdMeter.NoopMeter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_ID

Method Summary

Modifier and Type	Method	Description
T	getMBeanObject()	The returned object holds attribute data that are exposed to JMX.
static <T> MeterFactory<CustomMeter<T>>	noopFactory(CustomMeter.MBeanSupplier<T> mBeanSupplier)
void	update(Consumer<T> updater)	Updates the meter state by calling the updater function.

Methods inherited from interface com.atlassian.diagnostics.ipd.api.meters.IpdMeter

close, getAttributes, getConfig, getMeterKey, getObjectName, getTypeId, hideUntilUpdate, isClosed, isEnabled, isVisible, lastUpdateMillis

Field Details

TYPE_ID

static final String TYPE_ID

See Also:

• Constant Field Values

Method Details

noopFactory

static <T> MeterFactory<CustomMeter<T>> noopFactory(CustomMeter.MBeanSupplier<T> mBeanSupplier)

getMBeanObject

T getMBeanObject()

The returned object holds attribute data that are exposed to JMX. You can update the meter state directly by calling methods on this instance.

However, any changes made through this instance will bypass enabled checks of this meter.
Direct updates won't be logged to file when the meter is configured as MeterConfigBuilder.setLogOnUpdate(boolean).

Do not keep this MBeanObject instance long-term.

Returns:

the object that will be exposed to JMX

update

void update(Consumer<T> updater)

Updates the meter state by calling the updater function. Updater function will be called only when the meter is enabled.

Updates made through this instance will be logged to file when the meter is configured as MeterConfigBuilder.setLogOnUpdate(boolean).

Parameters:

updater - function that updates the meter state