Package org.apache.hadoop.fs.azure.metrics

Class BandwidthGaugeUpdater

java.lang.Object

org.apache.hadoop.fs.azure.metrics.BandwidthGaugeUpdater

@Private
public final class BandwidthGaugeUpdater
extends java.lang.Object

Internal implementation class to help calculate the current bytes uploaded/downloaded and the maximum bandwidth gauges.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	THREAD_NAME

Constructor Summary

Constructors

Constructor	Description
BandwidthGaugeUpdater(AzureFileSystemInstrumentation instrumentation)	Create a new updater object with default values.
BandwidthGaugeUpdater(AzureFileSystemInstrumentation instrumentation, int windowSizeMs, boolean manualUpdateTrigger)	Create a new updater object with some overrides (used in unit tests).

Method Summary

Modifier and Type	Method	Description
void	blockDownloaded(java.util.Date startDate, java.util.Date endDate, long length)	Indicate that a block has been downloaded.
void	blockUploaded(java.util.Date startDate, java.util.Date endDate, long length)	Indicate that a block has been uploaded.
void	close()
void	resumeAutoUpdate()	Resumes auto-update (undo suppressAutoUpdate).
void	suppressAutoUpdate()	For unit test purposes, suppresses auto-update of the metrics from the dedicated thread.
void	triggerUpdate(boolean updateWrite)	Triggers the update of the metrics gauge based on all the blocks uploaded/downloaded so far.

Methods inherited from class java.lang.Object

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

Field Detail

THREAD_NAME

public static final java.lang.String THREAD_NAME

See Also:

Constant Field Values

Constructor Detail

BandwidthGaugeUpdater

public BandwidthGaugeUpdater(AzureFileSystemInstrumentation instrumentation)

Create a new updater object with default values.

Parameters:

instrumentation - The metrics source to update.

BandwidthGaugeUpdater

public BandwidthGaugeUpdater(AzureFileSystemInstrumentation instrumentation,
                             int windowSizeMs,
                             boolean manualUpdateTrigger)

Create a new updater object with some overrides (used in unit tests).

Parameters:

instrumentation - The metrics source to update.

windowSizeMs - The window size to use for calculating bandwidth (in milliseconds).

manualUpdateTrigger - If true, then this object won't create the auto-update threads, and will wait for manual calls to triggerUpdate to occur.

Method Detail

blockUploaded

public void blockUploaded(java.util.Date startDate,
                          java.util.Date endDate,
                          long length)

Indicate that a block has been uploaded.

Parameters:

startDate - The exact time the upload started.

endDate - The exact time the upload ended.

length - The number of bytes uploaded in the block.

blockDownloaded

public void blockDownloaded(java.util.Date startDate,
                            java.util.Date endDate,
                            long length)

Indicate that a block has been downloaded.

Parameters:

startDate - The exact time the download started.

endDate - The exact time the download ended.

length - The number of bytes downloaded in the block.

suppressAutoUpdate

public void suppressAutoUpdate()

For unit test purposes, suppresses auto-update of the metrics from the dedicated thread.

resumeAutoUpdate

public void resumeAutoUpdate()

Resumes auto-update (undo suppressAutoUpdate).

triggerUpdate

public void triggerUpdate(boolean updateWrite)

Triggers the update of the metrics gauge based on all the blocks uploaded/downloaded so far. This is typically done periodically in a dedicated update thread, but exposing as public for unit test purposes.

Parameters:

updateWrite - If true, we'll update the write (upload) metrics. Otherwise we'll update the read (download) ones.

close

public void close()