io.sentry.event.interfaces

Class MessageInterface

java.lang.Object

io.sentry.event.interfaces.MessageInterface

All Implemented Interfaces:

SentryInterface, Serializable

public class MessageInterface
extends Object
implements SentryInterface

The Message interface for Sentry allows to send the original pattern to Sentry, allowing the events to be grouped by original message (rather than the formatted version).

Sentry's ability to regroup event with the same messages is based on the content of the message, meaning that an Event with the message "User1 failed to provide an email address" won't be grouped with an Event with the message "User2 failed to provide an email address".

To allow this kind of grouping, sentry supports the message interface which will provide both the pattern of the message and the parameters. In this example the pattern could be:
{} failed to provide an email address
And the parameters would be User1 in the first Event and User2 in the second Event.
This way, Sentry will be able to put the two events in the same category.

Note: Sentry won't attempt to format the message, this is why the formatted message should be set through EventBuilder.withMessage(String) in any case.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_INTERFACE Name of the message interface in Sentry.

Constructor Summary

Constructors

Constructor and Description
MessageInterface(String message) Creates a non parametrised message.
MessageInterface(String message, List<String> parameters) Creates a parametrised message for an Event.
MessageInterface(String message, List<String> parameters, String formatted) Creates a parametrised message for an Event.
MessageInterface(String message, String... params) Creates a parametrised message for an Event.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getFormatted()
String	getInterfaceName() Gets the unique name of the interface.
String	getMessage()
List<String>	getParameters()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MESSAGE_INTERFACE

public static final String MESSAGE_INTERFACE

Name of the message interface in Sentry.

See Also:

Constant Field Values

Constructor Detail

MessageInterface

public MessageInterface(String message)

Creates a non parametrised message.

While it's technically possible to create a non parametrised message with MessageInterface, it's recommended to use EventBuilder.withMessage(String) instead.

Parameters:

message - message to add to the event.

MessageInterface

public MessageInterface(String message,
                        String... params)

Creates a parametrised message for an Event.

Parameters:

message - original message.

params - parameters of the message.

MessageInterface

public MessageInterface(String message,
                        List<String> parameters)

Creates a parametrised message for an Event.

Parameters:

message - original message.

parameters - parameters of the message.

MessageInterface

public MessageInterface(String message,
                        List<String> parameters,
                        String formatted)

Creates a parametrised message for an Event.

Parameters:

message - original message.

parameters - parameters of the message.

formatted - message formatted with parameters

Method Detail

getInterfaceName

public String getInterfaceName()

Description copied from interface: SentryInterface

Gets the unique name of the interface.

Specified by:

getInterfaceName in interface SentryInterface

Returns:

name of the interface.

getMessage

public String getMessage()

getParameters

public List<String> getParameters()

getFormatted

public String getFormatted()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object