kieker.common.record

Interface IMonitoringRecord

All Superinterfaces:

java.lang.Comparable<IMonitoringRecord>, java.io.Serializable

All Known Subinterfaces:

ICallObjectRecord, ICallRecord, IClassSignature, IConstructorRecord, IEventRecord, IExceptionRecord, IFlowRecord, IInterfaceRecord, IObjectRecord, IOperationRecord, IOperationSignature, IThreadBasedRecord, ITraceRecord

All Known Implementing Classes:

AbstractEvent, AbstractJVMRecord, AbstractMonitorEvent, AbstractMonitoringRecord, AbstractOperationEvent, AbstractThreadBasedEvent, AbstractTraceEvent, AfterConstructorEvent, AfterConstructorFailedEvent, AfterConstructorFailedObjectEvent, AfterConstructorObjectEvent, AfterFailedThreadBasedEvent, AfterOperationEvent, AfterOperationFailedEvent, AfterOperationFailedObjectEvent, AfterOperationObjectEvent, AfterThreadBasedEvent, AggregationWindow, BeforeConstructorEvent, BeforeConstructorObjectEvent, BeforeConstructorObjectInterfaceEvent, BeforeOperationEvent, BeforeOperationObjectEvent, BeforeOperationObjectInterfaceEvent, BeforeThreadBasedEvent, BranchingRecord, CallConstructorEvent, CallConstructorObjectEvent, CallOperationEvent, CallOperationObjectEvent, ClassLoadingRecord, CompilationRecord, ConstructionEvent, CPUUtilizationRecord, DiskUsageRecord, EmptyRecord, ExtendedStorableDetectionResult, GCRecord, HostApplicationMetaData, JoinEvent, KiekerMetadataRecord, LoadAverageRecord, MemoryRecord, MemSwapUsageRecord, MonitorEntryEvent, MonitorExitEvent, MonitorNotifyAllEvent, MonitorNotifyEvent, MonitorRequestEvent, MonitorWaitEvent, NamedDoubleRecord, NamedTSPoint, NetworkUtilizationRecord, OperationExecutionRecord, RegistryRecord, ResourceUtilizationRecord, SplitEvent, StorableDetectionResult, ThreadMetaData, ThreadsStatusRecord, TimestampRecord, TraceMetadata, UptimeRecord

public interface IMonitoringRecord
extends java.io.Serializable, java.lang.Comparable<IMonitoringRecord>

All Kieker monitoring records have to implement this minimal interface.

Warning: Objects within records should not contain ';', '\n', or '\r' in their respective toString() representation.

Since:

1.2

Author:

Andre van Hoorn, Jan Waller

See Also:

IMonitoringRecord.Factory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IMonitoringRecord.BinaryFactory Any record that implements this interface has to conform to certain specifications.
static interface	IMonitoringRecord.Factory Any record that implements this interface has to conform to certain specifications.

Method Summary

Methods

Modifier and Type	Method and Description
long	getLoggingTimestamp() Delivers the current timestamp of the record.
int	getSize() Deprecated. since 1.13 (to be removed in 1.14) With the introduction of value serializers, this method has become obsolete.
java.lang.String[]	getValueNames() This method delivers an array containing the value names of the record.
java.lang.Class<?>[]	getValueTypes() This method delivers an array with the classes of the single values for the record.
void	initFromArray(java.lang.Object[] values) This method should initialize the record based on the given values.
void	registerStrings(IRegistry<java.lang.String> stringRegistry) Deprecated. since 1.13 (to be removed in 1.14): Is unnecessary when using the new, serializer-based output.
void	serialize(IValueSerializer serializer) This method serializes this record using the given serializer.
void	setLoggingTimestamp(long timestamp) Sets the logging timestamp to a new value.
java.lang.Object[]	toArray() This method should deliver an array containing the content of the record.
java.lang.String	toString() Creates a string representation of this record. This method should not be used for serialization purposes since this is not the purpose of Object's toString method.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getLoggingTimestamp

long getLoggingTimestamp()

Delivers the current timestamp of the record.

Returns:

The timestamp.

Since:

1.2

setLoggingTimestamp

void setLoggingTimestamp(long timestamp)

Sets the logging timestamp to a new value.

Parameters:

timestamp - The new timestamp for the record.

Since:

1.2

toString

java.lang.String toString()

Creates a string representation of this record.

This method should not be used for serialization purposes since this is not the purpose of Object's toString method.

Overrides:

toString in class java.lang.Object

Returns:

A (human readable) string of this record.

Since:

1.5

toArray

java.lang.Object[] toArray()

This method should deliver an array containing the content of the record. It should be possible to convert this array later into a record again.

Returns:

An array with the values of the record.

Since:

1.2

registerStrings

@Deprecated
void registerStrings(IRegistry<java.lang.String> stringRegistry)

Deprecated. since 1.13 (to be removed in 1.14): Is unnecessary when using the new, serializer-based output.

Registers the string attributes of the record at the given stringRegistry.

Since:

1.11

serialize

void serialize(IValueSerializer serializer)
               throws java.nio.BufferOverflowException

This method serializes this record using the given serializer.

Parameters:

serializer - The serializer to serialize the record with. *

Throws:

java.nio.BufferOverflowException - If the underlying buffer has insufficient capacity to store this record

Since:

1.13

initFromArray

void initFromArray(java.lang.Object[] values)

This method should initialize the record based on the given values. The array should be one of those resulting from a call to toArray().

Parameters:

values - The values for the record.

Since:

1.2

getValueTypes

java.lang.Class<?>[] getValueTypes()

This method delivers an array with the classes of the single values for the record.

Returns:

The types of the values. This returned array should be treated readonly.

Since:

1.2

See Also:

toArray()

getValueNames

java.lang.String[] getValueNames()

This method delivers an array containing the value names of the record.

Returns:

The types of the values. This returned array should be treated readonly.

Since:

1.2

See Also:

toArray()

getSize

int getSize()

Deprecated. since 1.13 (to be removed in 1.14) With the introduction of value serializers, this method has become obsolete.

This method should deliver the size of a binary representation of this record.

Returns:

The size.

Since:

1.8