io.sentry

Class Sentry

java.lang.Object

io.sentry.Sentry

public final class Sentry
extends Object

Sentry provides easy access to a statically stored SentryClient instance.

Method Summary

Methods

Modifier and Type	Method and Description
static void	capture(Event event) Send an Event using the statically stored SentryClient instance.
static void	capture(EventBuilder eventBuilder) Builds and sends an Event to the Sentry server using the statically stored SentryClient instance.
static void	capture(String message) Sends a message to the Sentry server using the statically stored SentryClient instance.
static void	capture(Throwable throwable) Sends an exception (or throwable) to the Sentry server using the statically stored SentryClient instance.
static void	clearContext() Clears the current context.
static void	close() Close the stored SentryClient's connections and remove it from static storage.
static Context	getContext() Returns the Context on the statically stored SentryClient.
static SentryClient	getStoredClient() Returns the last statically stored SentryClient instance.
static SentryClient	init() Initialize and statically store a SentryClient by looking up a Dsn and automatically choosing a SentryClientFactory.
static SentryClient	init(SentryClientFactory sentryClientFactory) Initialize and statically store a SentryClient by looking up a Dsn and using the provided SentryClientFactory.
static SentryClient	init(String dsn) Initialize and statically store a SentryClient by using the provided Dsn and automatically choosing a SentryClientFactory.
static SentryClient	init(String dsn, SentryClientFactory sentryClientFactory) Initialize and statically store a SentryClient by using the provided Dsn and SentryClientFactory.
static void	record(Breadcrumb breadcrumb) Deprecated. use getContext() and then Context.recordBreadcrumb(Breadcrumb).
static void	setStoredClient(SentryClient client) Set the statically stored SentryClient instance.
static void	setUser(User user) Deprecated. use getContext() and then Context.setUser(User).

Methods inherited from class java.lang.Object

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

Method Detail

init

public static SentryClient init()

Initialize and statically store a SentryClient by looking up a Dsn and automatically choosing a SentryClientFactory.

Returns:

SentryClient

init

public static SentryClient init(SentryClientFactory sentryClientFactory)

Initialize and statically store a SentryClient by looking up a Dsn and using the provided SentryClientFactory.

Parameters:

sentryClientFactory - SentryClientFactory to use.

Returns:

SentryClient

init

public static SentryClient init(String dsn)

Initialize and statically store a SentryClient by using the provided Dsn and automatically choosing a SentryClientFactory.

Parameters:

dsn - Data Source Name of the Sentry server.

Returns:

SentryClient

init

public static SentryClient init(String dsn,
                SentryClientFactory sentryClientFactory)

Initialize and statically store a SentryClient by using the provided Dsn and SentryClientFactory.

Note that the Dsn or SentryClientFactory may be null, at which a best effort attempt is made to look up or choose the best value(s).

Parameters:

dsn - Data Source Name of the Sentry server.

sentryClientFactory - SentryClientFactory to use.

Returns:

SentryClient

getStoredClient

public static SentryClient getStoredClient()

Returns the last statically stored SentryClient instance. If no instance is already stored, the init() method will be called one time in an attempt to create a SentryClient.

Returns:

statically stored SentryClient instance, or null.

getContext

public static Context getContext()

Returns the Context on the statically stored SentryClient.

Returns:

the Context on the statically stored SentryClient.

clearContext

public static void clearContext()

Clears the current context.

setStoredClient

public static void setStoredClient(SentryClient client)

Set the statically stored SentryClient instance.

Parameters:

client - SentryClient instance to store.

capture

public static void capture(Event event)

Send an Event using the statically stored SentryClient instance.

Parameters:

event - Event to send to the Sentry server.

capture

public static void capture(Throwable throwable)

Sends an exception (or throwable) to the Sentry server using the statically stored SentryClient instance.

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

Parameters:

throwable - exception to send to Sentry.

capture

public static void capture(String message)

Sends a message to the Sentry server using the statically stored SentryClient instance.

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

Parameters:

message - message to send to Sentry.

capture

public static void capture(EventBuilder eventBuilder)

Builds and sends an Event to the Sentry server using the statically stored SentryClient instance.

Parameters:

eventBuilder - EventBuilder to send to Sentry.

record

@Deprecated
public static void record(Breadcrumb breadcrumb)

Deprecated. use getContext() and then Context.recordBreadcrumb(Breadcrumb).

Record a Breadcrumb.

Parameters:

breadcrumb - Breadcrumb to record.

setUser

@Deprecated
public static void setUser(User user)

Deprecated. use getContext() and then Context.setUser(User).

Set the User in the current context.

Parameters:

user - User to store.

close

public static void close()

Close the stored SentryClient's connections and remove it from static storage.