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

Interface StatsMeter

All Superinterfaces:

IpdMeter

All Known Implementing Classes:

StatsMeter.Noop

public interface StatsMeter
extends IpdMeter

Interface representing a statistics meter, which is a type of IpdMeter. A statistics meter can be updated with a single long value, which is used to calculate historical statistics.

This meter will calculate mean, min, max, p50, p90, p99 and more. All statistics are calculated only for recent values (e.g. from last 5-10 minutes) and can't be relied on for calculating statistics of all meters updates.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StatsMeter.Noop

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 MeterFactory<StatsMeter>	NOOP_FACTORY
static final String	TYPE_ID

Method Summary

Modifier and Type	Method	Description
default String	getTypeId()	Identifies type of the meter.
default void	update(long value)	Updates the metric with the given value.
void	update(long value, TimeUnit timeUnit)	Updates the metric with the given value.

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

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

Field Details

TYPE_ID

static final String TYPE_ID

See Also:

• Constant Field Values

NOOP_FACTORY

static final MeterFactory<StatsMeter> NOOP_FACTORY

Method Details

getTypeId

default String getTypeId()

Description copied from interface: IpdMeter

Identifies type of the meter.

Specified by:

getTypeId in interface IpdMeter

Returns:

Type ID of the meter

update

default void update(long value)

Updates the metric with the given value. The time unit of the value is milliseconds.

Parameters:

value - value for updated statistics

update

void update(long value,
 TimeUnit timeUnit)

Updates the metric with the given value. You may specify the time unit of the value.

Parameters:

value - value for updated statistics

timeUnit - time unit of the value