io.cdap.cdap.api.metrics

Interface RuntimeMetrics

@Beta
public interface RuntimeMetrics

Provides access to metrics about processors.

Method Summary

Modifier and Type	Method and Description
long	getException()
long	getInput()
long	getProcessed()
void	waitFor(String name, long count, long timeout, TimeUnit timeoutUnit) Waits until the metric value of the given metric name reached or exceeded the given count.
void	waitForException(long count, long timeout, TimeUnit timeoutUnit) Waits until at least the given number of exceptions has been raised.
void	waitForinput(long count, long timeout, TimeUnit timeoutUnit) Waits until at least the given number of inputs has been read.
void	waitForProcessed(long count, long timeout, TimeUnit timeoutUnit) Waits until at least the given number of inputs has been processed.

Method Detail

getInput

long getInput()

Returns:

number of inputs read

getProcessed

long getProcessed()

Returns:

number of inputs processed successfully.

getException

long getException()

Returns:

number of inputs that throws exception.

waitForinput

void waitForinput(long count,
                  long timeout,
                  TimeUnit timeoutUnit)
           throws TimeoutException,
                  InterruptedException

Waits until at least the given number of inputs has been read.

Parameters:

count - Number of inputs to wait for

timeout - Maximum time to wait for

timeoutUnit - TimeUnit for the timeout time.

Throws:

TimeoutException - If the timeout time passed and still not seeing that many count.

InterruptedException

waitForProcessed

void waitForProcessed(long count,
                      long timeout,
                      TimeUnit timeoutUnit)
               throws TimeoutException,
                      InterruptedException

Waits until at least the given number of inputs has been processed.

Parameters:

count - Number of processed to wait for

timeout - Maximum time to wait for

timeoutUnit - TimeUnit for the timeout time.

Throws:

TimeoutException - If the timeout time passed and still not seeing that many count.

InterruptedException

waitForException

void waitForException(long count,
                      long timeout,
                      TimeUnit timeoutUnit)
               throws TimeoutException,
                      InterruptedException

Waits until at least the given number of exceptions has been raised.

Parameters:

count - Number of exceptions to wait for

timeout - Maximum time to wait for

timeoutUnit - TimeUnit for the timeout time.

Throws:

TimeoutException - If the timeout time passed and still not seeing that many count.

InterruptedException

waitFor

void waitFor(String name,
             long count,
             long timeout,
             TimeUnit timeoutUnit)
      throws TimeoutException,
             InterruptedException

Waits until the metric value of the given metric name reached or exceeded the given count.

Parameters:

name - Name of the metric

count - Minimum value to wait for

timeout - Maximum time to wait for

timeoutUnit - TimeUnit for the timeout time.

Throws:

TimeoutException - If the timeout time passed and still not seeing that many count.

InterruptedException