Package org.apache.hadoop.fs.statistics.impl

Class ForwardingIOStatisticsStore

java.lang.Object

org.apache.hadoop.fs.statistics.impl.ForwardingIOStatisticsStore

All Implemented Interfaces:

DurationTrackerFactory, IOStatisticsStore, IOStatistics, IOStatisticsAggregator, IOStatisticsSetters

public class ForwardingIOStatisticsStore
extends java.lang.Object
implements IOStatisticsStore

This may seem odd having an IOStatisticsStore which does nothing but forward to a wrapped store, but it's designed to assist in subclassing of selective methods, such as those to increment counters, get durations etc.

Field Summary

Fields inherited from interface org.apache.hadoop.fs.statistics.IOStatistics

MAX_UNSET_VALUE, MIN_UNSET_VALUE

Constructor Summary

Constructors

Constructor	Description
ForwardingIOStatisticsStore(IOStatisticsStore innerStatistics)

Method Summary

Modifier and Type	Method	Description
void	addMaximumSample(java.lang.String key, long value)	Add a maximum sample: if greater than the current value, updates the value.
void	addMeanStatisticSample(java.lang.String key, long value)	Add a sample to the mean statistics.
void	addMinimumSample(java.lang.String key, long value)	Add a minimum sample: if less than the current value, updates the value.
void	addTimedOperation(java.lang.String prefix, long durationMillis)	Add a duration to the min/mean/max statistics, using the given prefix and adding a suffix for each specific value.
void	addTimedOperation(java.lang.String prefix, java.time.Duration duration)	Add a duration to the min/mean/max statistics, using the given prefix and adding a suffix for each specific value.; increment tha counter whose name == prefix.
boolean	aggregate(IOStatistics statistics)	Aggregate the supplied statistics into the current set.
java.util.Map<java.lang.String,java.lang.Long>	counters()	Map of counters.
java.util.Map<java.lang.String,java.lang.Long>	gauges()	Map of gauges.
java.util.concurrent.atomic.AtomicLong	getCounterReference(java.lang.String key)	Get a reference to the atomic instance providing the value for a specific counter.
java.util.concurrent.atomic.AtomicLong	getGaugeReference(java.lang.String key)	Get a reference to the atomic instance providing the value for a specific gauge.
protected IOStatisticsStore	getInnerStatistics()
java.util.concurrent.atomic.AtomicLong	getMaximumReference(java.lang.String key)	Get a reference to the atomic instance providing the value for a specific maximum.
MeanStatistic	getMeanStatistic(java.lang.String key)	Get a reference to the atomic instance providing the value for a specific meanStatistic.
java.util.concurrent.atomic.AtomicLong	getMinimumReference(java.lang.String key)	Get a reference to the atomic instance providing the value for a specific minimum.
long	incrementCounter(java.lang.String key, long value)	Increment a counter.
long	incrementGauge(java.lang.String key, long value)	Increment a gauge.
long	incrementMaximum(java.lang.String key, long value)	Increment a maximum.
long	incrementMinimum(java.lang.String key, long value)	Increment a minimum.
java.util.Map<java.lang.String,java.lang.Long>	maximums()	Map of maximums.
java.util.Map<java.lang.String,MeanStatistic>	meanStatistics()	Map of meanStatistics.
java.util.Map<java.lang.String,java.lang.Long>	minimums()	Map of minimums.
void	reset()	Reset all statistics.
void	setCounter(java.lang.String key, long value)	Set a counter.
void	setGauge(java.lang.String key, long value)	Set a gauge.
void	setMaximum(java.lang.String key, long value)	Set a maximum.
void	setMeanStatistic(java.lang.String key, MeanStatistic value)	Set a mean statistic to a given value.
void	setMinimum(java.lang.String key, long value)	Set a minimum.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.fs.statistics.DurationTrackerFactory

trackDuration, trackDuration

Methods inherited from interface org.apache.hadoop.fs.statistics.impl.IOStatisticsStore

addSample, incrementCounter

Constructor Detail

ForwardingIOStatisticsStore

public ForwardingIOStatisticsStore(IOStatisticsStore innerStatistics)

Method Detail

getInnerStatistics

protected IOStatisticsStore getInnerStatistics()

counters

public java.util.Map<java.lang.String,java.lang.Long> counters()

Description copied from interface: IOStatistics

Map of counters.

Specified by:

counters in interface IOStatistics

Returns:

the current map of counters.

gauges

public java.util.Map<java.lang.String,java.lang.Long> gauges()

Description copied from interface: IOStatistics

Map of gauges.

Specified by:

gauges in interface IOStatistics

Returns:

the current map of gauges.

minimums

public java.util.Map<java.lang.String,java.lang.Long> minimums()

Description copied from interface: IOStatistics

Map of minimums.

Specified by:

minimums in interface IOStatistics

Returns:

the current map of minimums.

maximums

public java.util.Map<java.lang.String,java.lang.Long> maximums()

Description copied from interface: IOStatistics

Map of maximums.

Specified by:

maximums in interface IOStatistics

Returns:

the current map of maximums.

meanStatistics

public java.util.Map<java.lang.String,MeanStatistic> meanStatistics()

Description copied from interface: IOStatistics

Map of meanStatistics.

Specified by:

meanStatistics in interface IOStatistics

Returns:

the current map of MeanStatistic statistics.

aggregate

public boolean aggregate(@Nullable
                         IOStatistics statistics)

Description copied from interface: IOStatisticsAggregator

Aggregate the supplied statistics into the current set.

Specified by:

aggregate in interface IOStatisticsAggregator

Parameters:

statistics - statistics; may be null

Returns:

true if the statistics reference was not null and so aggregated.

incrementCounter

public long incrementCounter(java.lang.String key,
                             long value)

Description copied from interface: IOStatisticsStore

Increment a counter. No-op if the counter is unknown. If the value is negative, it is ignored.

Specified by:

incrementCounter in interface IOStatisticsStore

Parameters:

key - statistics key

value - value to increment

Returns:

the updated value or, if the counter is unknown: 0

setCounter

public void setCounter(java.lang.String key,
                       long value)

Description copied from interface: IOStatisticsSetters

Set a counter. No-op if the counter is unknown.

Specified by:

setCounter in interface IOStatisticsSetters

Parameters:

key - statistics key

value - value to set

setGauge

public void setGauge(java.lang.String key,
                     long value)

Description copied from interface: IOStatisticsSetters

Set a gauge.

Specified by:

setGauge in interface IOStatisticsSetters

Parameters:

key - statistics key

value - value to set

incrementGauge

public long incrementGauge(java.lang.String key,
                           long value)

Description copied from interface: IOStatisticsStore

Increment a gauge.

No-op if the gauge is unknown.

Specified by:

incrementGauge in interface IOStatisticsStore

Parameters:

key - statistics key

value - value to increment

Returns:

new value or 0 if the key is unknown

setMaximum

public void setMaximum(java.lang.String key,
                       long value)

Description copied from interface: IOStatisticsSetters

Set a maximum.

Specified by:

setMaximum in interface IOStatisticsSetters

Parameters:

key - statistics key

value - value to set

incrementMaximum

public long incrementMaximum(java.lang.String key,
                             long value)

Description copied from interface: IOStatisticsStore

Increment a maximum.

No-op if the maximum is unknown.

Specified by:

incrementMaximum in interface IOStatisticsStore

Parameters:

key - statistics key

value - value to increment

Returns:

new value or 0 if the key is unknown

setMinimum

public void setMinimum(java.lang.String key,
                       long value)

Description copied from interface: IOStatisticsSetters

Set a minimum.

Specified by:

setMinimum in interface IOStatisticsSetters

Parameters:

key - statistics key

value - value to set

incrementMinimum

public long incrementMinimum(java.lang.String key,
                             long value)

Description copied from interface: IOStatisticsStore

Increment a minimum.

No-op if the minimum is unknown.

Specified by:

incrementMinimum in interface IOStatisticsStore

Parameters:

key - statistics key

value - value to increment

Returns:

new value or 0 if the key is unknown

addMinimumSample

public void addMinimumSample(java.lang.String key,
                             long value)

Description copied from interface: IOStatisticsStore

Add a minimum sample: if less than the current value, updates the value.

No-op if the minimum is unknown.

Specified by:

addMinimumSample in interface IOStatisticsStore

Parameters:

key - statistics key

value - sample value

addMaximumSample

public void addMaximumSample(java.lang.String key,
                             long value)

Description copied from interface: IOStatisticsStore

Add a maximum sample: if greater than the current value, updates the value.

No-op if the key is unknown.

Specified by:

addMaximumSample in interface IOStatisticsStore

Parameters:

key - statistics key

value - sample value

setMeanStatistic

public void setMeanStatistic(java.lang.String key,
                             MeanStatistic value)

Description copied from interface: IOStatisticsSetters

Set a mean statistic to a given value.

Specified by:

setMeanStatistic in interface IOStatisticsSetters

Parameters:

key - statistic key

value - new value.

addMeanStatisticSample

public void addMeanStatisticSample(java.lang.String key,
                                   long value)

Description copied from interface: IOStatisticsStore

Add a sample to the mean statistics.

No-op if the key is unknown.

Specified by:

addMeanStatisticSample in interface IOStatisticsStore

Parameters:

key - key

value - sample value.

reset

public void reset()

Description copied from interface: IOStatisticsStore

Reset all statistics. Unsynchronized.

Specified by:

reset in interface IOStatisticsStore

getCounterReference

public java.util.concurrent.atomic.AtomicLong getCounterReference(java.lang.String key)

Description copied from interface: IOStatisticsStore

Get a reference to the atomic instance providing the value for a specific counter. This is useful if the value is passed around.

Specified by:

getCounterReference in interface IOStatisticsStore

Parameters:

key - statistic name

Returns:

the reference

getMaximumReference

public java.util.concurrent.atomic.AtomicLong getMaximumReference(java.lang.String key)

Description copied from interface: IOStatisticsStore

Get a reference to the atomic instance providing the value for a specific maximum. This is useful if the value is passed around.

Specified by:

getMaximumReference in interface IOStatisticsStore

Parameters:

key - statistic name

Returns:

the reference

getMinimumReference

public java.util.concurrent.atomic.AtomicLong getMinimumReference(java.lang.String key)

Description copied from interface: IOStatisticsStore

Get a reference to the atomic instance providing the value for a specific minimum. This is useful if the value is passed around.

Specified by:

getMinimumReference in interface IOStatisticsStore

Parameters:

key - statistic name

Returns:

the reference

getGaugeReference

public java.util.concurrent.atomic.AtomicLong getGaugeReference(java.lang.String key)

Description copied from interface: IOStatisticsStore

Get a reference to the atomic instance providing the value for a specific gauge. This is useful if the value is passed around.

Specified by:

getGaugeReference in interface IOStatisticsStore

Parameters:

key - statistic name

Returns:

the reference

getMeanStatistic

public MeanStatistic getMeanStatistic(java.lang.String key)

Description copied from interface: IOStatisticsStore

Get a reference to the atomic instance providing the value for a specific meanStatistic. This is useful if the value is passed around.

Specified by:

getMeanStatistic in interface IOStatisticsStore

Parameters:

key - statistic name

Returns:

the reference

addTimedOperation

public void addTimedOperation(java.lang.String prefix,
                              long durationMillis)

Description copied from interface: IOStatisticsStore

Add a duration to the min/mean/max statistics, using the given prefix and adding a suffix for each specific value. The update is not-atomic, even though each individual statistic is updated thread-safely. If two threads update the values simultaneously, at the end of each operation the state will be correct. It is only during the sequence that the statistics may be observably inconsistent.

Specified by:

addTimedOperation in interface IOStatisticsStore

Parameters:

prefix - statistic prefix

durationMillis - duration in milliseconds.

addTimedOperation

public void addTimedOperation(java.lang.String prefix,
                              java.time.Duration duration)

Description copied from interface: IOStatisticsStore

Add a duration to the min/mean/max statistics, using the given prefix and adding a suffix for each specific value.; increment tha counter whose name == prefix. If any of the statistics are not registered, that part of the sequence will be omitted -the rest will proceed. The update is not-atomic, even though each individual statistic is updated thread-safely. If two threads update the values simultaneously, at the end of each operation the state will be correct. It is only during the sequence that the statistics may be observably inconsistent.

Specified by:

addTimedOperation in interface IOStatisticsStore

Parameters:

prefix - statistic prefix

duration - duration