org.apache.giraph.comm.netty

Class ByteCounterDelegate

java.lang.Object

org.apache.giraph.comm.netty.ByteCounterDelegate

All Implemented Interfaces:

ByteCounter

public class ByteCounterDelegate
extends Object
implements ByteCounter

Delegate Object to help keep track of the bytes processed and provide some metrics when desired as part of the Netty Channel stack.

Field Summary

Fields

Modifier and Type	Field and Description
static double	MEGABYTE Megabyte in bytes

Constructor Summary

Constructors

Constructor and Description
ByteCounterDelegate(boolean isInBound) Constructor to specify if delegate is created by InBound/ Outbound counter

Method Summary

Modifier and Type	Method and Description
int	byteBookkeeper(io.netty.buffer.ByteBuf buf) Updates properties based on bytes sent / received
long	getBytesProcessed()
long	getBytesProcessedPerSuperstep() Returns bytes processed per superstep.
double	getMbytesPerSecProcessed()
String	getMetrics()
String	getMetricsHelper(double mBytesProcessed, double mBytesProcessedPerReq) Helper method used by getMetrics to create its return string
String	getMetricsWindow(int minMsecsWindow) Get the metrics if a given window of time has passed.
void	newSuperstep(SuperstepMetricsRegistry superstepMetrics) Called by Inbound/ Outbound counters to refresh meters on a new superstep
void	resetAll() Reset everything this object keeps track of
void	resetBytes() Reset all the bytes kept track of.
void	resetBytesProcessedPerSuperstep() Set bytes processed per superstep to 0.
void	resetStartMsecs() Reset the start msecs.

Methods inherited from class java.lang.Object

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

Field Detail

MEGABYTE

public static final double MEGABYTE

Megabyte in bytes

See Also:

Constant Field Values

Constructor Detail

ByteCounterDelegate

public ByteCounterDelegate(boolean isInBound)

Constructor to specify if delegate is created by InBound/ Outbound counter

Parameters:

isInBound - switch to specify if instantiated by inbound counter

Method Detail

newSuperstep

public void newSuperstep(SuperstepMetricsRegistry superstepMetrics)

Called by Inbound/ Outbound counters to refresh meters on a new superstep

Parameters:

superstepMetrics - superstepmetrics registry

byteBookkeeper

public int byteBookkeeper(io.netty.buffer.ByteBuf buf)

Updates properties based on bytes sent / received

Parameters:

buf - ByteBuf received by the counter

Returns:

number of readable bytes

resetBytes

public void resetBytes()

Reset all the bytes kept track of.

resetStartMsecs

public void resetStartMsecs()

Reset the start msecs.

resetAll

public void resetAll()

Description copied from interface: ByteCounter

Reset everything this object keeps track of

Specified by:

resetAll in interface ByteCounter

getBytesProcessedPerSuperstep

public long getBytesProcessedPerSuperstep()

Returns bytes processed per superstep.

Returns:

Number of bytes.

resetBytesProcessedPerSuperstep

public void resetBytesProcessedPerSuperstep()

Set bytes processed per superstep to 0.

getBytesProcessed

public long getBytesProcessed()

getMbytesPerSecProcessed

public double getMbytesPerSecProcessed()

Returns:

Mbytes processed / sec in the current interval

getMetricsHelper

public String getMetricsHelper(double mBytesProcessed,
                               double mBytesProcessedPerReq)

Helper method used by getMetrics to create its return string

Parameters:

mBytesProcessed - mbytes processed

mBytesProcessedPerReq - mbytes processed per request

Returns:

A string containing all the metrics

getMetrics

public String getMetrics()

Specified by:

getMetrics in interface ByteCounter

Returns:

A string containing all the metrics

getMetricsWindow

public String getMetricsWindow(int minMsecsWindow)

Description copied from interface: ByteCounter

Get the metrics if a given window of time has passed. Return null otherwise. If the window is met, reset the metrics.

Specified by:

getMetricsWindow in interface ByteCounter

Parameters:

minMsecsWindow - Msecs of the minimum window

Returns:

Metrics or else null if the window wasn't met