io.sentry.marshaller.json

Class JsonMarshaller

java.lang.Object

io.sentry.marshaller.json.JsonMarshaller

All Implemented Interfaces:

Marshaller

public class JsonMarshaller
extends Object
implements Marshaller

Event marshaller using JSON to send the data.

The content can also be compressed with GZIPOutputStream.

Nested Class Summary

Nested classes/interfaces inherited from interface io.sentry.marshaller.Marshaller

Marshaller.UncloseableOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
static String	BREADCRUMBS List of breadcrumbs for this event.
static String	CHECKSUM Checksum for the event, allowing to group events with a similar checksum.
static String	CONTEXTS Map of map of contexts for this event.
static String	CULPRIT Function call which was the primary perpetrator of this event.
static int	DEFAULT_MAX_MESSAGE_LENGTH Default maximum length for a message.
static String	DIST Identifies the the distribution of the application.
static String	ENVIRONMENT Identifies the environment the application is running in.
static String	EVENT_ID Hexadecimal string representing a uuid4 value.
static String	EXTRA An arbitrary mapping of additional metadata to store with the event.
static String	FINGERPRINT Event fingerprint, a list of strings used to dictate the deduplicating for this event.
static String	LEVEL The record severity.
static String	LOGGER The name of the logger which created the record.
static String	MESSAGE User-readable representation of this event.
static String	MODULES A list of relevant modules and their versions.
static String	PLATFORM A string representing the platform the client is submitting from.
static String	RELEASE Identifies the the version of the application.
static String	SDK An object representing the SDK name and version.
static String	SERVER_NAME Identifies the host client from which the event was recorded.
static String	TAGS A map or list of tags for this event.
static String	TIMESTAMP Indicates when the logging record was created.
static String	TRANSACTION Name of the transaction that this event occurred inside of.

Constructor Summary

Constructors

Constructor and Description
JsonMarshaller() Create instance of JsonMarshaller with default message length.
JsonMarshaller(int maxMessageLength) Create instance of JsonMarshaller with provided maximum length of the messages.

Method Summary

Modifier and Type	Method and Description
<T extends SentryInterface,F extends T> void	addInterfaceBinding(Class<F> sentryInterfaceClass, InterfaceBinding<T> binding) Add an interface binding to send a type of SentryInterface through a JSON stream.
protected com.fasterxml.jackson.core.JsonGenerator	createJsonGenerator(OutputStream destination) Creates the JsonGenerator used to marshall to json.
String	getContentEncoding() Returns the HTTP Content-Encoding, if applicable, or null.
String	getContentType() Returns the HTTP Content-Type, if applicable, or null.
boolean	isCompressed()
void	marshall(Event event, OutputStream destination) Serialises an event and sends it through an OutputStream.
void	setCompression(boolean compression) Enables the JSON compression with gzip.

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_ID

public static final String EVENT_ID

Hexadecimal string representing a uuid4 value.

See Also:

Constant Field Values

MESSAGE

public static final String MESSAGE

User-readable representation of this event.

See Also:

Constant Field Values

TIMESTAMP

public static final String TIMESTAMP

Indicates when the logging record was created.

See Also:

Constant Field Values

LEVEL

public static final String LEVEL

The record severity.

See Also:

Constant Field Values

LOGGER

public static final String LOGGER

The name of the logger which created the record.

See Also:

Constant Field Values

PLATFORM

public static final String PLATFORM

A string representing the platform the client is submitting from.

See Also:

Constant Field Values

CULPRIT

public static final String CULPRIT

Function call which was the primary perpetrator of this event.

See Also:

Constant Field Values

TRANSACTION

public static final String TRANSACTION

Name of the transaction that this event occurred inside of.

See Also:

Constant Field Values

SDK

public static final String SDK

An object representing the SDK name and version.

See Also:

Constant Field Values

TAGS

public static final String TAGS

A map or list of tags for this event.

See Also:

Constant Field Values

BREADCRUMBS

public static final String BREADCRUMBS

List of breadcrumbs for this event.

See Also:

Constant Field Values

CONTEXTS

public static final String CONTEXTS

Map of map of contexts for this event.

See Also:

Constant Field Values

SERVER_NAME

public static final String SERVER_NAME

Identifies the host client from which the event was recorded.

See Also:

Constant Field Values

RELEASE

public static final String RELEASE

Identifies the the version of the application.

See Also:

Constant Field Values

DIST

public static final String DIST

Identifies the the distribution of the application.

See Also:

Constant Field Values

ENVIRONMENT

public static final String ENVIRONMENT

Identifies the environment the application is running in.

See Also:

Constant Field Values

FINGERPRINT

public static final String FINGERPRINT

Event fingerprint, a list of strings used to dictate the deduplicating for this event.

See Also:

Constant Field Values

MODULES

public static final String MODULES

A list of relevant modules and their versions.

See Also:

Constant Field Values

EXTRA

public static final String EXTRA

An arbitrary mapping of additional metadata to store with the event.

See Also:

Constant Field Values

CHECKSUM

public static final String CHECKSUM

Checksum for the event, allowing to group events with a similar checksum.

See Also:

Constant Field Values

DEFAULT_MAX_MESSAGE_LENGTH

public static final int DEFAULT_MAX_MESSAGE_LENGTH

Default maximum length for a message.

See Also:

Constant Field Values

Constructor Detail

JsonMarshaller

public JsonMarshaller()

Create instance of JsonMarshaller with default message length.

JsonMarshaller

public JsonMarshaller(int maxMessageLength)

Create instance of JsonMarshaller with provided maximum length of the messages.

Parameters:

maxMessageLength - the maximum message length

Method Detail

marshall

public void marshall(Event event,
                     OutputStream destination)
              throws IOException

Description copied from interface: Marshaller

Serialises an event and sends it through an OutputStream.

The marshaller should not close the given stream, use Marshaller.UncloseableOutputStream to prevent automatic calls to OutputStream.close().

Specified by:

marshall in interface Marshaller

Parameters:

event - event to serialise.

destination - destination stream.

Throws:

IOException - on write error

createJsonGenerator

protected com.fasterxml.jackson.core.JsonGenerator createJsonGenerator(OutputStream destination)
                                                                throws IOException

Creates the JsonGenerator used to marshall to json. This method makes it easier to provide a custom implementation.

Parameters:

destination - used to read the content

Returns:

a new instance

Throws:

IOException - on error reading the stream

getContentType

public String getContentType()

Description copied from interface: Marshaller

Returns the HTTP Content-Type, if applicable, or null.

Specified by:

getContentType in interface Marshaller

Returns:

the HTTP Content-Type, if applicable, or null.

getContentEncoding

public String getContentEncoding()

Description copied from interface: Marshaller

Returns the HTTP Content-Encoding, if applicable, or null.

Specified by:

getContentEncoding in interface Marshaller

Returns:

the HTTP Content-Encoding, if applicable, or null.

addInterfaceBinding

public <T extends SentryInterface,F extends T> void addInterfaceBinding(Class<F> sentryInterfaceClass,
                                                                        InterfaceBinding<T> binding)

Add an interface binding to send a type of SentryInterface through a JSON stream.

Type Parameters:

T - Type of SentryInterface received by the InterfaceBinding.

F - Type of the interface stored in the event to send to the InterfaceBinding.

Parameters:

sentryInterfaceClass - Actual type of SentryInterface supported by the InterfaceBinding

binding - InterfaceBinding converting SentryInterfaces of type sentryInterfaceClass.

setCompression

public void setCompression(boolean compression)

Enables the JSON compression with gzip.

Parameters:

compression - state of the compression.

isCompressed

public boolean isCompressed()