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:

Serializable

Direct Known Subclasses:

Meter

public class MeterData
extends SystemData

Augments the SystemData with start, stop, failure and path information for an operation measured by Meter.

Author:

Daniel Felix Ferber

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	category Name of the category that the operation being measured belongs to.
protected Map<String,String>	context Additional meta data describing the job.
protected long	createTime Timestamp when the operation was created/scheduled (nanoseconds).
protected long	currentIteration How many iterations were run by the operation.
protected String	description An arbitrary short, human readable message to describe the operation being measured.
static char	DETAILED_MESSAGE_PREFIX
static String	EVENT_CATEGORY
static String	EVENT_NAME
static String	EVENT_PARENT
protected long	expectedIterations How many iterations were expected by the operation.
protected String	failMessage For failed execution, an optional message that caused the failure.
protected String	failPath For failed execution, the string that identifies the failure caused.
protected String	okPath For successful execution, the string that identifies the execution path.
protected String	operation Name of the operation.
protected String	parent If the Meter was created as a child for another Meter, references category name, operation name and position of these other Meter.
static String	PROP_CONTEXT
static String	PROP_CREATE_TIME
static String	PROP_DESCRIPTION
static String	PROP_EXPECTED_ITERATION
static String	PROP_FAIL_ID
static String	PROP_ITERATION
static String	PROP_LIMIT_TIME
static String	PROP_PATH_ID
static String	PROP_REJECT_ID
static String	PROP_START_TIME
static String	PROP_STOP_TIME
protected String	rejectPath For rejected execution, the string that identifies the rejection cause.
protected long	startTime Timestamp when the operation started execution (nanoseconds).
protected long	stopTime Timestamp when the operation finished execution (either success, rejection or failure) (nanoseconds).
protected long	timeLimit Time limit considered reasonable for successful execution of the operation (nanoseconds).

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, PROP_CLASS_LOADING, PROP_COMPILATION_TIME, PROP_FINALIZATION_COUNT, PROP_GARBAGE_COLLECTOR, PROP_HEAP, PROP_MEMORY, PROP_NON_HEAP, PROP_SYSTEM_LOAD, runtime_maxMemory, runtime_totalMemory, runtime_usedMemory, systemLoad

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

EVENT_POSITION, EVENT_TIME, position, SESSION_UUID, sessionUuid, time

Constructor Summary

Constructors

Modifier	Constructor and Description
	MeterData()
	MeterData(String uuid)
	MeterData(String sessionUuid, long position, long time, long heap_commited, long heap_max, long heap_used, long nonHeap_commited, long nonHeap_max, long nonHeap_used, long objectPendingFinalizationCount, long classLoading_loaded, long classLoading_total, long classLoading_unloaded, long compilationTime, long garbageCollector_count, long garbageCollector_time, long runtime_usedMemory, long runtime_maxMemory, long runtime_totalMemory, double systemLoad, String category, String operation, String parent, String description, long createTime, long startTime, long stopTime, long timeLimit, long currentIteration, long expectedIterations, String okPath, String rejectPath, String failPath, String failMessage, Map<String,String> context)
protected	MeterData(String uuid, long position, String category, String operation, String parent)

Method Summary

Modifier and Type	Method and Description
protected void	collectRuntimeStatus()
boolean	equals(Object o)
Map<String,String>	getContext()
long	getExecutionTime()
String	getFullID()
double	getIterationsPerSecond()
String	getPath()
long	getWaitingTime()
int	hashCode()
boolean	isFail()
boolean	isOK()
boolean	isReject()
boolean	isSlow()
boolean	isStarted()
boolean	isStopped()
StringBuilder	readableStringBuilder(StringBuilder builder) Writes a concise, human readable string representation of the event into the supplied StringBuilder.
protected void	resetImpl() Subclasses shall provide an implementation that resets its specific properties to their constructor initial value.
void	writeJson5Impl(StringBuilder sb)

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

collectManagedBeanStatus, collectPlatformStatus, readJson5

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

encodedMessage, json5Message, readableMessage, reset, writeJson5

Methods inherited from class java.lang.Object

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

Field Detail

DETAILED_MESSAGE_PREFIX

public static final char DETAILED_MESSAGE_PREFIX

See Also:

Constant Field Values

category

protected String category

Name of the category that the operation being measured belongs to. By default, it is the last name of the logger.

operation

protected String operation

Name of the operation. May be null if the category already describes the operation itself.

parent

protected String parent

If the Meter was created as a child for another Meter, references category name, operation name and position of these other Meter. Null otherwise.

description

protected String description

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

createTime

protected long createTime

Timestamp when the operation was created/scheduled (nanoseconds).

startTime

protected long startTime

Timestamp when the operation started execution (nanoseconds). Zero if the operation has not yet started.

stopTime

protected long stopTime

Timestamp when the operation finished execution (either success, rejection or failure) (nanoseconds). Zero if the operation has not yet finished.

timeLimit

protected long timeLimit

Time limit considered reasonable for successful execution of the operation (nanoseconds). Zero if there is no time limit for the operation.

currentIteration

protected long currentIteration

How many iterations were run by the operation. Zero if no iteration has yet run.

expectedIterations

protected long expectedIterations

How many iterations were expected by the operation. Zero if no iterations were expected.

okPath

protected String okPath

For successful execution, the string that identifies the execution path. Mutually exclusive with rejectPath and failPath. Set only when operation finishes with success and a path was given.

rejectPath

protected String rejectPath

For rejected execution, the string that identifies the rejection cause. Mutually exclusive with okPath and failPath. Set only when operation finishes with rejection.

failPath

protected String failPath

For failed execution, the string that identifies the failure caused. Usually, the class name of the exception that describes the failure. Mutually exclusive with okPath and rejectPath. Set only when operation finishes with failure.

failMessage

protected String failMessage

For failed execution, an optional message that caused the failure. Usually, the message of the exception. Only set in conjuction with failPath.

context

protected Map<String,String> context

Additional meta data describing the job.

PROP_DESCRIPTION

public static final String PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_PATH_ID

public static final String PROP_PATH_ID

See Also:

Constant Field Values

PROP_REJECT_ID

public static final String PROP_REJECT_ID

See Also:

Constant Field Values

PROP_FAIL_ID

public static final String PROP_FAIL_ID

See Also:

Constant Field Values

PROP_CREATE_TIME

public static final String PROP_CREATE_TIME

See Also:

Constant Field Values

PROP_START_TIME

public static final String PROP_START_TIME

See Also:

Constant Field Values

PROP_STOP_TIME

public static final String PROP_STOP_TIME

See Also:

Constant Field Values

PROP_ITERATION

public static final String PROP_ITERATION

See Also:

Constant Field Values

PROP_EXPECTED_ITERATION

public static final String PROP_EXPECTED_ITERATION

See Also:

Constant Field Values

PROP_LIMIT_TIME

public static final String PROP_LIMIT_TIME

See Also:

Constant Field Values

PROP_CONTEXT

public static final String PROP_CONTEXT

See Also:

Constant Field Values

EVENT_CATEGORY

public static final String EVENT_CATEGORY

See Also:

Constant Field Values

EVENT_NAME

public static final String EVENT_NAME

See Also:

Constant Field Values

EVENT_PARENT

public static final String EVENT_PARENT

See Also:

Constant Field Values

Constructor Detail

MeterData

public MeterData()

MeterData

public MeterData(String uuid)

MeterData

protected MeterData(String uuid,
                    long position,
                    String category,
                    String operation,
                    String parent)

MeterData

public MeterData(String sessionUuid,
                 long position,
                 long time,
                 long heap_commited,
                 long heap_max,
                 long heap_used,
                 long nonHeap_commited,
                 long nonHeap_max,
                 long nonHeap_used,
                 long objectPendingFinalizationCount,
                 long classLoading_loaded,
                 long classLoading_total,
                 long classLoading_unloaded,
                 long compilationTime,
                 long garbageCollector_count,
                 long garbageCollector_time,
                 long runtime_usedMemory,
                 long runtime_maxMemory,
                 long runtime_totalMemory,
                 double systemLoad,
                 String category,
                 String operation,
                 String parent,
                 String description,
                 long createTime,
                 long startTime,
                 long stopTime,
                 long timeLimit,
                 long currentIteration,
                 long expectedIterations,
                 String okPath,
                 String rejectPath,
                 String failPath,
                 String failMessage,
                 Map<String,String> context)

Method Detail

getFullID

public String getFullID()

isStarted

public boolean isStarted()

isStopped

public boolean isStopped()

isOK

public boolean isOK()

isReject

public boolean isReject()

isFail

public boolean isFail()

getContext

public Map<String,String> getContext()

isSlow

public boolean isSlow()

Returns:

If the operation execution time has exceeded (finished execution) or is exceeding (ongoing execution) the time limit.

getPath

public String getPath()

getExecutionTime

public long getExecutionTime()

Returns:

The execution time after start (until stop for finished or until now for ongoing execution).

getWaitingTime

public long getWaitingTime()

Returns:

The waiting time since Meter was created and before it was started.

getIterationsPerSecond

public double getIterationsPerSecond()

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

collectRuntimeStatus

protected void collectRuntimeStatus()

Overrides:

collectRuntimeStatus in class SystemData

readableStringBuilder

public StringBuilder readableStringBuilder(StringBuilder builder)

Description copied from class: EventData

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

Specified by:

readableStringBuilder in class EventData

Parameters:

builder - The StringBuilder that receives the string representation

Returns:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

writeJson5Impl

public void writeJson5Impl(StringBuilder sb)

Overrides:

writeJson5Impl in class SystemData