org.usefultoys.slf4j.meter

Class MeterData

java.lang.Object

org.usefultoys.slf4j.internal.EventData

org.usefultoys.slf4j.internal.SystemData

org.usefultoys.slf4j.meter.MeterData

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Meter

public class MeterData
extends SystemData

Augments the SystemData with start, stop, failure and flow information measured by Meter.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	context Additional meta data describing the job.
protected long	createTime When the job was created/scheduled.
protected java.lang.String	description An arbitrary short, human readable message to describe the task being measured.
static char	DETAILED_MESSAGE_PREFIX
protected long	expectedIterations How many iteration were expected by the operation.
protected java.lang.String	failClass For failure result, the exception class that caused the failure.
protected java.lang.String	failMessage For failure result, the exception message that caused the failure.
protected long	iteration How many iterations were run by the operation.
protected java.lang.String	pathId For successful execution, the string token that identifies the execution pathId.
protected static java.lang.String	PROP_CONTEXT
protected static java.lang.String	PROP_CREATE_TIME
protected static java.lang.String	PROP_DESCRIPTION
protected static java.lang.String	PROP_EXPECTED_ITERATION
protected static java.lang.String	PROP_FAIL_ID
protected static java.lang.String	PROP_ITERATION
protected static java.lang.String	PROP_LIMIT_TIME
protected static java.lang.String	PROP_PATH_ID
protected static java.lang.String	PROP_REJECT_ID
protected static java.lang.String	PROP_START_TIME
protected static java.lang.String	PROP_STOP_TIME
protected static java.lang.String	PROP_THREAD
protected java.lang.String	rejectId For rejected execution, the string token that identifies the rejection cause.
protected long	startTime When the job started execution.
protected long	stopTime When the job finished execution.
protected long	timeLimitNanoseconds Time considered reasonable for successful execution.

Fields inherited from class org.usefultoys.slf4j.internal.SystemData

classLoading_loaded, classLoading_total, classLoading_unloaded, compilationTime, garbageCollector_count, garbageCollector_time, heap_commited, heap_max, heap_used, nonHeap_commited, nonHeap_max, nonHeap_used, objectPendingFinalizationCount, runtime_maxMemory, runtime_totalMemory, runtime_usedMemory, systemLoad

Fields inherited from class org.usefultoys.slf4j.internal.EventData

EVENT_CATEGORY, EVENT_NAME, EVENT_POSITION, eventCategory, eventName, eventPosition, SESSION_UUID, sessionUuid, time

Constructor Summary

Constructors

Constructor and Description
MeterData()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getContext()
long	getCreateTime()
long	getCurrentIteration()
java.lang.String	getDescription()
java.lang.String	getExceptionClass()
java.lang.String	getExceptionMessage()
long	getExecutionTime()
long	getExpectedIterations()
double	getIterationsPerSecond()
java.lang.String	getPathId()
java.lang.String	getRejectId()
long	getStartTime()
long	getStopTime()
long	getTimeLimitNanoseconds()
long	getWaitingTime()
protected boolean	isCompletelyEqualsImpl(EventData obj) Subclasses shall provide an implementation that compares its specific properties to the respective properties of the other instance given as argument.
boolean	isFail()
boolean	isOK()
boolean	isReject()
boolean	isSlow()
boolean	isStarted()
boolean	isStopped()
boolean	read(java.lang.String message)
java.lang.StringBuilder	readableString(java.lang.StringBuilder buffer) Writes a concise, human readable string representation of the event into the supplied StringBuilder.
java.lang.String	readableWrite()
protected boolean	readPropertyImpl(EventReader r, java.lang.String propertyName) Subclasses shall provide an implementation that reads its specific properties from the encoded string representation.
protected void	resetImpl() Subclasses shall provide an implementation that resets its specific properties to their constructor initial value.
java.lang.String	write()
void	writePropertiesImpl(EventWriter w) Subclasses shall provide an implementation that appends its specific properties to the encoded string representation.

Methods inherited from class org.usefultoys.slf4j.internal.SystemData

collectManagedBeanStatus, collectPlatformStatus, collectRuntimeStatus

Methods inherited from class org.usefultoys.slf4j.internal.EventData

equals, getEventCategory, getEventName, getEventPosition, getFullID, getSessionUuid, getTime, hashCode, isCompletelyEqualsTo, isSameAs, read, reset, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DETAILED_MESSAGE_PREFIX

public static final char DETAILED_MESSAGE_PREFIX

See Also:

Constant Field Values

description

protected java.lang.String description

An arbitrary short, human readable message to describe the task being measured.

pathId

protected java.lang.String pathId

For successful execution, the string token that identifies the execution pathId.

rejectId

protected java.lang.String rejectId

For rejected execution, the string token that identifies the rejection cause.

createTime

protected long createTime

When the job was created/scheduled.

startTime

protected long startTime

When the job started execution.

stopTime

protected long stopTime

When the job finished execution.

iteration

protected long iteration

How many iterations were run by the operation.

expectedIterations

protected long expectedIterations

How many iteration were expected by the operation.

failClass

protected java.lang.String failClass

For failure result, the exception class that caused the failure.

failMessage

protected java.lang.String failMessage

For failure result, the exception message that caused the failure.

timeLimitNanoseconds

protected long timeLimitNanoseconds

Time considered reasonable for successful execution.

context

protected java.util.Map<java.lang.String,java.lang.String> context

Additional meta data describing the job.

PROP_DESCRIPTION

protected static final java.lang.String PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_PATH_ID

protected static final java.lang.String PROP_PATH_ID

See Also:

Constant Field Values

PROP_REJECT_ID

protected static final java.lang.String PROP_REJECT_ID

See Also:

Constant Field Values

PROP_FAIL_ID

protected static final java.lang.String PROP_FAIL_ID

See Also:

Constant Field Values

PROP_CREATE_TIME

protected static final java.lang.String PROP_CREATE_TIME

See Also:

Constant Field Values

PROP_START_TIME

protected static final java.lang.String PROP_START_TIME

See Also:

Constant Field Values

PROP_STOP_TIME

protected static final java.lang.String PROP_STOP_TIME

See Also:

Constant Field Values

PROP_ITERATION

protected static final java.lang.String PROP_ITERATION

See Also:

Constant Field Values

PROP_EXPECTED_ITERATION

protected static final java.lang.String PROP_EXPECTED_ITERATION

See Also:

Constant Field Values

PROP_LIMIT_TIME

protected static final java.lang.String PROP_LIMIT_TIME

See Also:

Constant Field Values

PROP_THREAD

protected static final java.lang.String PROP_THREAD

See Also:

Constant Field Values

PROP_CONTEXT

protected static final java.lang.String PROP_CONTEXT

See Also:

Constant Field Values

Constructor Detail

MeterData

public MeterData()

Method Detail

getDescription

public java.lang.String getDescription()

getPathId

public java.lang.String getPathId()

getRejectId

public java.lang.String getRejectId()

getCreateTime

public long getCreateTime()

getStartTime

public long getStartTime()

getStopTime

public long getStopTime()

getCurrentIteration

public long getCurrentIteration()

getExpectedIterations

public long getExpectedIterations()

getExceptionClass

public java.lang.String getExceptionClass()

getExceptionMessage

public java.lang.String getExceptionMessage()

isStarted

public boolean isStarted()

isStopped

public boolean isStopped()

isOK

public boolean isOK()

isReject

public boolean isReject()

isFail

public boolean isFail()

getTimeLimitNanoseconds

public long getTimeLimitNanoseconds()

getContext

public java.util.Map<java.lang.String,java.lang.String> getContext()

resetImpl

protected void resetImpl()

Description copied from class: EventData

Subclasses shall provide an implementation that resets its specific properties to their constructor initial value. This method is called once and shall compare all specific properties.

Overrides:

resetImpl in class SystemData

isCompletelyEqualsImpl

protected boolean isCompletelyEqualsImpl(EventData obj)

Description copied from class: EventData

Subclasses shall provide an implementation that compares its specific properties to the respective properties of the other instance given as argument. This method is called once and shall compare all specific properties.

Overrides:

isCompletelyEqualsImpl in class SystemData

Parameters:

obj - the other EventData instance been compared to.

Returns:

true if all specific properties are equal on the other instance, false otherwise.

readableString

public java.lang.StringBuilder readableString(java.lang.StringBuilder buffer)

Description copied from class: EventData

Writes a concise, human readable string representation of the event into the supplied StringBuilder.

Specified by:

readableString in class EventData

Parameters:

buffer - The StringBuilder that receives the string representation

Returns:

The StringBuilder passed as argument to allow chained StringBuilder method calls.

isSlow

public boolean isSlow()

getExecutionTime

public long getExecutionTime()

getWaitingTime

public long getWaitingTime()

getIterationsPerSecond

public double getIterationsPerSecond()

writePropertiesImpl

public void writePropertiesImpl(EventWriter w)

Description copied from class: EventData

Subclasses shall provide an implementation that appends its specific properties to the encoded string representation. This method is called once and shall append all specific properties using the EventWriter.

Overrides:

writePropertiesImpl in class SystemData

Parameters:

w - The EventWriter that encodes the properties.

readPropertyImpl

protected boolean readPropertyImpl(EventReader r,
                                   java.lang.String propertyName)
                            throws java.io.IOException

Description copied from class: EventData

Subclasses shall provide an implementation that reads its specific properties from the encoded string representation. This method is called for each encoded property.

Overrides:

readPropertyImpl in class SystemData

Parameters:

r - The EventReader that is parsing the message. Use this parser to retrieve the property value.

propertyName - The property key.

Returns:

true if the property key was recognized, false otherwise.

Throws:

java.io.IOException - the EventReader failed to parse the encoded property value.

read

public final boolean read(java.lang.String message)

write

public final java.lang.String write()

readableWrite

public final java.lang.String readableWrite()