net.shibboleth.idp.log

Class PerformanceEvent

java.lang.Object

net.shibboleth.idp.log.BaseEvent

net.shibboleth.idp.log.PerformanceEvent

@NotThreadSafe
public class PerformanceEvent
extends BaseEvent

An event recording the performance of some operation. This event produces an event string with the following format: operation|starTime|stopTime|elapsedTime|operationSuccess|message where all times are given in milliseconds, start and stop times are milliseconds since the epoch, and operation success is a 1 or 0.

Field Summary

Fields

Modifier and Type	Field and Description
private long	elapsedTime Total elapsed time, in milliseconds, of the operation.
static String	EVENT_TYPE Type for a performance event.
private static String	FIELD_SEPERATOR Character used to separate the fields of the event.
private String	operation Identifier of the operation being timed.
private long	startTime System local time in milliseconds when the performance measurement started.
private long	stopTime System local time in milliseconds when the performance measurement stopped.
private boolean	successfulOperation Whether the operation completed successfully or failed.

Constructor Summary

Constructors

Constructor and Description
PerformanceEvent(String operationId) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
long	getElapsedTime() Gets the total elapsed time, in milliseconds, of the operation.
String	getOperation() Gets the operation being timed.
long	getStartTime() Gets the system local time in milliseconds when the performance measurement started.
long	getStopTime() Gets the System local time in milliseconds when the performance measurement stopped.
String	getType() Gets the type of event.
boolean	isOperationSuccessful() Gets whether the operation was successful.
void	startTime() Records the timer of the operation.
void	stopTime(boolean wasSuccess) Records the completion time of the operation and whether the operation was successful.
String	toString()

Methods inherited from class net.shibboleth.idp.log.BaseEvent

getMessage, setMessage

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_TYPE

public static final String EVENT_TYPE

Type for a performance event.

See Also:

Constant Field Values

FIELD_SEPERATOR

private static final String FIELD_SEPERATOR

Character used to separate the fields of the event.

See Also:

Constant Field Values

operation

private String operation

Identifier of the operation being timed.

successfulOperation

private boolean successfulOperation

Whether the operation completed successfully or failed.

startTime

private long startTime

System local time in milliseconds when the performance measurement started.

stopTime

private long stopTime

System local time in milliseconds when the performance measurement stopped.

elapsedTime

private long elapsedTime

Total elapsed time, in milliseconds, of the operation.

Constructor Detail

PerformanceEvent

public PerformanceEvent(String operationId)

Constructor.

Parameters:

operationId - unique ID of the operation, must never be null or empty

Method Detail

getType

public String getType()

Gets the type of event.

Specified by:

getType in class BaseEvent

Returns:

the type of the event, used to help determine which log will receive the event.

getOperation

public String getOperation()

Gets the operation being timed.

Returns:

operation being timed

isOperationSuccessful

public boolean isOperationSuccessful()

Gets whether the operation was successful.

Returns:

whether the operation was successful

startTime

public void startTime()

Records the timer of the operation. May not be called more than one per event.

getStartTime

public long getStartTime()

Gets the system local time in milliseconds when the performance measurement started.

Returns:

start time of the operation or -1 if startTime() has not been called yet

stopTime

public void stopTime(boolean wasSuccess)

Records the completion time of the operation and whether the operation was successful.

Parameters:

wasSuccess - whether the operation completed successfully

getStopTime

public long getStopTime()

Gets the System local time in milliseconds when the performance measurement stopped.

Returns:

completion time of the operation or -1 if the stopTime(boolean) has not been called yet

getElapsedTime

public long getElapsedTime()

Gets the total elapsed time, in milliseconds, of the operation.

Returns:

total elapsed time, in milliseconds, of the operation or -1 if stopTime(boolean) has not been called yet

toString

public String toString()

Overrides:

toString in class Object