net.kencochrane.raven

Class Raven

java.lang.Object

net.kencochrane.raven.Raven

public class Raven
extends Object

Raven is a client for Sentry allowing to send an Event that will be processed and sent to a Sentry server.

It is recommended to create an instance of Raven through RavenFactory.createRavenInstance(net.kencochrane.raven.dsn.Dsn), this will use the best factory available to create a sensible instance of Raven.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Version of this client, the major version is the current supported Sentry protocol, the minor version changes for each release of this project.

Constructor Summary

Constructors

Constructor and Description
Raven()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBuilderHelper(EventBuilderHelper builderHelper) Adds a builder helper.
Set<EventBuilderHelper>	getBuilderHelpers()
Connection	getConnection()
static boolean	isManagingThread() Checks whether the current thread is managed by Raven or not.
void	removeBuilderHelper(EventBuilderHelper builderHelper) Removes a builder helper.
void	runBuilderHelpers(EventBuilder eventBuilder) Runs the EventBuilderHelper against the EventBuilder to obtain additional information with a MDC-like system.
void	sendEvent(Event event) Sends a built Event to the Sentry server.
void	sendException(Exception exception) Sends an exception to the Sentry server.
void	sendMessage(String message) Sends a message to the Sentry server.
void	setConnection(Connection connection)
static void	startManagingThread() Sets the current thread as managed by Raven.
static void	stopManagingThread() Sets the current thread as not managed by Raven.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Version of this client, the major version is the current supported Sentry protocol, the minor version changes for each release of this project.

Constructor Detail

Raven

public Raven()

Method Detail

startManagingThread

public static void startManagingThread()

Sets the current thread as managed by Raven.

The logs generated by Threads managed by Raven will not send logs to Sentry.

stopManagingThread

public static void stopManagingThread()

Sets the current thread as not managed by Raven.

The logs generated by Threads not managed by Raven will send logs to Sentry.

isManagingThread

public static boolean isManagingThread()

Checks whether the current thread is managed by Raven or not.

Returns:

true if the thread is managed by Raven, false otherwise.

runBuilderHelpers

public void runBuilderHelpers(EventBuilder eventBuilder)

Runs the EventBuilderHelper against the EventBuilder to obtain additional information with a MDC-like system.

Parameters:

eventBuilder - event builder containing a not yet finished event.

sendEvent

public void sendEvent(Event event)

Sends a built Event to the Sentry server.

Parameters:

event - event to send to Sentry.

sendMessage

public void sendMessage(String message)

Sends a message to the Sentry server.

The message will be logged at the Event.Level#INFO level.

Parameters:

message - message to send to Sentry.

sendException

public void sendException(Exception exception)

Sends an exception to the Sentry server.

The Exception will be logged at the Event.Level#ERROR level.

Parameters:

exception - exception to send to Sentry.

removeBuilderHelper

public void removeBuilderHelper(EventBuilderHelper builderHelper)

Removes a builder helper.

Parameters:

builderHelper - builder helper to remove.

addBuilderHelper

public void addBuilderHelper(EventBuilderHelper builderHelper)

Adds a builder helper.

Parameters:

builderHelper - builder helper to add.

getBuilderHelpers

public Set<EventBuilderHelper> getBuilderHelpers()

getConnection

public Connection getConnection()

setConnection

public void setConnection(Connection connection)