eu.plumbr.api

Class SpanSerializer

java.lang.Object

eu.plumbr.api.SpanSerializer

public class SpanSerializer
extends java.lang.Object

Span serializer is intended to be used when a span needs to be serialized before transferring it to another JVM. On the other end, it is used to deserialize the transferred span.

Span metadata must be set on the same instance of Span on which Span.start() is called as it is discarded in the serialized format. The service name, application name and user identity are also discarded in the serialized format, however there is no need to set those properties for a child span as they only have an effect when used on a root span.

Field Summary

Fields

Modifier and Type	Field and Description
static int	API_VERSION

Constructor Summary

Constructors

Constructor and Description
SpanSerializer()

Method Summary

Modifier and Type	Method and Description
static Span	fromBase64(java.lang.String string) Deserializes a Span from a base-64 string representation.
static Span	fromByteArray(byte[] buffer) Deserializes a Span from a byte array.
static java.lang.String	toBase64(Span span) Serializes a Span to a base-64 string representation.
static byte[]	toByteArray(Span span) Serializes a Span to a byte array.

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final int API_VERSION

See Also:

Constant Field Values

Constructor Detail

SpanSerializer

public SpanSerializer()

Method Detail

fromByteArray

public static Span fromByteArray(byte[] buffer)

Deserializes a Span from a byte array. The contents of the byte array must have been obtained by previously calling toByteArray(Span).

Parameters:

buffer - Byte array representing the serialized span.

Returns:

Instance of a valid Span if the input was valid, Plumbr Agent is attached and is not too old to support this API version. In any other case, returns a null span (Span.isNull() returns true).

fromBase64

public static Span fromBase64(java.lang.String string)

Deserializes a Span from a base-64 string representation. The contents of the byte array must have been obtained by previously calling toBase64(Span).

Parameters:

string - Base-64 formatted string representing the serialized span.

Returns:

Instance of a valid Span if the input was valid, Plumbr Agent is attached and is not too old to support this API version. In any other case, returns a null span (Span.isNull() returns true).

toByteArray

public static byte[] toByteArray(Span span)

Serializes a Span to a byte array. Use fromByteArray(byte[]) (String)} to deserialize.

Parameters:

span - Span to serialize.

Returns:

Serialized format of the specified span if the specified span is non-null, Plumbr Agent is attached and is not too old to support this API version. In any other case, returns an empty byte array.

toBase64

public static java.lang.String toBase64(Span span)

Serializes a Span to a base-64 string representation. Use fromBase64(String) to deserialize.

Parameters:

span - Span to serialize.

Returns:

Serialized format of the specified span if the specified span is non-null, Plumbr Agent is attached and is not too old to support this API version. In any other case, returns an empty string.