SentryClient (Sentry-Java client 1.2.0 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 Set<String>`	`extraTags` Extras to extract and use as tags, 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`	`addExtraTag(String extraName)` Add an extra to extract and send as tags on all future `Event`s, where applicable.
`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()`
`Set<String>`	`getExtraTags()`
`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`	`setExtraTags(Set<String> extraTags)` Set the extras to extract and send as tags on all future `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.
`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 sent.
  - extraTags
```
protected Set<String> extraTags
```
    Extras to extract and use as tags, where applicable.
    For example: when using a logging integration any MDC keys that are in the extraTags set will be extracted and set as tags on the Event.
- 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()
```
  - getExtraTags
```
public Set<String> getExtraTags()
```
  - 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
```
public void setExtraTags(Set<String> extraTags)
```
    Set the extras to extract and send as tags on all future Events, where applicable.
    For example: when using a logging integration any MDC keys that are in the extraTags set will be extracted and set as tags on the Event.
    
    Parameters:
    extraTags - Set of extras
  - addExtraTag
```
public void addExtraTag(String extraName)
```
    Add an extra to extract and send as tags on all future Events, where applicable.
    For example: when using a logging integration any MDC keys that are in the extraTags set will be extracted and set as tags on the Event.
    
    Parameters:
    extraName - Extra name
  - 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

extraTags

Constructor Detail

SentryClient

Method Detail

runBuilderHelpers

sendEvent

sendEvent

sendMessage

sendException

removeBuilderHelper

addBuilderHelper

getBuilderHelpers

closeConnection

clearContext

getContext

getRelease

getDist

getEnvironment

getServerName

getTags

getExtraTags

setRelease

setDist

setEnvironment

setServerName

addTag

setTags

setExtraTags

addExtraTag

toString