org.avaje.metric

Interface TimedEvent

public interface TimedEvent

A TimedEvent that is ended with either success or error.

Note that it is generally preferred to use TimedMetric.addEventSince(boolean, long) as that avoids an object creation and the associated GC so has slightly less overhead.

Example:

 
  TimedMetric metric = MetricManager.getTimedMetric(MyService.class, "sayHello");
  ...
  
  TimedEvent timedEvent = metric.startEvent();
  try {
    ...
  
  } finally {
    // Add the event to the 'success' statistics
    timedEvent.endWithSuccess();
  }
  
 
 

See Also:

TimedMetric.startEvent()

Method Summary

Methods

Modifier and Type	Method and Description
void	end(boolean withSuccess) End specifying whether the event was successful or in error.
void	endWithError() This timed event ended with an error or fault execution (e.g.
void	endWithSuccess() This timed event ended with successful execution (e.g.

Method Detail

end

void end(boolean withSuccess)

End specifying whether the event was successful or in error.

endWithSuccess

void endWithSuccess()

This timed event ended with successful execution (e.g. Successful SOAP Operation or SQL execution).

endWithError

void endWithError()

This timed event ended with an error or fault execution (e.g. SOAP Fault or SQL exception).