Package kieker.common.record.flow.trace

Class TraceMetadata

java.lang.Object

kieker.common.record.AbstractMonitoringRecord

kieker.common.record.flow.trace.TraceMetadata

All Implemented Interfaces:

Serializable, Comparable<IMonitoringRecord>, IFlowRecord, IMonitoringRecord

Direct Known Subclasses:

ApplicationTraceMetadata

public class TraceMetadata
extends AbstractMonitoringRecord
implements IFlowRecord

Since:

1.5

Author:

Jan Waller API compatibility: Kieker 1.15.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HOSTNAME
static final int	NEXT_ORDER_ID
static final String	NO_HOSTNAME
static final int	NO_PARENT_ORDER_INDEX
static final long	NO_PARENT_TRACEID	user-defined constants.
static final String	NO_SESSION_ID
static final int	PARENT_ORDER_ID
static final long	PARENT_TRACE_ID
static final String	SESSION_ID
static final int	SIZE	Descriptive definition of the serialization size of the record.
static final long	THREAD_ID
static final long	TRACE_ID	default constants.
static final Class<?>[]	TYPES
static final String[]	VALUE_NAMES	property name array.

Fields inherited from class kieker.common.record.AbstractMonitoringRecord

TYPE_SIZE_BOOLEAN, TYPE_SIZE_BYTE, TYPE_SIZE_CHARACTER, TYPE_SIZE_DOUBLE, TYPE_SIZE_FLOAT, TYPE_SIZE_INT, TYPE_SIZE_LONG, TYPE_SIZE_SHORT, TYPE_SIZE_STRING

Constructor Summary

Constructors

Constructor	Description
TraceMetadata(long traceId, long threadId, String sessionId, String hostname, long parentTraceId, int parentOrderId)	Creates a new instance of this class using the given parameters.
TraceMetadata(IValueDeserializer deserializer)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Performs a null-check, a this-check, and a class-check.
final String	getHostname()
final int	getNextOrderId()
final int	getParentOrderId()
final long	getParentTraceId()
final String	getSessionId()
int	getSize()	This method should deliver the size of a binary representation of this record.
final long	getThreadId()
final long	getTraceId()
String[]	getValueNames()	This method delivers an array containing the value names of the record.
Class<?>[]	getValueTypes()	This method delivers an array with the classes of the single values for the record.
int	hashCode()
void	serialize(IValueSerializer serializer)	This method serializes this record using the given serializer.
final void	setTraceId(long traceId)
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 class kieker.common.record.AbstractMonitoringRecord

checkArray, classForName, compareTo, createFromDeserializer, fromStringArrayToTypedArray2, getLoggingTimestamp, isNotEqual, isNotEqual, setLoggingTimestamp, typesForClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface kieker.common.record.IMonitoringRecord

getLoggingTimestamp, setLoggingTimestamp

Field Details

SIZE

public static final int SIZE

Descriptive definition of the serialization size of the record.

See Also:

• Constant Field Values

TYPES

public static final Class<?>[] TYPES

NO_PARENT_TRACEID

public static final long NO_PARENT_TRACEID

user-defined constants.

See Also:

• Constant Field Values

NO_PARENT_ORDER_INDEX

public static final int NO_PARENT_ORDER_INDEX

See Also:

• Constant Field Values

NO_SESSION_ID

public static final String NO_SESSION_ID

See Also:

• Constant Field Values

NO_HOSTNAME

public static final String NO_HOSTNAME

See Also:

• Constant Field Values

VALUE_NAMES

public static final String[] VALUE_NAMES

property name array.

TRACE_ID

public static final long TRACE_ID

default constants.

See Also:

• Constant Field Values

THREAD_ID

public static final long THREAD_ID

See Also:

• Constant Field Values

SESSION_ID

public static final String SESSION_ID

See Also:

• Constant Field Values

HOSTNAME

public static final String HOSTNAME

See Also:

• Constant Field Values

PARENT_TRACE_ID

public static final long PARENT_TRACE_ID

See Also:

• Constant Field Values

PARENT_ORDER_ID

public static final int PARENT_ORDER_ID

See Also:

• Constant Field Values

NEXT_ORDER_ID

public static final int NEXT_ORDER_ID

See Also:

• Constant Field Values

Constructor Details

TraceMetadata

public TraceMetadata(long traceId,
 long threadId,
 String sessionId,
 String hostname,
 long parentTraceId,
 int parentOrderId)

Creates a new instance of this class using the given parameters.

Parameters:

traceId - traceId

threadId - threadId

sessionId - sessionId

hostname - hostname

parentTraceId - parentTraceId

parentOrderId - parentOrderId

TraceMetadata

public TraceMetadata(IValueDeserializer deserializer)
              throws RecordInstantiationException

Parameters:

deserializer - The deserializer to use

Throws:

RecordInstantiationException - when the record could not be deserialized

Method Details

serialize

public void serialize(IValueSerializer serializer)
               throws BufferOverflowException

This method serializes this record using the given serializer.

Specified by:

serialize in interface IMonitoringRecord

Parameters:

serializer - The serializer to serialize the record with. *

Throws:

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

getValueTypes

public Class<?>[] getValueTypes()

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

Specified by:

getValueTypes in interface IMonitoringRecord

Returns:

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

getValueNames

public String[] getValueNames()

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

Specified by:

getValueNames in interface IMonitoringRecord

Returns:

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

getSize

public int getSize()

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

Specified by:

getSize in interface IMonitoringRecord

Returns:

The size.

equals

public boolean equals(Object obj)

Performs a null-check, a this-check, and a class-check. Moreover, it checks each attribute for equality.

Overrides:

equals in class AbstractMonitoringRecord

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMonitoringRecord

getTraceId

public final long getTraceId()

setTraceId

public final void setTraceId(long traceId)

getThreadId

public final long getThreadId()

getSessionId

public final String getSessionId()

getHostname

public final String getHostname()

getParentTraceId

public final long getParentTraceId()

getParentOrderId

public final int getParentOrderId()

getNextOrderId

public final int getNextOrderId()

toString

public 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.

Specified by:

toString in interface IMonitoringRecord

Overrides:

toString in class Object

Returns:

A (human readable) string of this record.