SentryClient (Sentry-Java client 1.7.22 API)

java.lang.Object
- io.sentry.SentryClient

```
public class SentryClient
extends Object
```
Sentry client, for sending Events to a Sentry server.
It is recommended that you create an instance of Sentry through SentryClientFactory.createSentryClient(io.sentry.dsn.Dsn), which will use the best factory available.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`dist` Identifies the distribution of the application.
`protected String`	`environment` Identifies the environment the application is running in.
`protected Map<String,Object>`	`extra` Extra data to be sent to sentry.
`protected Set<String>`	`mdcTags` Tags to extract from the MDC system and set on `Event`s, where applicable.
`protected String`	`release` Identifies the version of the application.
`protected String`	`serverName` Server name to be sent to sentry.
`protected Map<String,String>`	`tags` Additional tags to be sent to sentry.

Constructor Summary

Constructors
Constructor and Description

SentryClient(Connection connection, ContextManager contextManager)
Constructs a SentryClient instance using the provided connection.

Constructors
Constructor and Description
`SentryClient(Connection connection, ContextManager contextManager)` Constructs a `SentryClient` instance using the provided connection.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBuilderHelper(EventBuilderHelper builderHelper)` Adds a builder helper.
`void`	`addEventSendCallback(EventSendCallback eventSendCallback)` Add a callback that is called after an `Event` is sent to Sentry.
`void`	`addExtra(String name, Object value)` Add to the extra data that will be sent with all future `Event`s.
`void`	`addExtraTag(String extraName)` Deprecated. prefer `addMdcTag(String)`
`void`	`addMdcTag(String tagName)` Add a tag to extract from the MDC system and set on `Event`s, where applicable.
`void`	`addShouldSendEventCallback(ShouldSendEventCallback shouldSendEventCallback)` Add a callback that is called before an `Event` is sent to Sentry.
`void`	`addTag(String name, String value)` Add a tag that will be sent with all future `Event`s.
`void`	`clearContext()` Clears the `ContextManager` data.
`void`	`closeConnection()` Closes the connection for the `SentryClient` instance.
`List<EventBuilderHelper>`	`getBuilderHelpers()`
`Context`	`getContext()`
`String`	`getDist()`
`String`	`getEnvironment()`
`Map<String,Object>`	`getExtra()`
`Set<String>`	`getMdcTags()`
`String`	`getRelease()`
`String`	`getServerName()`
`Map<String,String>`	`getTags()`
`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`	`sendEvent(EventBuilder eventBuilder)` Builds and sends an `Event` to the Sentry server.
`void`	`sendException(Throwable throwable)` Sends an exception (or throwable) to the Sentry server.
`void`	`sendMessage(String message)` Sends a message to the Sentry server.
`void`	`setDist(String dist)`
`void`	`setEnvironment(String environment)`
`void`	`setExtra(Map<String,Object> extra)` Set the extra data that will be sent with all future `Event`s.
`void`	`setExtraTags(Set<String> extraTags)` Deprecated. prefer `setMdcTags(Set)`
`void`	`setMdcTags(Set<String> mdcTags)` Set the tags to extract from the MDC system and set on `Event`s, where applicable.
`void`	`setRelease(String release)`
`void`	`setServerName(String serverName)`
`void`	`setTags(Map<String,String> tags)` Set the tags that will be sent with all future `Event`s.
`protected void`	`setupUncaughtExceptionHandler()` Setup and store the `SentryUncaughtExceptionHandler` so that it can be disabled on `closeConnection()`.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - release
```
protected String release
```
    Identifies the version of the application.
    Might be null in which case the release information will not be sent with the event.
  - dist
```
protected String dist
```
    Identifies the distribution of the application.
    Might be null in which case the release distribution will not be sent with the event.
  - environment
```
protected String environment
```
    Identifies the environment the application is running in.
    Might be null in which case the environment information will not be sent with the event.
  - serverName
```
protected String serverName
```
    Server name to be sent to sentry.
    Might be null in which case the hostname is found via a reverse DNS lookup.
  - tags
```
protected Map<String,String> tags
```
    Additional tags to be sent to sentry.
    Might be empty in which case no tags are added to the events.
  - mdcTags
```
protected Set<String> mdcTags
```
    Tags to extract from the MDC system and set on Events, where applicable.
  - extra
```
protected Map<String,Object> extra
```
    Extra data to be sent to sentry.
    Might be empty in which case no extra data is added to the events.
- Constructor Detail
  - SentryClient
```
public SentryClient(Connection connection,
            ContextManager contextManager)
```
    Constructs a SentryClient instance using the provided connection. Note that the most recently constructed instance is stored statically so it can be used with the static helper methods.
    
    Parameters:
    connection - Underlying Connection instance to use for sending events
    contextManager - ContextManager instance to use for storing contextual data
- Method Detail
  - 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.
  - sendEvent
```
public void sendEvent(EventBuilder eventBuilder)
```
    Builds and sends an Event to the Sentry server.
    
    Parameters:
    eventBuilder - EventBuilder 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(Throwable throwable)
```
    Sends an exception (or throwable) to the Sentry server.
    The exception will be logged at the Event.Level#ERROR level.
    
    Parameters:
    throwable - 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 List<EventBuilderHelper> getBuilderHelpers()
```
  - closeConnection
```
public void closeConnection()
```
    Closes the connection for the SentryClient instance.
  - clearContext
```
public void clearContext()
```
    Clears the ContextManager data.
  - getContext
```
public Context getContext()
```
  - getRelease
```
public String getRelease()
```
  - getDist
```
public String getDist()
```
  - getEnvironment
```
public String getEnvironment()
```
  - getServerName
```
public String getServerName()
```
  - getTags
```
public Map<String,String> getTags()
```
  - getMdcTags
```
public Set<String> getMdcTags()
```
  - getExtra
```
public Map<String,Object> getExtra()
```
  - setRelease
```
public void setRelease(String release)
```
  - setDist
```
public void setDist(String dist)
```
  - setEnvironment
```
public void setEnvironment(String environment)
```
  - setServerName
```
public void setServerName(String serverName)
```
  - addTag
```
public void addTag(String name,
          String value)
```
    Add a tag that will be sent with all future Events.
    
    Parameters:
    name - Tag name
    value - Tag value
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Set the tags that will be sent with all future Events.
    
    Parameters:
    tags - Map of tags
  - setExtraTags
```
@Deprecated
public void setExtraTags(Set<String> extraTags)
```
    Deprecated. prefer setMdcTags(Set)
    
    Set the tags to extract from the MDC system and set on Events, where applicable.
    
    Parameters:
    extraTags - Set of tags to extract from the MDC system
  - setMdcTags
```
public void setMdcTags(Set<String> mdcTags)
```
    Set the tags to extract from the MDC system and set on Events, where applicable.
    
    Parameters:
    mdcTags - Set of tags to extract from the MDC system
  - addExtraTag
```
@Deprecated
public void addExtraTag(String extraName)
```
    Deprecated. prefer addMdcTag(String)
    
    Add a tag to extract from the MDC system and set on Events, where applicable.
    
    Parameters:
    extraName - Tag name to extract from the MDC system
  - addMdcTag
```
public void addMdcTag(String tagName)
```
    Add a tag to extract from the MDC system and set on Events, where applicable.
    
    Parameters:
    tagName - Tag name to extract from the MDC system
  - addExtra
```
public void addExtra(String name,
            Object value)
```
    Add to the extra data that will be sent with all future Events.
    
    Parameters:
    name - Data name
    value - Data value
  - setExtra
```
public void setExtra(Map<String,Object> extra)
```
    Set the extra data that will be sent with all future Events.
    
    Parameters:
    extra - Map of extra data
  - addEventSendCallback
```
public void addEventSendCallback(EventSendCallback eventSendCallback)
```
    Add a callback that is called after an Event is sent to Sentry.
    
    Parameters:
    eventSendCallback - callback instance
  - addShouldSendEventCallback
```
public void addShouldSendEventCallback(ShouldSendEventCallback shouldSendEventCallback)
```
    Add a callback that is called before an Event is sent to Sentry.
    
    Parameters:
    shouldSendEventCallback - callback instance
  - setupUncaughtExceptionHandler
```
protected void setupUncaughtExceptionHandler()
```
    Setup and store the SentryUncaughtExceptionHandler so that it can be disabled on closeConnection().
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SentryClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

release

dist

environment

serverName

tags

mdcTags

extra

Constructor Detail

SentryClient

Method Detail

runBuilderHelpers

sendEvent

sendEvent

sendMessage

sendException

removeBuilderHelper

addBuilderHelper

getBuilderHelpers

closeConnection

clearContext

getContext

getRelease

getDist

getEnvironment

getServerName

getTags

getMdcTags

getExtra

setRelease

setDist

setEnvironment

setServerName

addTag

setTags

setExtraTags

setMdcTags

addExtraTag

addMdcTag

addExtra

setExtra

addEventSendCallback

addShouldSendEventCallback

setupUncaughtExceptionHandler

toString