SentryOptions

open class SentryOptions

Sentry SDK options

Constructors

SentryOptions

open fun SentryOptions()

SentryOptions ctor It adds and set default things

Types

BeforeBreadcrumbCallback

interface BeforeBreadcrumbCallback

The BeforeBreadcrumb callback

BeforeSendCallback

interface BeforeSendCallback

The BeforeSend callback

Proxy

class Proxy

TracesSamplerCallback

interface TracesSamplerCallback

The traces sampler callback.

Functions

addEventProcessor

open fun addEventProcessor(@NotNull() eventProcessor: @NotNull() EventProcessor)

Adds an event processor

addIgnoredExceptionForType

open fun addIgnoredExceptionForType(@NotNull() exceptionType: @NotNull() Class<out Throwable>)

Adds exception type to the list of ignored exceptions.

addInAppExclude

open fun addInAppExclude(@NotNull() exclude: @NotNull() String)

Adds an inApp exclude

addInAppInclude

open fun addInAppInclude(@NotNull() include: @NotNull() String)

Adds an inApp include

addIntegration

open fun addIntegration(@NotNull() integration: @NotNull() Integration)

Adds an integration

addScopeObserver

open fun addScopeObserver(@NotNull() observer: @NotNull() IScopeObserver)

Adds a Scope observer

from

@NotNull()

open fun from(@NotNull() propertiesProvider: @NotNull() PropertiesProvider, @NotNull() logger: @NotNull() ILogger): @NotNull() SentryOptions

Creates SentryOptions from properties provided by a PropertiesProvider.

getOutboxPath

@Nullable()

open fun getOutboxPath(): @Nullable() String

Returns the outbox path if cacheDirPath is set

isAttachServerName

open fun isAttachServerName(): Boolean

Returns if SDK automatically resolves and attaches server name to events.

isAttachStacktrace

open fun isAttachStacktrace(): Boolean

Checks if the AttachStacktrace is enabled or not

isAttachThreads

open fun isAttachThreads(): Boolean

Checks if the AttachThreads is enabled or not

isDebug

open fun isDebug(): Boolean

Check if debug mode is ON Default is OFF

isEnableDeduplication

open fun isEnableDeduplication(): Boolean

Returns if event deduplication is turned on.

isEnableExternalConfiguration

open fun isEnableExternalConfiguration(): Boolean

Returns if loading properties from external sources is enabled.

isEnableNdk

open fun isEnableNdk(): Boolean

Check if NDK is ON or OFF Default is ON

isEnableScopeSync

open fun isEnableScopeSync(): Boolean

Returns if the Java to NDK Scope sync is enabled

isEnableSessionTracking

open fun isEnableSessionTracking(): Boolean

Returns if the automatic session tracking is enabled or not

isEnableUncaughtExceptionHandler

open fun isEnableUncaughtExceptionHandler(): Boolean

Checks if the default UncaughtExceptionHandlerIntegration is enabled or not.

isSendDefaultPii

open fun isSendDefaultPii(): Boolean

isTracingEnabled

open fun isTracingEnabled(): Boolean

Returns if tracing should be enabled.

setTag

open fun setTag(@NotNull() key: @NotNull() String, @NotNull() value: @NotNull() String)

Sets a tag that is applied to all events and transactions.

Properties

attachServerName

private open var attachServerName: Boolean

Automatically resolve server name.

attachStacktrace

private open var attachStacktrace: Boolean

When enabled, stack traces are automatically attached to all threads logged.

attachThreads

private open var attachThreads: Boolean

When enabled, all the threads are automatically attached to all logged events.

beforeBreadcrumb

@Nullable()

private open var beforeBreadcrumb: @Nullable() SentryOptions.BeforeBreadcrumbCallback

This function is called with an SDK specific breadcrumb object before the breadcrumb is addedto the scope.

beforeSend

@Nullable()

private open var beforeSend: @Nullable() SentryOptions.BeforeSendCallback

This function is called with an SDK specific event object and can return a modified eventobject or nothing to skip reporting the event

cacheDirPath

@Nullable()

private open var cacheDirPath: @Nullable() String

The cache dir.

cacheDirSize

private open var cacheDirSize: Int

The cache dir.

connectionTimeoutMillis

private open var connectionTimeoutMillis: Int

connection timeout in milliseconds.

debug

@Nullable()

private open var debug: @Nullable() Boolean

Turns debug mode on or off.

diagnosticLevel

@NotNull()

private open var diagnosticLevel: @NotNull() SentryLevel

minimum LogLevel to be used if debug is enabled

dist

@Nullable()

private open var dist: @Nullable() String

Sets the distribution.

distinctId

private open var distinctId: String

The distinct Id (generated Guid) used for session tracking

dsn

@Nullable()

private open var dsn: @Nullable() String

The DSN tells the SDK where to send the events to.

enableDeduplication

private open var enableDeduplication: Boolean

Enables event deduplication with DuplicateEventDetectionEventProcessor.

enableExternalConfiguration

private open var enableExternalConfiguration: Boolean

Enables loading additional options from external locations like {@code sentry.properties} fileor environment variables, system properties.

enableNdk

private open var enableNdk: Boolean

Turns NDK on or off.

enableScopeSync

private open var enableScopeSync: Boolean

Enable the Java to NDK Scope sync

enableSessionTracking

private open var enableSessionTracking: Boolean

Whether to enable or disable automatic session tracking.

enableUncaughtExceptionHandler

@Nullable()

private open var enableUncaughtExceptionHandler: @Nullable() Boolean

envelopeDiskCache

@NotNull()

private open var envelopeDiskCache: @NotNull() IEnvelopeCache

Reads and caches envelope files in the disk

envelopeReader

@NotNull()

private open var envelopeReader: @NotNull() IEnvelopeReader

Envelope reader interface

environment

@Nullable()

private open var environment: @Nullable() String

Sets the environment.

eventProcessors

@NotNull()

private val eventProcessors: @NotNull() List<EventProcessor>

Are callbacks that run for every event.

flushTimeoutMillis

private open var flushTimeoutMillis: Long

Controls how many seconds to wait before flushing down.

hostnameVerifier

@Nullable()

private open var hostnameVerifier: @Nullable() HostnameVerifier

HostnameVerifier for self-signed certificate trust*

ignoredExceptionsForType

@NotNull()

private val ignoredExceptionsForType: @NotNull() Set<Class<out Throwable>>

Exceptions that once captured will not be sent to Sentry as SentryEvent.

inAppExcludes

@NotNull()

private val inAppExcludes: @NotNull() List<String>

A list of string prefixes of module names that do not belong to the app, but rather third-partypackages.

inAppIncludes

@NotNull()

private val inAppIncludes: @NotNull() List<String>

A list of string prefixes of module names that belong to the app.

integrations

@NotNull()

private val integrations: @NotNull() List<Integration>

Code that provides middlewares, bindings or hooks into certain frameworks or environments,along with code that inserts those bindings and activates them.

logger

@NotNull()

private open var logger: @NotNull() ILogger

Logger interface to log useful debugging information if debug is enabled

maxAttachmentSize

private open var maxAttachmentSize: Long

max attachment size in bytes.

maxBreadcrumbs

private open var maxBreadcrumbs: Int

This variable controls the total amount of breadcrumbs that should be captured Default is 100

maxQueueSize

private open var maxQueueSize: Int

Max.

maxSpans

private open var maxSpans: Int

Maximum number of spans that can be atteched to single transaction.

proxy

@Nullable()

private open var proxy: @Nullable() SentryOptions.Proxy

When set, a proxy can be configured that should be used for outbound requests.

readTimeoutMillis

private open var readTimeoutMillis: Int

read timeout in milliseconds

release

@Nullable()

private open var release: @Nullable() String

Sets the release.

sampleRate

@Nullable()

private open var sampleRate: @Nullable() Double

Configures the sample rate as a percentage of events to be sent in the range of 0.0 to 1.0.

sdkVersion

@Nullable()

private open var sdkVersion: @Nullable() SdkVersion

SdkVersion object that contains the Sentry Client Name and its version

sendDefaultPii

private open var sendDefaultPii: Boolean

whether to send personal identifiable information along with events

sentryClientName

@Nullable()

private open var sentryClientName: @Nullable() String

Sentry client name used for the HTTP authHeader and userAgent egsentry.{language}.{platform}/{version} eg sentry.java.android/2.0.

serializer

@NotNull()

private open var serializer: @NotNull() ISerializer

Serializer interface to serialize/deserialize json events

serverName

private open var serverName: String

The server name used in the Sentry messages.

sessionTrackingIntervalMillis

private open var sessionTrackingIntervalMillis: Long

The session tracking interval in millis.

shutdownTimeout

private open var shutdownTimeout: Long

Controls how many seconds to wait before shutting down.

sslSocketFactory

@Nullable()

private open var sslSocketFactory: @Nullable() SSLSocketFactory

SSLSocketFactory for self-signed certificate trust *