Package co.elastic.apm.agent.report.serialize

Class DslJsonSerializer

java.lang.Object

co.elastic.apm.agent.report.serialize.DslJsonSerializer

All Implemented Interfaces:

PayloadSerializer

public class DslJsonSerializer
extends java.lang.Object
implements PayloadSerializer

Nested Class Summary

Nested classes/interfaces inherited from interface co.elastic.apm.agent.report.serialize.PayloadSerializer

PayloadSerializer.UninitializedException

Field Summary

Fields

Modifier and Type	Field	Description
static int	BUFFER_SIZE	Matches default ZLIB buffer size.
static int	MAX_LONG_STRING_VALUE_LENGTH
static int	MAX_VALUE_LENGTH

Constructor Summary

Constructors

Constructor	Description
DslJsonSerializer(StacktraceConfiguration stacktraceConfiguration, ApmServerClient apmServerClient, java.util.concurrent.Future<MetaData> metaData)

Method Summary

Modifier and Type	Method	Description
void	appendMetaDataNdJsonToStream()	Appends the serialized metadata to ND-JSON as a metadata line.
void	appendMetadataToStream()	Appends the serialized metadata to the underlying OutputStream.
void	blockUntilReady()	Blocking until this PayloadSerializer is ready for use.
void	flushToOutputStream()	Flushes content that has been written so far to the OutputStream which has been set via setOutputStream(OutputStream), without flushing the OutputStream itself.
void	fullFlush()	Flushes the OutputStream which has been set via setOutputStream(OutputStream) and detaches that OutputStream from the serializer.
int	getBufferSize()	Returns the number of bytes already serialized and waiting in the underlying JsonWriter's buffer.
com.dslplatform.json.JsonWriter	getJsonWriter()
static java.lang.CharSequence	sanitizeLabelKey(java.lang.String key, java.lang.StringBuilder replaceBuilder)
void	serializeErrorNdJson(ErrorCapture error)
void	serializeFileMetaData(java.io.File file)
void	serializeSpanNdJson(Span span)
void	serializeTransactionNdJson(Transaction transaction)
void	setOutputStream(java.io.OutputStream os)	Sets the output stream which the *NdJson methods should write to.
java.lang.String	toJsonString(ErrorCapture error)
java.lang.String	toJsonString(Span span)
java.lang.String	toJsonString(Transaction transaction)
java.lang.String	toJsonString(java.lang.StackTraceElement stackTraceElement)
java.lang.String	toString()
void	writeBytes(byte[] bytes, int len)
static void	writeFieldName(java.lang.String fieldName, com.dslplatform.json.JsonWriter jw)
static void	writeLastField(java.lang.String fieldName, java.lang.CharSequence value, java.lang.StringBuilder replaceBuilder, com.dslplatform.json.JsonWriter jw)
static void	writeStringValue(java.lang.CharSequence value, java.lang.StringBuilder replaceBuilder, com.dslplatform.json.JsonWriter jw)

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

Matches default ZLIB buffer size. Lets us assume the ZLIB buffer is always empty, so that getBufferSize() is the total amount of buffered bytes.

See Also:

Constant Field Values

MAX_VALUE_LENGTH

public static final int MAX_VALUE_LENGTH

See Also:

Constant Field Values

MAX_LONG_STRING_VALUE_LENGTH

public static final int MAX_LONG_STRING_VALUE_LENGTH

See Also:

Constant Field Values

Constructor Detail

DslJsonSerializer

public DslJsonSerializer(StacktraceConfiguration stacktraceConfiguration,
                         ApmServerClient apmServerClient,
                         java.util.concurrent.Future<MetaData> metaData)

Method Detail

setOutputStream

public void setOutputStream(java.io.OutputStream os)

Description copied from interface: PayloadSerializer

Sets the output stream which the *NdJson methods should write to.

Specified by:

setOutputStream in interface PayloadSerializer

Parameters:

os - the OutputStream to which all contents are to be serialized

fullFlush

public void fullFlush()
               throws java.io.IOException

Flushes the OutputStream which has been set via setOutputStream(OutputStream) and detaches that OutputStream from the serializer.

Specified by:

fullFlush in interface PayloadSerializer

Throws:

java.io.IOException

flushToOutputStream

public void flushToOutputStream()

Flushes content that has been written so far to the OutputStream which has been set via setOutputStream(OutputStream), without flushing the OutputStream itself. Subsequent serializations will be made to the same OutputStream.

Specified by:

flushToOutputStream in interface PayloadSerializer

appendMetaDataNdJsonToStream

public void appendMetaDataNdJsonToStream()
                                  throws PayloadSerializer.UninitializedException

Appends the serialized metadata to ND-JSON as a metadata line.

NOTE: Must be called after PayloadSerializer.blockUntilReady() was called and returned, otherwise the cached serialized metadata may not be ready yet.

Specified by:

appendMetaDataNdJsonToStream in interface PayloadSerializer

Throws:

PayloadSerializer.UninitializedException - may be thrown if PayloadSerializer.blockUntilReady() was not invoked

appendMetadataToStream

public void appendMetadataToStream()
                            throws PayloadSerializer.UninitializedException

Appends the serialized metadata to the underlying OutputStream.

NOTE: Must be called after PayloadSerializer.blockUntilReady() was called and returned, otherwise the cached serialized metadata may not be ready yet.

Specified by:

appendMetadataToStream in interface PayloadSerializer

Throws:

PayloadSerializer.UninitializedException - may be thrown if PayloadSerializer.blockUntilReady() was not invoked

blockUntilReady

public void blockUntilReady()
                     throws java.lang.Exception

Blocking until this PayloadSerializer is ready for use. Blocking will be timed out with a TimeoutException if the serializer is not ready within 5 seconds. Since the requirement is to call this method is called on the same thread that calls subsequently calls appendMetadataToStream(), there is no risk of visibility issues with regard to serializedMetaData.

Specified by:

blockUntilReady in interface PayloadSerializer

Throws:

java.lang.Exception - if blocking was interrupted, or timed out or an error occurred in the underlying implementation

serializeTransactionNdJson

public void serializeTransactionNdJson(Transaction transaction)

Specified by:

serializeTransactionNdJson in interface PayloadSerializer

serializeSpanNdJson

public void serializeSpanNdJson(Span span)

Specified by:

serializeSpanNdJson in interface PayloadSerializer

serializeErrorNdJson

public void serializeErrorNdJson(ErrorCapture error)

Specified by:

serializeErrorNdJson in interface PayloadSerializer

getBufferSize

public int getBufferSize()

Returns the number of bytes already serialized and waiting in the underlying JsonWriter's buffer. Note that the resulting JSON can be bigger if a Stream is set to the writer and some data was already flushed

Specified by:

getBufferSize in interface PayloadSerializer

Returns:

number of bytes currently waiting in the underlying JsonWriter to be flushed to the underlying stream

serializeFileMetaData

public void serializeFileMetaData(java.io.File file)

Specified by:

serializeFileMetaData in interface PayloadSerializer

getJsonWriter

public com.dslplatform.json.JsonWriter getJsonWriter()

Specified by:

getJsonWriter in interface PayloadSerializer

writeBytes

public void writeBytes(byte[] bytes,
                       int len)

Specified by:

writeBytes in interface PayloadSerializer

toJsonString

public java.lang.String toJsonString(Transaction transaction)

toJsonString

public java.lang.String toJsonString(Span span)

toJsonString

public java.lang.String toJsonString(ErrorCapture error)

toJsonString

public java.lang.String toJsonString(java.lang.StackTraceElement stackTraceElement)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

sanitizeLabelKey

public static java.lang.CharSequence sanitizeLabelKey(java.lang.String key,
                                                      java.lang.StringBuilder replaceBuilder)

writeStringValue

public static void writeStringValue(java.lang.CharSequence value,
                                    java.lang.StringBuilder replaceBuilder,
                                    com.dslplatform.json.JsonWriter jw)

writeLastField

public static void writeLastField(java.lang.String fieldName,
                                  @Nullable
                                  java.lang.CharSequence value,
                                  java.lang.StringBuilder replaceBuilder,
                                  com.dslplatform.json.JsonWriter jw)

writeFieldName

public static void writeFieldName(java.lang.String fieldName,
                                  com.dslplatform.json.JsonWriter jw)