net.kencochrane.raven.event

Class EventBuilder

java.lang.Object

net.kencochrane.raven.event.EventBuilder

public class EventBuilder
extends Object

Builder to assist the creation of Events.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HOSTNAME Default hostname if it isn't set manually (or can't be determined).
static String	DEFAULT_PLATFORM Default platform if it isn't set manually.
static long	HOSTNAME_CACHE_DURATION Duration of the hostname caching.

Constructor Summary

Constructors

Constructor and Description
EventBuilder() Creates a new EventBuilder to prepare a new Event.
EventBuilder(UUID eventId) Creates a new EventBuilder to prepare a new Event.

Method Summary

Methods

Modifier and Type	Method and Description
EventBuilder	addExtra(String extraName, Object extraValue) Adds an extra property to the event.
EventBuilder	addSentryInterface(SentryInterface sentryInterface) Adds a SentryInterface to the event.
EventBuilder	addTag(String tagKey, String tagValue) Adds a tag to an event.
Event	build() Finalises the Event and returns it.
EventBuilder	generateChecksum(String contentToChecksum) Generates a checksum from a given content and set it to the current event.
EventBuilder	setChecksum(String checksum) Sets the checksum for the current event.
EventBuilder	setCulprit(StackTraceElement frame) Sets the culprit in the event based on a StackTraceElement.
EventBuilder	setCulprit(String culprit) Sets the culprit in the event.
EventBuilder	setLevel(Event.Level level) Sets the log level in the event.
EventBuilder	setLogger(String logger) Sets the logger in the event.
EventBuilder	setMessage(String message) Sets the message in the event.
EventBuilder	setPlatform(String platform) Sets the platform in the event.
EventBuilder	setServerName(String serverName) Sets the serverName in the event.
EventBuilder	setTimestamp(Date timestamp) Sets the timestamp in the event.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PLATFORM

public static final String DEFAULT_PLATFORM

Default platform if it isn't set manually.

See Also:

Constant Field Values

DEFAULT_HOSTNAME

public static final String DEFAULT_HOSTNAME

Default hostname if it isn't set manually (or can't be determined).

See Also:

Constant Field Values

HOSTNAME_CACHE_DURATION

public static final long HOSTNAME_CACHE_DURATION

Duration of the hostname caching.

See Also:

HostnameCache

Constructor Detail

EventBuilder

public EventBuilder()

Creates a new EventBuilder to prepare a new Event.

Automatically generates the id of the new event.

EventBuilder

public EventBuilder(UUID eventId)

Creates a new EventBuilder to prepare a new Event.

Parameters:

eventId - unique identifier for the new event.

Method Detail

setMessage

public EventBuilder setMessage(String message)

Sets the message in the event.

Parameters:

message - message of the event.

Returns:

the current EventBuilder for chained calls.

setTimestamp

public EventBuilder setTimestamp(Date timestamp)

Sets the timestamp in the event.

Parameters:

timestamp - timestamp of the event.

Returns:

the current EventBuilder for chained calls.

setLevel

public EventBuilder setLevel(Event.Level level)

Sets the log level in the event.

Parameters:

level - log level of the event.

Returns:

the current EventBuilder for chained calls.

setLogger

public EventBuilder setLogger(String logger)

Sets the logger in the event.

Parameters:

logger - logger of the event.

Returns:

the current EventBuilder for chained calls.

setPlatform

public EventBuilder setPlatform(String platform)

Sets the platform in the event.

Parameters:

platform - platform of the event.

Returns:

the current EventBuilder for chained calls.

setCulprit

public EventBuilder setCulprit(StackTraceElement frame)

Sets the culprit in the event based on a StackTraceElement.

Parameters:

frame - stack frame during which the event was captured.

Returns:

the current EventBuilder for chained calls.

setCulprit

public EventBuilder setCulprit(String culprit)

Sets the culprit in the event.

Parameters:

culprit - culprit.

Returns:

the current EventBuilder for chained calls.

addTag

public EventBuilder addTag(String tagKey,
                  String tagValue)

Adds a tag to an event.

This allows to set a tag value in different contexts.

Parameters:

tagKey - name of the tag.

tagValue - value of the tag.

Returns:

the current EventBuilder for chained calls.

setServerName

public EventBuilder setServerName(String serverName)

Sets the serverName in the event.

Parameters:

serverName - name of the server responsible for the event.

Returns:

the current EventBuilder for chained calls.

addExtra

public EventBuilder addExtra(String extraName,
                    Object extraValue)

Adds an extra property to the event.

Parameters:

extraName - name of the extra property.

extraValue - value of the extra property.

Returns:

the current EventBuilder for chained calls.

generateChecksum

public EventBuilder generateChecksum(String contentToChecksum)

Generates a checksum from a given content and set it to the current event.

Parameters:

contentToChecksum - content to checksum.

Returns:

the current EventBuilder for chained calls.

setChecksum

public EventBuilder setChecksum(String checksum)

Sets the checksum for the current event.

It's recommended to rely instead on the checksum system provided by Sentry.

Parameters:

checksum - checksum for the event.

Returns:

the current EventBuilder for chained calls.

addSentryInterface

public EventBuilder addSentryInterface(SentryInterface sentryInterface)

Adds a SentryInterface to the event.

If a SentryInterface with the same interface name has already been added, the new one will replace the old one.

Parameters:

sentryInterface - sentry interface to add to the event.

Returns:

the current EventBuilder for chained calls.

build

public Event build()

Finalises the Event and returns it.

This operations will automatically set the missing values and make the mutable values immutable.

Returns:

an immutable event.