io.sentry

Interface IHub

All Known Implementing Classes:

Hub, HubAdapter

public interface IHub

SDK API contract which combines a client and scope management

Method Summary

Modifier and Type	Method and Description
default void	addBreadcrumb(Breadcrumb breadcrumb) Adds a breadcrumb to the current Scope
void	addBreadcrumb(Breadcrumb breadcrumb, @Nullable java.lang.Object hint) Adds a breadcrumb to the current Scope
default void	addBreadcrumb(@NotNull java.lang.String message) Adds a breadcrumb to the current Scope
default void	addBreadcrumb(@NotNull java.lang.String message, @NotNull java.lang.String category) Adds a breadcrumb to the current Scope
void	bindClient(ISentryClient client) Binds a different client to the hub
default SentryId	captureEnvelope(SentryEnvelope envelope) Captures an envelope.
SentryId	captureEnvelope(SentryEnvelope envelope, @Nullable java.lang.Object hint) Captures an envelope.
default SentryId	captureEvent(SentryEvent event) Captures the event.
SentryId	captureEvent(SentryEvent event, @Nullable java.lang.Object hint) Captures the event.
default SentryId	captureException(java.lang.Throwable throwable) Captures the exception.
SentryId	captureException(java.lang.Throwable throwable, @Nullable java.lang.Object hint) Captures the exception.
default SentryId	captureMessage(java.lang.String message) Captures the message.
SentryId	captureMessage(java.lang.String message, SentryLevel level) Captures the message.
void	clearBreadcrumbs() Deletes current breadcrumbs from the current scope.
IHub	clone() Clones the Hub
void	close() Flushes out the queue for up to timeout seconds and disable the Hub.
void	configureScope(ScopeCallback callback) Configures the scope through the callback.
void	endSession() Ends the current session
void	flush(long timeoutMillis) Flushes events queued up, but keeps the Hub enabled.
SentryId	getLastEventId() Last event id recorded in the current scope
boolean	isEnabled() Check if the Hub is enabled/active.
void	popScope() Removes the first scope
void	pushScope() Pushes a new scope while inheriting the current scope's data.
void	removeExtra(java.lang.String key) Removes the extra key to an arbitrary value to the current Scope
void	removeTag(java.lang.String key) Removes the tag to a string value to the current Scope
void	setExtra(java.lang.String key, java.lang.String value) Sets the extra key to an arbitrary value to the current Scope, overwriting a potential previous value
void	setFingerprint(java.util.List<java.lang.String> fingerprint) Sets the fingerprint to group specific events together to the current Scope.
void	setLevel(SentryLevel level) Sets the level of all events sent within current Scope
void	setTag(java.lang.String key, java.lang.String value) Sets the tag to a string value to the current Scope, overwriting a potential previous value
void	setTransaction(java.lang.String transaction) Sets the name of the current transaction to the current Scope.
void	setUser(User user) Shallow merges user configuration (email, username, etc) to the current Scope.
void	startSession() Starts a new session.
void	withScope(ScopeCallback callback) Runs the callback with a new scope which gets dropped at the end

Method Detail

isEnabled

boolean isEnabled()

Check if the Hub is enabled/active.

Returns:

true if its enabled or false otherwise.

captureEvent

SentryId captureEvent(SentryEvent event,
                      @Nullable
                      @Nullable java.lang.Object hint)

Captures the event.

Parameters:

event - the event

hint - SDK specific but provides high level information about the origin of the event

Returns:

The Id (SentryId object) of the event

captureEvent

default SentryId captureEvent(SentryEvent event)

Captures the event.

Parameters:

event - the event

Returns:

The Id (SentryId object) of the event

captureMessage

default SentryId captureMessage(java.lang.String message)

Captures the message.

Parameters:

message - The message to send.

Returns:

The Id (SentryId object) of the event

captureMessage

SentryId captureMessage(java.lang.String message,
                        SentryLevel level)

Captures the message.

Parameters:

message - The message to send.

level - The message level.

Returns:

The Id (SentryId object) of the event

captureEnvelope

SentryId captureEnvelope(SentryEnvelope envelope,
                         @Nullable
                         @Nullable java.lang.Object hint)

Captures an envelope.

Parameters:

envelope - the SentryEnvelope to send.

hint - SDK specific but provides high level information about the origin of the event

Returns:

The Id (SentryId object) of the event

captureEnvelope

default SentryId captureEnvelope(SentryEnvelope envelope)

Captures an envelope.

Parameters:

envelope - the SentryEnvelope to send.

Returns:

The Id (SentryId object) of the event

captureException

SentryId captureException(java.lang.Throwable throwable,
                          @Nullable
                          @Nullable java.lang.Object hint)

Captures the exception.

Parameters:

throwable - The exception.

hint - SDK specific but provides high level information about the origin of the event

Returns:

The Id (SentryId object) of the event

captureException

default SentryId captureException(java.lang.Throwable throwable)

Captures the exception.

Parameters:

throwable - The exception.

Returns:

The Id (SentryId object) of the event

startSession

void startSession()

Starts a new session. If there's a running session, it ends it before starting the new one.

endSession

void endSession()

Ends the current session

close

void close()

Flushes out the queue for up to timeout seconds and disable the Hub.

addBreadcrumb

void addBreadcrumb(Breadcrumb breadcrumb,
                   @Nullable
                   @Nullable java.lang.Object hint)

Adds a breadcrumb to the current Scope

Parameters:

breadcrumb - the breadcrumb

hint - SDK specific but provides high level information about the origin of the event

addBreadcrumb

default void addBreadcrumb(Breadcrumb breadcrumb)

Adds a breadcrumb to the current Scope

Parameters:

breadcrumb - the breadcrumb

addBreadcrumb

default void addBreadcrumb(@NotNull
                           @NotNull java.lang.String message)

Adds a breadcrumb to the current Scope

Parameters:

message - rendered as text and the whitespace is preserved.

addBreadcrumb

default void addBreadcrumb(@NotNull
                           @NotNull java.lang.String message,
                           @NotNull
                           @NotNull java.lang.String category)

Adds a breadcrumb to the current Scope

Parameters:

message - rendered as text and the whitespace is preserved.

category - Categories are dotted strings that indicate what the crumb is or where it comes from.

setLevel

void setLevel(SentryLevel level)

Sets the level of all events sent within current Scope

Parameters:

level - the Sentry level

setTransaction

void setTransaction(java.lang.String transaction)

Sets the name of the current transaction to the current Scope.

Parameters:

transaction - the transaction

setUser

void setUser(User user)

Shallow merges user configuration (email, username, etc) to the current Scope.

Parameters:

user - the user

setFingerprint

void setFingerprint(java.util.List<java.lang.String> fingerprint)

Sets the fingerprint to group specific events together to the current Scope.

Parameters:

fingerprint - the fingerprints

clearBreadcrumbs

void clearBreadcrumbs()

Deletes current breadcrumbs from the current scope.

setTag

void setTag(java.lang.String key,
            java.lang.String value)

Sets the tag to a string value to the current Scope, overwriting a potential previous value

Parameters:

key - the key

value - the value

removeTag

void removeTag(java.lang.String key)

Removes the tag to a string value to the current Scope

Parameters:

key - the key

setExtra

void setExtra(java.lang.String key,
              java.lang.String value)

Sets the extra key to an arbitrary value to the current Scope, overwriting a potential previous value

Parameters:

key - the key

value - the value

removeExtra

void removeExtra(java.lang.String key)

Removes the extra key to an arbitrary value to the current Scope

Parameters:

key - the key

getLastEventId

SentryId getLastEventId()

Last event id recorded in the current scope

Returns:

last SentryId

pushScope

void pushScope()

Pushes a new scope while inheriting the current scope's data.

popScope

void popScope()

Removes the first scope

withScope

void withScope(ScopeCallback callback)

Runs the callback with a new scope which gets dropped at the end

Parameters:

callback - the callback

configureScope

void configureScope(ScopeCallback callback)

Configures the scope through the callback.

Parameters:

callback - The configure scope callback.

bindClient

void bindClient(ISentryClient client)

Binds a different client to the hub

Parameters:

client - the client.

flush

void flush(long timeoutMillis)

Flushes events queued up, but keeps the Hub enabled. Not implemented yet.

Parameters:

timeoutMillis - time in milliseconds

clone

IHub clone()

Clones the Hub

Returns:

the cloned Hub