org.apache.streams.local.counters

Class StreamsTaskCounter

java.lang.Object

org.apache.streams.local.counters.StreamsTaskCounter

All Implemented Interfaces:

StreamsTaskCounterMXBean

@ThreadSafe
public class StreamsTaskCounter
extends Object
implements StreamsTaskCounterMXBean

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
StreamsTaskCounter(String id)
StreamsTaskCounter(String id, String streamId, long startedAt)

Method Summary

Modifier and Type	Method and Description
void	addTime(long processTime) Add the time it takes to process a single datum in milliseconds
double	getAvgTime() Returns the average time in milliseconds it takes the task to readCurrent, process, or write to return.
double	getErrorRate() Get the error rate of the streams process calculated by the number of errors not handled by the StreamsTask divided by the number of datums received.
long	getMaxTime() Returns the max time in milliseconds it takes the task to readCurrent, process, or write to return.
long	getNumEmitted() Get the number of StreamsDatums emitted by the streams process
long	getNumReceived() Get the number of StreamsDatums received by the streams process
long	getNumUnhandledErrors() Get the number of errors that the process had to catch because the executing Provider/Processor/Writer did not catch and handle the exception
void	incrementEmittedCount() Increment emitted count
void	incrementEmittedCount(long delta) Increment emitted count
void	incrementErrorCount() Increment error count
void	incrementErrorCount(long delta) Increment error count
void	incrementReceivedCount() Increment received count
void	incrementReceivedCount(long delta) Increment received count

Methods inherited from class java.lang.Object

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

Field Detail

NAME_TEMPLATE

public static final String NAME_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

StreamsTaskCounter

public StreamsTaskCounter(String id)

Parameters:

id -

StreamsTaskCounter

public StreamsTaskCounter(String id,
                          String streamId,
                          long startedAt)

Parameters:

id -

Method Detail

incrementEmittedCount

public void incrementEmittedCount()

Increment emitted count

incrementEmittedCount

public void incrementEmittedCount(long delta)

Increment emitted count

Parameters:

delta -

incrementErrorCount

public void incrementErrorCount()

Increment error count

incrementErrorCount

public void incrementErrorCount(long delta)

Increment error count

Parameters:

delta -

incrementReceivedCount

public void incrementReceivedCount()

Increment received count

incrementReceivedCount

public void incrementReceivedCount(long delta)

Increment received count

Parameters:

delta -

addTime

public void addTime(long processTime)

Add the time it takes to process a single datum in milliseconds

Parameters:

processTime -

getErrorRate

public double getErrorRate()

Description copied from interface: StreamsTaskCounterMXBean

Get the error rate of the streams process calculated by the number of errors not handled by the StreamsTask divided by the number of datums received.

Specified by:

getErrorRate in interface StreamsTaskCounterMXBean

Returns:

error rate

getNumEmitted

public long getNumEmitted()

Description copied from interface: StreamsTaskCounterMXBean

Get the number of StreamsDatums emitted by the streams process

Specified by:

getNumEmitted in interface StreamsTaskCounterMXBean

Returns:

number of emitted datums

getNumReceived

public long getNumReceived()

Description copied from interface: StreamsTaskCounterMXBean

Get the number of StreamsDatums received by the streams process

Specified by:

getNumReceived in interface StreamsTaskCounterMXBean

Returns:

number of received datums

getNumUnhandledErrors

public long getNumUnhandledErrors()

Description copied from interface: StreamsTaskCounterMXBean

Get the number of errors that the process had to catch because the executing Provider/Processor/Writer did not catch and handle the exception

Specified by:

getNumUnhandledErrors in interface StreamsTaskCounterMXBean

Returns:

number of handled errors

getAvgTime

public double getAvgTime()

Description copied from interface: StreamsTaskCounterMXBean

Returns the average time in milliseconds it takes the task to readCurrent, process, or write to return.

Specified by:

getAvgTime in interface StreamsTaskCounterMXBean

Returns:

getMaxTime

public long getMaxTime()

Description copied from interface: StreamsTaskCounterMXBean

Returns the max time in milliseconds it takes the task to readCurrent, process, or write to return.

Specified by:

getMaxTime in interface StreamsTaskCounterMXBean

Returns: