io.opentelemetry.extensions.trace

Class MessageEvent

java.lang.Object

io.opentelemetry.extensions.trace.MessageEvent

All Implemented Interfaces:

io.opentelemetry.trace.Event

@Immutable
public final class MessageEvent
extends Object
implements io.opentelemetry.trace.Event

A class that represents a generic messaging event. This class can represent messaging happened in any layer, especially higher application layer. Thus, it can be used when recording events in pipeline works, in-process bidirectional streams and batch processing.

It requires a type and a message id that serves to uniquely identify each message. It can optionally have information about the message size.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageEvent.Type Available types for a MessageEvent.

Method Summary

Modifier and Type	Method and Description
static MessageEvent	create(MessageEvent.Type type, long messageId, long uncompressedSize, long compressedSize) Returns a MessageEvent with the desired values.
io.opentelemetry.common.Attributes	getAttributes()
String	getName()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static MessageEvent create(MessageEvent.Type type,
                                  long messageId,
                                  long uncompressedSize,
                                  long compressedSize)

Returns a MessageEvent with the desired values.

Parameters:

type - designates whether this is a send or receive message.

messageId - serves to uniquely identify each message.

uncompressedSize - represents the uncompressed size in bytes of this message. If not available use 0.

compressedSize - represents the compressed size in bytes of this message. If not available use 0.

Returns:

a MessageEvent with the desired values.

Throws:

NullPointerException - if type is null.

Since:

0.1.0

getName

public String getName()

Specified by:

getName in interface io.opentelemetry.trace.Event

getAttributes

public io.opentelemetry.common.Attributes getAttributes()

Specified by:

getAttributes in interface io.opentelemetry.trace.Event