io.sentry.context

Class Context

java.lang.Object

io.sentry.context.Context

All Implemented Interfaces:

Serializable

public class Context
extends Object
implements Serializable

Context is used to hold context data (such as Breadcrumbs) so that data may be collected in different parts of an application and then sent together when an exception occurs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Context() Create a new (empty) Context object with the default Breadcrumb limit.
Context(int breadcrumbLimit) Create a new (empty) Context object with the specified Breadcrumb limit.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtra(String name, Object value) Add extra data to the current context.
void	addTag(String name, String value) Add tag to the current context.
void	clear() Clear state from this context.
void	clearBreadcrumbs() Clear all breadcrumbs from this context.
void	clearExtra() Clear all extra data from this context.
void	clearTags() Clear all tags from the current context.
void	clearUser() Clears the current user set on this context.
List<Breadcrumb>	getBreadcrumbs() Return Breadcrumbs attached to this context.
Map<String,Object>	getExtra() Return extra data attached to this context.
UUID	getLastEventId() Get the UUID of the last event sent by this thread, useful for handling user feedback.
Map<String,String>	getTags() Return tags attached to this context.
User	getUser() Gets the current user from the context.
void	recordBreadcrumb(Breadcrumb breadcrumb) Record a single Breadcrumb into this context.
void	removeExtra(String name) Remove an extra data name and value from the current context.
void	removeTag(String name) Remove a tag name and value from the current context.
void	setLastEventId(UUID id) Store the UUID of the last sent event by this thread, useful for handling user feedback.
void	setUser(User user) Store the current user in the context.

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context()

Create a new (empty) Context object with the default Breadcrumb limit.

Context

public Context(int breadcrumbLimit)

Create a new (empty) Context object with the specified Breadcrumb limit.

Parameters:

breadcrumbLimit - Number of Breadcrumb objects to retain in ring buffer.

Method Detail

clear

public void clear()

Clear state from this context.

getBreadcrumbs

public List<Breadcrumb> getBreadcrumbs()

Return Breadcrumbs attached to this context.

Returns:

List of Breadcrumbs.

getTags

public Map<String,String> getTags()

Return tags attached to this context.

Returns:

tags attached to this context.

getExtra

public Map<String,Object> getExtra()

Return extra data attached to this context.

Returns:

extra data attached to this context.

addTag

public void addTag(String name,
          String value)

Add tag to the current context.

Parameters:

name - tag name

value - tag value

removeTag

public void removeTag(String name)

Remove a tag name and value from the current context.

Parameters:

name - tag name to remove

clearTags

public void clearTags()

Clear all tags from the current context.

addExtra

public void addExtra(String name,
            Object value)

Add extra data to the current context.

Parameters:

name - extra name

value - extra value

removeExtra

public void removeExtra(String name)

Remove an extra data name and value from the current context.

Parameters:

name - extra name to remove

clearExtra

public void clearExtra()

Clear all extra data from this context.

recordBreadcrumb

public void recordBreadcrumb(Breadcrumb breadcrumb)

Record a single Breadcrumb into this context.

Parameters:

breadcrumb - Breadcrumb object to record

clearBreadcrumbs

public void clearBreadcrumbs()

Clear all breadcrumbs from this context.

setLastEventId

public void setLastEventId(UUID id)

Store the UUID of the last sent event by this thread, useful for handling user feedback.

Parameters:

id - UUID of the last event sent by this thread.

getLastEventId

public UUID getLastEventId()

Get the UUID of the last event sent by this thread, useful for handling user feedback. Returns null if no event has been sent by this thread or if the event has been cleared. For example the SentryServletRequestListener clears the thread's Context at the end of each request.

Returns:

UUID of the last event sent by this thread.

setUser

public void setUser(User user)

Store the current user in the context.

Parameters:

user - User to store in context.

clearUser

public void clearUser()

Clears the current user set on this context.

getUser

public User getUser()

Gets the current user from the context.

Returns:

User currently stored in context.