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

Class MeterConfigBuilderImpl

java.lang.Object

com.atlassian.diagnostics.ipd.api.meters.config.MeterConfigBuilderImpl

All Implemented Interfaces:

MeterConfigBuilder, ProductMeterConfigBuilder

public class MeterConfigBuilderImpl
extends Object
implements ProductMeterConfigBuilder

Since:

5.0.0

Constructor Summary

Constructors

Constructor	Description
MeterConfigBuilderImpl()

Method Summary

Modifier and Type	Method	Description
MeterConfigBuilder	addEnabledCheck(Predicate<MeterConfig> enabledCheck)	Adds a check to the MeterConfigBuilder that will be used to determine if the MeterConfig is enabled.
MeterConfig	build(MeterKey meterKey)	Builds the immutable meter configuration from this builder state and given meter key.
MeterConfigBuilder	logIfUpdatedInLastMinute()	Makes the meter to be logged only if it was updated in the last minute.
MeterConfigBuilder	logOnceEveryInterval(int interval)	Makes the meter to be logged once every 'interval' times.
MeterConfigBuilder	logWhen(Predicate<IpdMeter> shouldLog)	Adds additional condition for logging the meter.Meter will be logged only when this condition is met.
MeterConfigBuilder	setCustomLogger(org.slf4j.Logger logger)	Sets a custom logger for the meter.
MeterConfigBuilder	setIntervalLogging(boolean enabled)	Sets the meter to log at regular intervals.
MeterConfigBuilder	setLogOnUpdate(boolean logOnUpdate)	Sets the meter to be logged when it's updated.
ProductMeterConfigBuilder	setObjectNameConstructor(MeterObjectNameConstructor objectNameFactory)	Set the object name factory for this meter.
MeterConfigBuilder	setProperty(String key, Object value)	Sets a property on the MeterConfigBuilder.
MeterConfigBuilderImpl	setUpdateListener(Consumer<IpdMeter> updateListener)	Sets the listener that will be called when the meter value is updated and MeterConfigBuilder.setLogOnUpdate(boolean) is enabled.
MeterConfigBuilder	setWorkInProgress(boolean workInProgress)	Sets meter as "work in progress".

Methods inherited from class java.lang.Object

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

Constructor Details

MeterConfigBuilderImpl

public MeterConfigBuilderImpl()

Method Details

setObjectNameConstructor

public ProductMeterConfigBuilder setObjectNameConstructor(MeterObjectNameConstructor objectNameFactory)

Description copied from interface: ProductMeterConfigBuilder

Set the object name factory for this meter. This is used to construct the JMX ObjectName for the meter.

Specified by:

setObjectNameConstructor in interface ProductMeterConfigBuilder

Parameters:

objectNameFactory - the object name factory

Returns:

this builder

setUpdateListener

public MeterConfigBuilderImpl setUpdateListener(Consumer<IpdMeter> updateListener)

Description copied from interface: MeterConfigBuilder

Sets the listener that will be called when the meter value is updated and MeterConfigBuilder.setLogOnUpdate(boolean) is enabled.

By default this value is set to IpdConstants.NO_OP.
However, products should set this value for all meters to IpdLoggingService.logMetric(IpdMeter).

Specified by:

setUpdateListener in interface MeterConfigBuilder

Parameters:

updateListener - listener that is called when the meter value is updated

Returns:

this MeterConfigBuilder

addEnabledCheck

public MeterConfigBuilder addEnabledCheck(Predicate<MeterConfig> enabledCheck)

Description copied from interface: MeterConfigBuilder

Adds a check to the MeterConfigBuilder that will be used to determine if the MeterConfig is enabled.

Adding a new check will not remove the previous checks. All checks must pass for the MeterConfig to be enabled.

Specified by:

addEnabledCheck in interface MeterConfigBuilder

Parameters:

enabledCheck - predicate returning true if the Meter should be enabled

Returns:

this MeterConfigBuilder

setProperty

public MeterConfigBuilder setProperty(String key,
 Object value)

Description copied from interface: MeterConfigBuilder

Sets a property on the MeterConfigBuilder. Properties can be accessed later on for individual meters through MeterConfig.getProperties().

Specified by:

setProperty in interface MeterConfigBuilder

Parameters:

key - property key

value - property value

Returns:

this MeterConfigBuilder

setWorkInProgress

public MeterConfigBuilder setWorkInProgress(boolean workInProgress)

Description copied from interface: MeterConfigBuilder

Sets meter as "work in progress". Work in progress meters require additional feature flag to be enabled. It is intended for meter we want to test on internal instances before enabling them on production.

Specified by:

setWorkInProgress in interface MeterConfigBuilder

Parameters:

workInProgress - true if the meter is work in progress

Returns:

this MeterConfigBuilder

logOnceEveryInterval

public MeterConfigBuilder logOnceEveryInterval(int interval)

Description copied from interface: MeterConfigBuilder

Makes the meter to be logged once every 'interval' times.

By default, the 'interval' is set to 1, which usually means the meter will be logged every minute.

If product logs meters every minute, setting the 'interval' value to 5 will make the meter to be logged every 5 minutes.

Specified by:

logOnceEveryInterval in interface MeterConfigBuilder

Parameters:

interval - how often the meter should be logged. Is a positive integer.

Returns:

this MeterConfigBuilder

logIfUpdatedInLastMinute

public MeterConfigBuilder logIfUpdatedInLastMinute()

Description copied from interface: MeterConfigBuilder

Makes the meter to be logged only if it was updated in the last minute.

Specified by:

logIfUpdatedInLastMinute in interface MeterConfigBuilder

Returns:

this MeterConfigBuilder

setCustomLogger

public MeterConfigBuilder setCustomLogger(org.slf4j.Logger logger)

Description copied from interface: MeterConfigBuilder

Sets a custom logger for the meter. This logger will be used to log the meter values.

By default, the meter is logged to ipd log file using default logger defined in IpdConstants.DEFAULT_DATA_LOGGER.

Specified by:

setCustomLogger in interface MeterConfigBuilder

Parameters:

logger - custom logger

Returns:

this MeterConfigBuilder

setIntervalLogging

public MeterConfigBuilder setIntervalLogging(boolean enabled)

Description copied from interface: MeterConfigBuilder

Sets the meter to log at regular intervals.

By default, the meters are automatically logged in a regular interval.

Setting the 'enabled' value to false, doesn't disable all logging, but only the regular interval logging. If the meter has MeterConfigBuilder.setLogOnUpdate(boolean) enabled, it will still be logged when updated.

Specified by:

setIntervalLogging in interface MeterConfigBuilder

Parameters:

enabled - true if the meter should be logged at regular intervals

Returns:

this MeterConfigBuilder

setLogOnUpdate

public MeterConfigBuilder setLogOnUpdate(boolean logOnUpdate)

Description copied from interface: MeterConfigBuilder

Sets the meter to be logged when it's updated.

Meter will still be logged at regular intervals if MeterConfigBuilder.setIntervalLogging(boolean) is enabled.

Specified by:

setLogOnUpdate in interface MeterConfigBuilder

Parameters:

logOnUpdate - true if the meter should be logged when updated

Returns:

this MeterConfigBuilder

logWhen

public MeterConfigBuilder logWhen(Predicate<IpdMeter> shouldLog)

Description copied from interface: MeterConfigBuilder

Adds additional condition for logging the meter.Meter will be logged only when this condition is met.

All conditions must be met to log the meter.

Specified by:

logWhen in interface MeterConfigBuilder

Parameters:

shouldLog - predicate returning true if the meter should be logged

Returns:

this MeterConfigBuilder

build

public MeterConfig build(MeterKey meterKey)

Description copied from interface: ProductMeterConfigBuilder

Builds the immutable meter configuration from this builder state and given meter key.

Specified by:

build in interface ProductMeterConfigBuilder

Parameters:

meterKey - the meter key

Returns:

the immutable meter configuration