SentryOptions (sentry-core 2.2.1 API)

java.lang.Object
- io.sentry.core.SentryOptions

public class SentryOptions
extends java.lang.Object

Sentry SDK options

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SentryOptions.BeforeBreadcrumbCallback` The BeforeBreadcrumb callback
`static interface`	`SentryOptions.BeforeSendCallback` The BeforeSend callback

Constructor Summary

Constructors
Constructor and Description

SentryOptions()
SentryOptions ctor It adds and set default things

Constructors
Constructor and Description
`SentryOptions()` SentryOptions ctor It adds and set default things

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEventProcessor(@NotNull EventProcessor eventProcessor)` Adds an event processor
`void`	`addInAppExclude(@NotNull java.lang.String exclude)` Adds an inApp exclude
`void`	`addInAppInclude(@NotNull java.lang.String include)` Adds an inApp include
`void`	`addIntegration(@NotNull Integration integration)` Adds an integration
`@Nullable SentryOptions.BeforeBreadcrumbCallback`	`getBeforeBreadcrumb()` Returns the beforeBreadcrumb callback
`@Nullable SentryOptions.BeforeSendCallback`	`getBeforeSend()` Returns the BeforeSend callback
`@Nullable java.lang.String`	`getCacheDirPath()` Returns the cache dir.
`int`	`getCacheDirSize()` Returns the cache dir.
`int`	`getConnectionTimeoutMillis()` Returns the connection timeout in milliseconds.
`@NotNull SentryLevel`	`getDiagnosticLevel()` Returns the minimum LogLevel
`@Nullable java.lang.String`	`getDist()` Sets the distribution
`java.lang.String`	`getDistinctId()` Returns the distinct Id
`@Nullable java.lang.String`	`getDsn()` Returns the DSN
`@Nullable java.lang.String`	`getEnvironment()` Returns the environment
`@NotNull java.util.List<EventProcessor>`	`getEventProcessors()` Returns the list of event processors
`long`	`getFlushTimeoutMillis()` Returns the flush timeout in millis
`@NotNull java.util.List<java.lang.String>`	`getInAppExcludes()` the list of inApp excludes
`@NotNull java.util.List<java.lang.String>`	`getInAppIncludes()` Returns the inApp includes list
`@NotNull java.util.List<Integration>`	`getIntegrations()` Returns the list of integrations
`@NotNull ILogger`	`getLogger()` Returns the Logger interface
`int`	`getMaxBreadcrumbs()` Returns the max Breadcrumbs Default is 100
`@Nullable java.lang.String`	`getOutboxPath()` Returns the outbox path if cacheDirPath is set
`@Nullable java.net.Proxy`	`getProxy()` Returns the proxy if set
`int`	`getReadTimeoutMillis()` Returns the read timeout in milliseconds
`@Nullable java.lang.String`	`getRelease()` Returns the release
`@Nullable java.lang.Double`	`getSampleRate()` Returns the sample rate Default is null (disabled)
`@Nullable java.lang.String`	`getSentryClientName()` Returns the Sentry client name
`@NotNull ISerializer`	`getSerializer()` Returns the Serializer interface
`@Nullable java.lang.String`	`getServerName()` Gets the default server name to be used in Sentry events.
`int`	`getSessionsDirSize()` Returns the sessions dir size
`@Nullable java.lang.String`	`getSessionsPath()` Returns the sessions path if cacheDirPath is set
`long`	`getSessionTrackingIntervalMillis()` Returns the session tracking interval in millis
`long`	`getShutdownTimeout()` Returns the shutdown timeout in Millis
`@Nullable ITransport`	`getTransport()` Returns the Transport interface
`@Nullable ITransportGate`	`getTransportGate()` Returns the TransportGate interface
`boolean`	`isAttachStacktrace()` Checks if the AttachStacktrace is enabled or not
`boolean`	`isAttachThreads()` Checks if the AttachThreads is enabled or not
`boolean`	`isBypassSecurity()` Returns whether to ignore TLS errors
`boolean`	`isDebug()` Check if debug mode is ON Default is OFF
`boolean`	`isEnableNdk()` Check if NDK is ON or OFF Default is ON
`boolean`	`isEnableSessionTracking()` Returns if the automatic session tracking is enabled or not
`boolean`	`isEnableUncaughtExceptionHandler()` Checks if the default UncaughtExceptionHandlerIntegration is enabled or not.
`void`	`setAttachStacktrace(boolean attachStacktrace)` Sets the attachStacktrace to enabled or disabled
`void`	`setAttachThreads(boolean attachThreads)` Sets the attachThreads to enabled or disabled
`void`	`setBeforeBreadcrumb(@Nullable SentryOptions.BeforeBreadcrumbCallback beforeBreadcrumb)` Sets the beforeBreadcrumb callback
`void`	`setBeforeSend(@Nullable SentryOptions.BeforeSendCallback beforeSend)` Sets the beforeSend callback
`void`	`setBypassSecurity(boolean bypassSecurity)` Sets whether to ignore TLS errors
`void`	`setCacheDirPath(@Nullable java.lang.String cacheDirPath)` Sets the cache dir.
`void`	`setCacheDirSize(int cacheDirSize)` Sets the cache dir.
`void`	`setConnectionTimeoutMillis(int connectionTimeoutMillis)` Sets the connection timeout in milliseconds.
`void`	`setDebug(boolean debug)` Sets the debug mode to ON or OFF Default is OFF
`void`	`setDiagnosticLevel(@Nullable SentryLevel diagnosticLevel)` Sets the minimum LogLevel if null, it uses the default min.
`void`	`setDist(@Nullable java.lang.String dist)` Sets the distribution
`void`	`setDistinctId(java.lang.String distinctId)` Sets the distinct Id
`void`	`setDsn(@Nullable java.lang.String dsn)` Sets the DSN
`void`	`setEnableNdk(boolean enableNdk)` Sets NDK to ON or OFF
`void`	`setEnableSessionTracking(boolean enableSessionTracking)` Enable or disable the automatic session tracking
`void`	`setEnableUncaughtExceptionHandler(boolean enableUncaughtExceptionHandler)` Enable or disable the default UncaughtExceptionHandlerIntegration.
`void`	`setEnvironment(@Nullable java.lang.String environment)` Sets the environment
`void`	`setFlushTimeoutMillis(long flushTimeoutMillis)` Sets the flush timeout in millis
`void`	`setLogger(@Nullable ILogger logger)` Sets the Logger interface if null, logger will be NoOp
`void`	`setMaxBreadcrumbs(int maxBreadcrumbs)` Sets the max breadcrumbs Default is 100
`void`	`setProxy(@Nullable java.net.Proxy proxy)` Sets the proxy
`void`	`setReadTimeoutMillis(int readTimeoutMillis)` Sets the read timeout in milliseconds
`void`	`setRelease(@Nullable java.lang.String release)` Sets the release
`void`	`setSampleRate(java.lang.Double sampleRate)` Sets the sampleRate Can be anything between 0.01 and 1.0 or null (default), to disable it.
`void`	`setSentryClientName(@Nullable java.lang.String sentryClientName)` Sets the Sentry client name
`void`	`setSerializer(@Nullable ISerializer serializer)` Sets the Serializer interface if null, Serializer will be NoOp
`void`	`setServerName(@Nullable java.lang.String serverName)` Sets the default server name to be used in Sentry events.
`void`	`setSessionsDirSize(int sessionsDirSize)` Sets the sessions dir size
`void`	`setSessionTrackingIntervalMillis(long sessionTrackingIntervalMillis)` Sets the session tracking interval in millis
`void`	`setShutdownTimeout(long shutdownTimeoutMillis)` Sets the shutdown timeout in Millis Default is 2000 = 2s
`void`	`setTransport(@Nullable ITransport transport)` Sets the Transport interface
`void`	`setTransportGate(@Nullable ITransportGate transportGate)` Sets the TransportGate interface

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

- Constructor Detail
  - SentryOptions
```
public SentryOptions()
```
    SentryOptions ctor It adds and set default things
- Method Detail
  - addEventProcessor
```
public void addEventProcessor(@NotNull
                              @NotNull EventProcessor eventProcessor)
```
    Adds an event processor
    
    Parameters:
    
    eventProcessor - the event processor
  - getEventProcessors
```
@NotNull
public @NotNull java.util.List<EventProcessor> getEventProcessors()
```
    Returns the list of event processors
    
    Returns:
    
    the event processor list
  - addIntegration
```
public void addIntegration(@NotNull
                           @NotNull Integration integration)
```
    Adds an integration
    
    Parameters:
    
    integration - the integration
  - getIntegrations
```
@NotNull
public @NotNull java.util.List<Integration> getIntegrations()
```
    Returns the list of integrations
    
    Returns:
    
    the integration list
  - getDsn
```
@Nullable
public @Nullable java.lang.String getDsn()
```
    Returns the DSN
    
    Returns:
    
    the DSN or null if not set
  - setDsn
```
public void setDsn(@Nullable
                   @Nullable java.lang.String dsn)
```
    Sets the DSN
    
    Parameters:
    
    dsn - the DSN
  - isDebug
```
public boolean isDebug()
```
    Check if debug mode is ON Default is OFF
    
    Returns:
    
    true if ON or false otherwise
  - setDebug
```
public void setDebug(boolean debug)
```
    Sets the debug mode to ON or OFF Default is OFF
    
    Parameters:
    
    debug - true if ON or false otherwise
  - getLogger
```
@NotNull
public @NotNull ILogger getLogger()
```
    Returns the Logger interface
    
    Returns:
    
    the logger
  - setLogger
```
public void setLogger(@Nullable
                      @Nullable ILogger logger)
```
    Sets the Logger interface if null, logger will be NoOp
    
    Parameters:
    
    logger - the logger interface
  - getDiagnosticLevel
```
@NotNull
public @NotNull SentryLevel getDiagnosticLevel()
```
    Returns the minimum LogLevel
    
    Returns:
    
    the log level
  - setDiagnosticLevel
```
public void setDiagnosticLevel(@Nullable
                               @Nullable SentryLevel diagnosticLevel)
```
    Sets the minimum LogLevel if null, it uses the default min. LogLevel Default is DEBUG
    
    Parameters:
    
    diagnosticLevel - the log level
  - getSerializer
```
@NotNull
public @NotNull ISerializer getSerializer()
```
    Returns the Serializer interface
    
    Returns:
    
    the serializer
  - setSerializer
```
public void setSerializer(@Nullable
                          @Nullable ISerializer serializer)
```
    Sets the Serializer interface if null, Serializer will be NoOp
    
    Parameters:
    
    serializer - the serializer
  - isEnableNdk
```
public boolean isEnableNdk()
```
    Check if NDK is ON or OFF Default is ON
    
    Returns:
    
    true if ON or false otherwise
  - setEnableNdk
```
public void setEnableNdk(boolean enableNdk)
```
    Sets NDK to ON or OFF
    
    Parameters:
    
    enableNdk - true if ON or false otherwise
  - getShutdownTimeout
```
public long getShutdownTimeout()
```
    Returns the shutdown timeout in Millis
    
    Returns:
    
    the timeout in Millis
  - setShutdownTimeout
```
public void setShutdownTimeout(long shutdownTimeoutMillis)
```
    Sets the shutdown timeout in Millis Default is 2000 = 2s
    
    Parameters:
    
    shutdownTimeoutMillis - the shutdown timeout in millis
  - getSentryClientName
```
@Nullable
public @Nullable java.lang.String getSentryClientName()
```
    Returns the Sentry client name
    
    Returns:
    
    the Sentry client name or null if not set
  - setSentryClientName
```
public void setSentryClientName(@Nullable
                                @Nullable java.lang.String sentryClientName)
```
    Sets the Sentry client name
    
    Parameters:
    
    sentryClientName - the Sentry client name
  - getBeforeSend
```
@Nullable
public @Nullable SentryOptions.BeforeSendCallback getBeforeSend()
```
    Returns the BeforeSend callback
    
    Returns:
    
    the beforeSend callback or null if not set
  - setBeforeSend
```
public void setBeforeSend(@Nullable
                          @Nullable SentryOptions.BeforeSendCallback beforeSend)
```
    Sets the beforeSend callback
    
    Parameters:
    
    beforeSend - the beforeSend callback
  - getBeforeBreadcrumb
```
@Nullable
public @Nullable SentryOptions.BeforeBreadcrumbCallback getBeforeBreadcrumb()
```
    Returns the beforeBreadcrumb callback
    
    Returns:
    
    the beforeBreadcrumb callback or null if not set
  - setBeforeBreadcrumb
```
public void setBeforeBreadcrumb(@Nullable
                                @Nullable SentryOptions.BeforeBreadcrumbCallback beforeBreadcrumb)
```
    Sets the beforeBreadcrumb callback
    
    Parameters:
    
    beforeBreadcrumb - the beforeBreadcrumb callback
  - getCacheDirPath
```
@Nullable
public @Nullable java.lang.String getCacheDirPath()
```
    Returns the cache dir. path if set
    
    Returns:
    
    the cache dir. path or null if not set
  - getOutboxPath
```
@Nullable
public @Nullable java.lang.String getOutboxPath()
```
    Returns the outbox path if cacheDirPath is set
    
    Returns:
    
    the outbox path or null if not set
  - getSessionsPath
```
@Nullable
public @Nullable java.lang.String getSessionsPath()
```
    Returns the sessions path if cacheDirPath is set
    
    Returns:
    
    the sessions path or null if not set
  - setCacheDirPath
```
public void setCacheDirPath(@Nullable
                            @Nullable java.lang.String cacheDirPath)
```
    Sets the cache dir. path
    
    Parameters:
    
    cacheDirPath - the cache dir. path
  - getCacheDirSize
```
public int getCacheDirSize()
```
    Returns the cache dir. size Default is 10
    
    Returns:
    
    the cache dir. size
  - setCacheDirSize
```
public void setCacheDirSize(int cacheDirSize)
```
    Sets the cache dir. size Default is 10
    
    Parameters:
    
    cacheDirSize - the cache dir. size
  - getMaxBreadcrumbs
```
public int getMaxBreadcrumbs()
```
    Returns the max Breadcrumbs Default is 100
    
    Returns:
    
    the max breadcrumbs
  - setMaxBreadcrumbs
```
public void setMaxBreadcrumbs(int maxBreadcrumbs)
```
    Sets the max breadcrumbs Default is 100
    
    Parameters:
    
    maxBreadcrumbs - the max breadcrumbs
  - getRelease
```
@Nullable
public @Nullable java.lang.String getRelease()
```
    Returns the release
    
    Returns:
    
    the release or null if not set
  - setRelease
```
public void setRelease(@Nullable
                       @Nullable java.lang.String release)
```
    Sets the release
    
    Parameters:
    
    release - the release
  - getEnvironment
```
@Nullable
public @Nullable java.lang.String getEnvironment()
```
    Returns the environment
    
    Returns:
    
    the environment or null if not set
  - setEnvironment
```
public void setEnvironment(@Nullable
                           @Nullable java.lang.String environment)
```
    Sets the environment
    
    Parameters:
    
    environment - the environment
  - getProxy
```
@Nullable
public @Nullable java.net.Proxy getProxy()
```
    Returns the proxy if set
    
    Returns:
    
    the proxy or null if not set
  - setProxy
```
public void setProxy(@Nullable
                     @Nullable java.net.Proxy proxy)
```
    Sets the proxy
    
    Parameters:
    
    proxy - the proxy
  - getSampleRate
```
@Nullable
public @Nullable java.lang.Double getSampleRate()
```
    Returns the sample rate Default is null (disabled)
    
    Returns:
    
    the sample rate
  - setSampleRate
```
public void setSampleRate(java.lang.Double sampleRate)
```
    Sets the sampleRate Can be anything between 0.01 and 1.0 or null (default), to disable it.
    
    Parameters:
    
    sampleRate - the sample rate
  - getInAppExcludes
```
@NotNull
public @NotNull java.util.List<java.lang.String> getInAppExcludes()
```
    the list of inApp excludes
    
    Returns:
    
    the inApp excludes list
  - addInAppExclude
```
public void addInAppExclude(@NotNull
                            @NotNull java.lang.String exclude)
```
    Adds an inApp exclude
    
    Parameters:
    
    exclude - the inApp exclude module/package
  - getInAppIncludes
```
@NotNull
public @NotNull java.util.List<java.lang.String> getInAppIncludes()
```
    Returns the inApp includes list
    
    Returns:
    
    the inApp includes list
  - addInAppInclude
```
public void addInAppInclude(@NotNull
                            @NotNull java.lang.String include)
```
    Adds an inApp include
    
    Parameters:
    
    include - the inApp include module/package
  - getTransport
```
@Nullable
public @Nullable ITransport getTransport()
```
    Returns the Transport interface
    
    Returns:
    
    the transport
  - setTransport
```
public void setTransport(@Nullable
                         @Nullable ITransport transport)
```
    Sets the Transport interface
    
    Parameters:
    
    transport - the transport
  - getDist
```
@Nullable
public @Nullable java.lang.String getDist()
```
    Sets the distribution
    
    Returns:
    
    the distribution or null if not set
  - setDist
```
public void setDist(@Nullable
                    @Nullable java.lang.String dist)
```
    Sets the distribution
    
    Parameters:
    
    dist - the distribution
  - getTransportGate
```
@Nullable
public @Nullable ITransportGate getTransportGate()
```
    Returns the TransportGate interface
    
    Returns:
    
    the transport gate
  - setTransportGate
```
public void setTransportGate(@Nullable
                             @Nullable ITransportGate transportGate)
```
    Sets the TransportGate interface
    
    Parameters:
    
    transportGate - the transport gate
  - isAttachStacktrace
```
public boolean isAttachStacktrace()
```
    Checks if the AttachStacktrace is enabled or not
    
    Returns:
    
    true if enabled or false otherwise
  - setAttachStacktrace
```
public void setAttachStacktrace(boolean attachStacktrace)
```
    Sets the attachStacktrace to enabled or disabled
    
    Parameters:
    
    attachStacktrace - true if enabled or false otherwise
  - isAttachThreads
```
public boolean isAttachThreads()
```
    Checks if the AttachThreads is enabled or not
    
    Returns:
    
    true if enabled or false otherwise
  - setAttachThreads
```
public void setAttachThreads(boolean attachThreads)
```
    Sets the attachThreads to enabled or disabled
    
    Parameters:
    
    attachThreads - true if enabled or false otherwise
  - isEnableSessionTracking
```
public boolean isEnableSessionTracking()
```
    Returns if the automatic session tracking is enabled or not
    
    Returns:
    
    true if enabled or false otherwise
  - setEnableSessionTracking
```
public void setEnableSessionTracking(boolean enableSessionTracking)
```
    Enable or disable the automatic session tracking
    
    Parameters:
    
    enableSessionTracking - true if enabled or false otherwise
  - getServerName
```
@Nullable
public @Nullable java.lang.String getServerName()
```
    Gets the default server name to be used in Sentry events.
    
    Returns:
    
    the default server name or null if none set
  - setServerName
```
public void setServerName(@Nullable
                          @Nullable java.lang.String serverName)
```
    Sets the default server name to be used in Sentry events.
    
    Parameters:
    
    serverName - the default server name or null if none should be used
  - getSessionsDirSize
```
public int getSessionsDirSize()
```
    Returns the sessions dir size
    
    Returns:
    
    the dir size
  - setSessionsDirSize
```
public void setSessionsDirSize(int sessionsDirSize)
```
    Sets the sessions dir size
    
    Parameters:
    
    sessionsDirSize - the sessions dir size
  - getSessionTrackingIntervalMillis
```
public long getSessionTrackingIntervalMillis()
```
    Returns the session tracking interval in millis
    
    Returns:
    
    the interval in millis
  - setSessionTrackingIntervalMillis
```
public void setSessionTrackingIntervalMillis(long sessionTrackingIntervalMillis)
```
    Sets the session tracking interval in millis
    
    Parameters:
    
    sessionTrackingIntervalMillis - the interval in millis
  - getDistinctId
```
@ApiStatus.Internal
public java.lang.String getDistinctId()
```
    Returns the distinct Id
    
    Returns:
    
    the distinct Id
  - setDistinctId
```
@ApiStatus.Internal
public void setDistinctId(java.lang.String distinctId)
```
    Sets the distinct Id
    
    Parameters:
    
    distinctId - the distinct Id
  - getFlushTimeoutMillis
```
public long getFlushTimeoutMillis()
```
    Returns the flush timeout in millis
    
    Returns:
    
    the timeout in millis
  - setFlushTimeoutMillis
```
public void setFlushTimeoutMillis(long flushTimeoutMillis)
```
    Sets the flush timeout in millis
    
    Parameters:
    
    flushTimeoutMillis - the timeout in millis
  - isEnableUncaughtExceptionHandler
```
public boolean isEnableUncaughtExceptionHandler()
```
    Checks if the default UncaughtExceptionHandlerIntegration is enabled or not.
    
    Returns:
    
    true if enabled or false otherwise.
  - setEnableUncaughtExceptionHandler
```
public void setEnableUncaughtExceptionHandler(boolean enableUncaughtExceptionHandler)
```
    Enable or disable the default UncaughtExceptionHandlerIntegration.
    
    Parameters:
    
    enableUncaughtExceptionHandler - true if enabled or false otherwise.
  - getConnectionTimeoutMillis
```
public int getConnectionTimeoutMillis()
```
    Returns the connection timeout in milliseconds.
    
    Returns:
    
    the connectionTimeoutMillis
  - setConnectionTimeoutMillis
```
public void setConnectionTimeoutMillis(int connectionTimeoutMillis)
```
    Sets the connection timeout in milliseconds.
    
    Parameters:
    
    connectionTimeoutMillis - the connectionTimeoutMillis
  - getReadTimeoutMillis
```
public int getReadTimeoutMillis()
```
    Returns the read timeout in milliseconds
    
    Returns:
    
    the readTimeoutMillis
  - setReadTimeoutMillis
```
public void setReadTimeoutMillis(int readTimeoutMillis)
```
    Sets the read timeout in milliseconds
    
    Parameters:
    
    readTimeoutMillis - the readTimeoutMillis
  - isBypassSecurity
```
public boolean isBypassSecurity()
```
    Returns whether to ignore TLS errors
    
    Returns:
    
    the bypassSecurity
  - setBypassSecurity
```
public void setBypassSecurity(boolean bypassSecurity)
```
    Sets whether to ignore TLS errors
    
    Parameters:
    
    bypassSecurity - the bypassSecurity

Class SentryOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SentryOptions

Method Detail

addEventProcessor

getEventProcessors

addIntegration

getIntegrations

getDsn

setDsn

isDebug

setDebug

getLogger

setLogger

getDiagnosticLevel

setDiagnosticLevel

getSerializer

setSerializer

isEnableNdk

setEnableNdk

getShutdownTimeout

setShutdownTimeout

getSentryClientName

setSentryClientName

getBeforeSend

setBeforeSend

getBeforeBreadcrumb

setBeforeBreadcrumb

getCacheDirPath

getOutboxPath

getSessionsPath

setCacheDirPath

getCacheDirSize

setCacheDirSize

getMaxBreadcrumbs

setMaxBreadcrumbs

getRelease

setRelease

getEnvironment

setEnvironment

getProxy

setProxy

getSampleRate

setSampleRate

getInAppExcludes

addInAppExclude

getInAppIncludes

addInAppInclude

getTransport

setTransport

getDist

setDist

getTransportGate

setTransportGate

isAttachStacktrace

setAttachStacktrace

isAttachThreads

setAttachThreads

isEnableSessionTracking

setEnableSessionTracking

getServerName

setServerName

getSessionsDirSize

setSessionsDirSize

getSessionTrackingIntervalMillis

setSessionTrackingIntervalMillis

getDistinctId

setDistinctId

getFlushTimeoutMillis

setFlushTimeoutMillis

isEnableUncaughtExceptionHandler

setEnableUncaughtExceptionHandler

getConnectionTimeoutMillis

setConnectionTimeoutMillis

getReadTimeoutMillis

setReadTimeoutMillis