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, IParameterValueEvent, IRemoteControlEvent, IRemoteParameterControlEvent, IThreadBasedRecord, ITraceRecord

All Known Implementing Classes:

AbstractEvent, AbstractJVMRecord, AbstractMonitorEvent, AbstractMonitoringRecord, AbstractOperationEvent, AbstractThreadBasedEvent, AbstractTraceEvent, ActivationEvent, ActivationParameterEvent, AddParameterValueEvent, AfterConstructorEvent, AfterConstructorFailedEvent, AfterConstructorFailedObjectEvent, AfterConstructorObjectEvent, AfterDatabaseEvent, AfterFailedThreadBasedEvent, AfterOperationEvent, AfterOperationFailedEvent, AfterOperationFailedObjectEvent, AfterOperationObjectEvent, AfterThreadBasedEvent, ApplicationTraceMetadata, BeforeConstructorEvent, BeforeConstructorObjectEvent, BeforeConstructorObjectInterfaceEvent, BeforeDatabaseEvent, BeforeOperationEvent, BeforeOperationObjectEvent, BeforeOperationObjectInterfaceEvent, BeforeReceivedRemoteEvent, BeforeSentRemoteEvent, BeforeThreadBasedEvent, BranchingRecord, CallConstructorEvent, CallConstructorObjectEvent, CallOperationEvent, CallOperationObjectEvent, ClassLoadingRecord, CompilationRecord, ConstructionEvent, CPUUtilizationRecord, DatabaseFailedEvent, DeactivationEvent, DiskUsageRecord, EmptyRecord, GCRecord, HostApplicationMetaData, JoinEvent, KiekerMetadataRecord, LoadAverageRecord, MemoryRecord, MemSwapUsageRecord, MonitorEntryEvent, MonitorExitEvent, MonitorNotifyAllEvent, MonitorNotifyEvent, MonitorRequestEvent, MonitorWaitEvent, NetworkUtilizationRecord, OperationExecutionRecord, RegistryRecord, RemoveParameterValueEvent, ResourceUtilizationRecord, SplitEvent, ThreadMetaData, ThreadsStatusRecord, TimestampRecord, TraceMetadata, UpdateParameterEvent, 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:

Factory

Method Summary

Modifier and Type	Method and Description
long	getLoggingTimestamp() Delivers the current timestamp of the record.
int	getSize() This method should deliver the size of a binary representation of this record.
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	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.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

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

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

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

getSize

int getSize()

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

Returns:

The size.

Since:

1.8 might be deprecated since 1.13 removal must be reassessed. Size is relevant for binary deserialization with predefined array sizes. (to be removed in 1.14) With the introduction of value serializers, this method has become obsolete.