Package io.opentelemetry.exporter.internal.marshal

Class Serializer

java.lang.Object

io.opentelemetry.exporter.internal.marshal.Serializer

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

JsonSerializer, ProtoSerializer

public abstract class Serializer
extends Object
implements AutoCloseable

Serializer to use when converting from an SDK data object into a protobuf output format. Unlike CodedOutputStream, which strictly encodes data into the protobuf binary format, this

• Handles proto3 semantics of not outputting the value when it matches the default of a field
• Can be implemented to serialize into protobuf JSON format (not binary)

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	Serializer.RepeatedElementPairWriter<K,V>
private static class	Serializer.RepeatedElementWriter<T>

Field Summary

Fields

Modifier and Type	Field	Description
private static final MarshalerContext.Key	ATTRIBUTES_WRITER_KEY

Constructor Summary

Constructors

Constructor	Description
Serializer()

Method Summary

Modifier and Type	Method	Description
abstract void	close()
void	serializeBool(ProtoFieldInfo field, boolean value)	Serializes a protobuf bool field.
void	serializeByteAsFixed32(ProtoFieldInfo field, byte value)	Serializes a byte as a protobuf fixed32 field.
void	serializeByteBuffer(ProtoFieldInfo field, ByteBuffer value)	Serializes a protobuf bytes field.
void	serializeBytes(ProtoFieldInfo field, byte[] value)	Serializes a protobuf bytes field.
void	serializeDouble(ProtoFieldInfo field, double value)	Serializes a proto buf double field.
void	serializeDoubleOptional(ProtoFieldInfo field, double value)	Serializes a proto buf double field.
void	serializeEnum(ProtoFieldInfo field, ProtoEnumInfo enumValue)	Serializes a protobuf enum field.
void	serializeFixed32(ProtoFieldInfo field, int value)	Serializes a protobuf fixed32 field.
void	serializeFixed64(ProtoFieldInfo field, long value)	Serializes a protobuf fixed64 field.
void	serializeFixed64Optional(ProtoFieldInfo field, long value)	Serializes a protobuf fixed64 field.
void	serializeInt32(ProtoFieldInfo field, int value)	Serializes a protobuf uint32 field.
void	serializeInt64(ProtoFieldInfo field, long value)	Serializes a protobuf int64 field.
void	serializeMessage(ProtoFieldInfo field, Marshaler message)	Serializes a protobuf embedded message.
<K, V> void	serializeMessageWithContext(ProtoFieldInfo field, K key, V value, StatelessMarshaler2<K,V> marshaler, MarshalerContext context)	Serializes a protobuf embedded message.
<T> void	serializeMessageWithContext(ProtoFieldInfo field, T message, StatelessMarshaler<T> marshaler, MarshalerContext context)	Serializes a protobuf embedded message.
void	serializeRepeatedDouble(ProtoFieldInfo field, List<Double> values)	Serializes a repeated double field.
void	serializeRepeatedFixed64(ProtoFieldInfo field, long[] values)	Serializes a repeated fixed64 field.
void	serializeRepeatedFixed64(ProtoFieldInfo field, List<Long> values)	Serializes a repeated fixed64 field.
void	serializeRepeatedInt64(ProtoFieldInfo field, List<Long> values)	Serializes a repeated int64 field.
abstract void	serializeRepeatedMessage(ProtoFieldInfo field, Marshaler[] repeatedMessage)	Serializes repeated message field.
abstract void	serializeRepeatedMessage(ProtoFieldInfo field, List<? extends Marshaler> repeatedMessage)	Serializes repeated message field.
void	serializeRepeatedMessageWithContext(ProtoFieldInfo field, Attributes attributes, StatelessMarshaler2<AttributeKey<?>,Object> marshaler, MarshalerContext context)	Serializes repeated message field.
<T> void	serializeRepeatedMessageWithContext(ProtoFieldInfo field, Collection<? extends T> messages, StatelessMarshaler<T> marshaler, MarshalerContext context, MarshalerContext.Key key)	Serializes repeated message field.
abstract <T> void	serializeRepeatedMessageWithContext(ProtoFieldInfo field, List<? extends T> messages, StatelessMarshaler<T> marshaler, MarshalerContext context)	Serializes repeated message field.
<K, V> void	serializeRepeatedMessageWithContext(ProtoFieldInfo field, Map<K,V> messages, StatelessMarshaler2<K,V> marshaler, MarshalerContext context, MarshalerContext.Key key)	Serializes repeated message field.
void	serializeRepeatedUInt64(ProtoFieldInfo field, long[] values)	Serializes a repeated uint64 field.
void	serializeRepeatedUInt64(ProtoFieldInfo field, DynamicPrimitiveLongList values)	Serializes a repeated uint64 field.
void	serializeRepeatedUInt64(ProtoFieldInfo field, List<Long> values)	Serializes a repeated uint64 field.
void	serializeSInt32(ProtoFieldInfo field, int value)	Serializes a protobuf sint32 field.
void	serializeSpanId(ProtoFieldInfo field, String spanId)	Serializes a span ID field.
void	serializeSpanId(ProtoFieldInfo field, String spanId, MarshalerContext context)
void	serializeString(ProtoFieldInfo field, byte[] utf8Bytes)	Serializes a protobuf string field.
void	serializeStringWithContext(ProtoFieldInfo field, String string, MarshalerContext context)	Serializes a protobuf string field.
void	serializeTraceId(ProtoFieldInfo field, String traceId)	Serializes a trace ID field.
void	serializeTraceId(ProtoFieldInfo field, String traceId, MarshalerContext context)
void	serializeUInt32(ProtoFieldInfo field, int value)	Serializes a protobuf uint32 field.
void	serializeUInt64(ProtoFieldInfo field, long value)	Serializes a protobuf uint64 field.
abstract void	writeBool(ProtoFieldInfo field, boolean value)	Writes a protobuf bool field, even if it matches the default value.
abstract void	writeByteBuffer(ProtoFieldInfo field, ByteBuffer value)
abstract void	writeBytes(ProtoFieldInfo field, byte[] value)
abstract void	writeDouble(ProtoFieldInfo field, double value)	Writes a protobuf double field, even if it matches the default value.
protected abstract void	writeDoubleValue(double value)
protected abstract void	writeEndMessage()
protected abstract void	writeEndRepeated()	Writes end of repeated messages.
protected abstract void	writeEndRepeatedElement()	Writes end of a repeated message element.
protected abstract void	writeEndRepeatedPrimitive()
protected abstract void	writeEndRepeatedVarint()
protected abstract void	writeEnum(ProtoFieldInfo field, ProtoEnumInfo enumValue)
protected abstract void	writeFixed32(ProtoFieldInfo field, int value)
protected abstract void	writeFixed64(ProtoFieldInfo field, long value)
protected abstract void	writeFixed64Value(long value)
protected abstract void	writeint32(ProtoFieldInfo field, int value)
abstract void	writeInt64(ProtoFieldInfo field, long value)	Writes a protobuf int64 field, even if it matches the default value.
abstract void	writeSerializedMessage(byte[] protoSerialized, String jsonSerialized)	Writes the value for a message field that has been pre-serialized.
protected abstract void	writeSInt32(ProtoFieldInfo info, int value)
protected abstract void	writeSpanId(ProtoFieldInfo field, String spanId)
protected void	writeSpanId(ProtoFieldInfo field, String spanId, MarshalerContext context)
protected abstract void	writeStartMessage(ProtoFieldInfo field, int protoMessageSize)
protected abstract void	writeStartRepeated(ProtoFieldInfo field)	Writes start of repeated messages.
protected abstract void	writeStartRepeatedElement(ProtoFieldInfo field, int protoMessageSize)	Writes start of a repeated message element.
protected abstract void	writeStartRepeatedPrimitive(ProtoFieldInfo field, int protoSizePerElement, int numElements)
protected abstract void	writeStartRepeatedVarint(ProtoFieldInfo field, int payloadSize)
abstract void	writeString(ProtoFieldInfo field, byte[] utf8Bytes)	Writes a protobuf string field, even if it matches the default value.
abstract void	writeString(ProtoFieldInfo field, String string, int utf8Length, MarshalerContext context)
protected abstract void	writeTraceId(ProtoFieldInfo field, String traceId)
protected void	writeTraceId(ProtoFieldInfo field, String traceId, MarshalerContext context)
protected abstract void	writeUint32(ProtoFieldInfo field, int value)
abstract void	writeUInt64(ProtoFieldInfo field, long value)	Writes a protobuf uint64 field, even if it matches the default value.
protected abstract void	writeUInt64Value(long value)

Methods inherited from class java.lang.Object

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

Field Details

ATTRIBUTES_WRITER_KEY

private static final MarshalerContext.Key ATTRIBUTES_WRITER_KEY

Constructor Details

Serializer

Serializer()

Method Details

serializeTraceId

public void serializeTraceId(ProtoFieldInfo field,
 @Nullable
 String traceId)
                      throws IOException

Serializes a trace ID field.

Throws:

IOException

serializeTraceId

public void serializeTraceId(ProtoFieldInfo field,
 @Nullable
 String traceId,
 MarshalerContext context)
                      throws IOException

Throws:

IOException

writeTraceId

protected abstract void writeTraceId(ProtoFieldInfo field,
 String traceId)
                              throws IOException

Throws:

IOException

writeTraceId

protected void writeTraceId(ProtoFieldInfo field,
 String traceId,
 MarshalerContext context)
                     throws IOException

Throws:

IOException

serializeSpanId

public void serializeSpanId(ProtoFieldInfo field,
 @Nullable
 String spanId)
                     throws IOException

Serializes a span ID field.

Throws:

IOException

serializeSpanId

public void serializeSpanId(ProtoFieldInfo field,
 @Nullable
 String spanId,
 MarshalerContext context)
                     throws IOException

Throws:

IOException

writeSpanId

protected abstract void writeSpanId(ProtoFieldInfo field,
 String spanId)
                             throws IOException

Throws:

IOException

writeSpanId

protected void writeSpanId(ProtoFieldInfo field,
 String spanId,
 MarshalerContext context)
                    throws IOException

Throws:

IOException

serializeBool

public void serializeBool(ProtoFieldInfo field,
 boolean value)
                   throws IOException

Serializes a protobuf bool field.

Throws:

IOException

writeBool

public abstract void writeBool(ProtoFieldInfo field,
 boolean value)
                        throws IOException

Writes a protobuf bool field, even if it matches the default value.

Throws:

IOException

serializeEnum

public void serializeEnum(ProtoFieldInfo field,
 ProtoEnumInfo enumValue)
                   throws IOException

Serializes a protobuf enum field.

Throws:

IOException

writeEnum

protected abstract void writeEnum(ProtoFieldInfo field,
 ProtoEnumInfo enumValue)
                           throws IOException

Throws:

IOException

serializeUInt32

public void serializeUInt32(ProtoFieldInfo field,
 int value)
                     throws IOException

Serializes a protobuf uint32 field.

Throws:

IOException

writeUint32

protected abstract void writeUint32(ProtoFieldInfo field,
 int value)
                             throws IOException

Throws:

IOException

serializeSInt32

public void serializeSInt32(ProtoFieldInfo field,
 int value)
                     throws IOException

Serializes a protobuf sint32 field.

Throws:

IOException

writeSInt32

protected abstract void writeSInt32(ProtoFieldInfo info,
 int value)
                             throws IOException

Throws:

IOException

serializeInt32

public void serializeInt32(ProtoFieldInfo field,
 int value)
                    throws IOException

Serializes a protobuf uint32 field.

Throws:

IOException

writeint32

protected abstract void writeint32(ProtoFieldInfo field,
 int value)
                            throws IOException

Throws:

IOException

serializeInt64

public void serializeInt64(ProtoFieldInfo field,
 long value)
                    throws IOException

Serializes a protobuf int64 field.

Throws:

IOException

serializeUInt64

public void serializeUInt64(ProtoFieldInfo field,
 long value)
                     throws IOException

Serializes a protobuf uint64 field.

Throws:

IOException

writeInt64

public abstract void writeInt64(ProtoFieldInfo field,
 long value)
                         throws IOException

Writes a protobuf int64 field, even if it matches the default value.

Throws:

IOException

writeUInt64

public abstract void writeUInt64(ProtoFieldInfo field,
 long value)
                          throws IOException

Writes a protobuf uint64 field, even if it matches the default value.

Throws:

IOException

serializeFixed64

public void serializeFixed64(ProtoFieldInfo field,
 long value)
                      throws IOException

Serializes a protobuf fixed64 field.

Throws:

IOException

serializeFixed64Optional

public void serializeFixed64Optional(ProtoFieldInfo field,
 long value)
                              throws IOException

Serializes a protobuf fixed64 field.

Throws:

IOException

writeFixed64

protected abstract void writeFixed64(ProtoFieldInfo field,
 long value)
                              throws IOException

Throws:

IOException

writeFixed64Value

protected abstract void writeFixed64Value(long value)
                                   throws IOException

Throws:

IOException

writeUInt64Value

protected abstract void writeUInt64Value(long value)
                                  throws IOException

Throws:

IOException

serializeByteAsFixed32

public void serializeByteAsFixed32(ProtoFieldInfo field,
 byte value)
                            throws IOException

Serializes a byte as a protobuf fixed32 field. Ensures that there is no sign propagation if the high bit in the byte is set.

Throws:

IOException

serializeFixed32

public void serializeFixed32(ProtoFieldInfo field,
 int value)
                      throws IOException

Serializes a protobuf fixed32 field.

Throws:

IOException

writeFixed32

protected abstract void writeFixed32(ProtoFieldInfo field,
 int value)
                              throws IOException

Throws:

IOException

serializeDouble

public void serializeDouble(ProtoFieldInfo field,
 double value)
                     throws IOException

Serializes a proto buf double field.

Throws:

IOException

serializeDoubleOptional

public void serializeDoubleOptional(ProtoFieldInfo field,
 double value)
                             throws IOException

Serializes a proto buf double field.

Throws:

IOException

writeDouble

public abstract void writeDouble(ProtoFieldInfo field,
 double value)
                          throws IOException

Writes a protobuf double field, even if it matches the default value.

Throws:

IOException

writeDoubleValue

protected abstract void writeDoubleValue(double value)
                                  throws IOException

Throws:

IOException

serializeString

public void serializeString(ProtoFieldInfo field,
 byte[] utf8Bytes)
                     throws IOException

Serializes a protobuf string field. utf8Bytes is the UTF8 encoded bytes of the string to serialize.

Throws:

IOException

serializeStringWithContext

public void serializeStringWithContext(ProtoFieldInfo field,
 @Nullable
 String string,
 MarshalerContext context)
                                throws IOException

Serializes a protobuf string field. string is the value to be serialized and utf8Length is the length of the string after it is encoded in UTF8. This method reads elements from context, use together with StatelessMarshalerUtil.sizeStringWithContext(ProtoFieldInfo, String, MarshalerContext).

Throws:

IOException

writeString

public abstract void writeString(ProtoFieldInfo field,
 byte[] utf8Bytes)
                          throws IOException

Writes a protobuf string field, even if it matches the default value.

Throws:

IOException

writeString

public abstract void writeString(ProtoFieldInfo field,
 String string,
 int utf8Length,
 MarshalerContext context)
                          throws IOException

Throws:

IOException

serializeBytes

public void serializeBytes(ProtoFieldInfo field,
 byte[] value)
                    throws IOException

Serializes a protobuf bytes field.

Throws:

IOException

serializeByteBuffer

public void serializeByteBuffer(ProtoFieldInfo field,
 ByteBuffer value)
                         throws IOException

Serializes a protobuf bytes field. Writes all content of the ByteBuffer regardless of the current position and limit. Does not alter the position or limit of the provided ByteBuffer.

Throws:

IOException

writeBytes

public abstract void writeBytes(ProtoFieldInfo field,
 byte[] value)
                         throws IOException

Throws:

IOException

writeByteBuffer

public abstract void writeByteBuffer(ProtoFieldInfo field,
 ByteBuffer value)
                              throws IOException

Throws:

IOException

writeStartMessage

protected abstract void writeStartMessage(ProtoFieldInfo field,
 int protoMessageSize)
                                   throws IOException

Throws:

IOException

writeEndMessage

protected abstract void writeEndMessage()
                                 throws IOException

Throws:

IOException

serializeMessage

public void serializeMessage(ProtoFieldInfo field,
 Marshaler message)
                      throws IOException

Serializes a protobuf embedded message.

Throws:

IOException

serializeMessageWithContext

public <T> void serializeMessageWithContext(ProtoFieldInfo field,
 T message,
 StatelessMarshaler<T> marshaler,
 MarshalerContext context)
                                     throws IOException

Serializes a protobuf embedded message. This method adds elements to context, use together with StatelessMarshalerUtil.sizeMessageWithContext(ProtoFieldInfo, Object, StatelessMarshaler, MarshalerContext).

Throws:

IOException

serializeMessageWithContext

public <K,
V> void serializeMessageWithContext(ProtoFieldInfo field,
 K key,
 V value,
 StatelessMarshaler2<K,V> marshaler,
 MarshalerContext context)
                                        throws IOException

Serializes a protobuf embedded message. This method adds elements to context, use together with StatelessMarshalerUtil.sizeMessageWithContext(ProtoFieldInfo, Object, Object, StatelessMarshaler2, MarshalerContext).

Throws:

IOException

writeStartRepeatedPrimitive

protected abstract void writeStartRepeatedPrimitive(ProtoFieldInfo field,
 int protoSizePerElement,
 int numElements)
                                             throws IOException

Throws:

IOException

writeEndRepeatedPrimitive

protected abstract void writeEndRepeatedPrimitive()
                                           throws IOException

Throws:

IOException

writeStartRepeatedVarint

protected abstract void writeStartRepeatedVarint(ProtoFieldInfo field,
 int payloadSize)
                                          throws IOException

Throws:

IOException

writeEndRepeatedVarint

protected abstract void writeEndRepeatedVarint()
                                        throws IOException

Throws:

IOException

serializeRepeatedFixed64

public void serializeRepeatedFixed64(ProtoFieldInfo field,
 List<Long> values)
                              throws IOException

Serializes a repeated fixed64 field.

Throws:

IOException

serializeRepeatedFixed64

public void serializeRepeatedFixed64(ProtoFieldInfo field,
 long[] values)
                              throws IOException

Serializes a repeated fixed64 field.

Throws:

IOException

serializeRepeatedUInt64

public void serializeRepeatedUInt64(ProtoFieldInfo field,
 long[] values)
                             throws IOException

Serializes a repeated uint64 field.

Throws:

IOException

serializeRepeatedUInt64

public void serializeRepeatedUInt64(ProtoFieldInfo field,
 List<Long> values)
                             throws IOException

Serializes a repeated uint64 field.

Throws:

IOException

serializeRepeatedUInt64

public void serializeRepeatedUInt64(ProtoFieldInfo field,
 DynamicPrimitiveLongList values)
                             throws IOException

Serializes a repeated uint64 field.

NOTE: This is the same as serializeRepeatedUInt64(ProtoFieldInfo, long[]) but instead of taking a primitive array it takes a DynamicPrimitiveLongList as input.

Throws:

IOException

serializeRepeatedInt64

public void serializeRepeatedInt64(ProtoFieldInfo field,
 List<Long> values)
                            throws IOException

Serializes a repeated int64 field.

Throws:

IOException

serializeRepeatedDouble

public void serializeRepeatedDouble(ProtoFieldInfo field,
 List<Double> values)
                             throws IOException

Serializes a repeated double field.

Throws:

IOException

serializeRepeatedMessage

public abstract void serializeRepeatedMessage(ProtoFieldInfo field,
 Marshaler[] repeatedMessage)
                                       throws IOException

Serializes repeated message field.

Throws:

IOException

serializeRepeatedMessage

public abstract void serializeRepeatedMessage(ProtoFieldInfo field,
 List<? extends Marshaler> repeatedMessage)
                                       throws IOException

Serializes repeated message field.

Throws:

IOException

serializeRepeatedMessageWithContext

public abstract <T> void serializeRepeatedMessageWithContext(ProtoFieldInfo field,
 List<? extends T> messages,
 StatelessMarshaler<T> marshaler,
 MarshalerContext context)
                                                      throws IOException

Serializes repeated message field. This method reads elements from context, use together with StatelessMarshalerUtil.sizeRepeatedMessageWithContext(ProtoFieldInfo, List, StatelessMarshaler, MarshalerContext).

Throws:

IOException

serializeRepeatedMessageWithContext

public <T> void serializeRepeatedMessageWithContext(ProtoFieldInfo field,
 Collection<? extends T> messages,
 StatelessMarshaler<T> marshaler,
 MarshalerContext context,
 MarshalerContext.Key key)
                                             throws IOException

Serializes repeated message field. This method reads elements from context, use together with StatelessMarshalerUtil.sizeRepeatedMessageWithContext(ProtoFieldInfo, Collection, StatelessMarshaler, MarshalerContext, MarshalerContext.Key).

Throws:

IOException

serializeRepeatedMessageWithContext

public <K,
V> void serializeRepeatedMessageWithContext(ProtoFieldInfo field,
 Map<K,V> messages,
 StatelessMarshaler2<K,V> marshaler,
 MarshalerContext context,
 MarshalerContext.Key key)
                                                throws IOException

Serializes repeated message field. This method reads elements from context, use together with StatelessMarshalerUtil.sizeRepeatedMessageWithContext(ProtoFieldInfo, Map, StatelessMarshaler2, MarshalerContext, MarshalerContext.Key).

Throws:

IOException

serializeRepeatedMessageWithContext

public void serializeRepeatedMessageWithContext(ProtoFieldInfo field,
 Attributes attributes,
 StatelessMarshaler2<AttributeKey<?>,Object> marshaler,
 MarshalerContext context)
                                         throws IOException

Serializes repeated message field. This method reads elements from context, use together with StatelessMarshalerUtil.sizeRepeatedMessageWithContext(ProtoFieldInfo, Attributes, StatelessMarshaler2, MarshalerContext).

Throws:

IOException

writeStartRepeated

protected abstract void writeStartRepeated(ProtoFieldInfo field)
                                    throws IOException

Writes start of repeated messages.

Throws:

IOException

writeEndRepeated

protected abstract void writeEndRepeated()
                                  throws IOException

Writes end of repeated messages.

Throws:

IOException

writeStartRepeatedElement

protected abstract void writeStartRepeatedElement(ProtoFieldInfo field,
 int protoMessageSize)
                                           throws IOException

Writes start of a repeated message element.

Throws:

IOException

writeEndRepeatedElement

protected abstract void writeEndRepeatedElement()
                                         throws IOException

Writes end of a repeated message element.

Throws:

IOException

writeSerializedMessage

public abstract void writeSerializedMessage(byte[] protoSerialized,
 String jsonSerialized)
                                     throws IOException

Writes the value for a message field that has been pre-serialized.

Throws:

IOException

close

public abstract void close()
                    throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException