Configuration

SDKs are configurable in many ways. The options are largely standardized between SDKs but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first initialized.

Options can be set by passing a callback to the Init() method which will pass the option object along for modifications:

using Sentry;

using (SentrySdk.Init(o =>
{
    o.Dsn = "___PUBLIC_DSN___";
    o.MaxBreadcrumbs = 50;
    o.Debug = true;
})
{
    // app code here
}

Options are passed to the init() function as optional keyword arguments:

import sentry_sdk

sentry_sdk.init(
    '___PUBLIC_DSN___',
    max_breadcrumbs=50,
    debug=True,
)

Options are passed to the init() as object:

Sentry.init({
  dsn: '___PUBLIC_DSN___',
  maxBreadcrumbs: 50,
  debug: true,
})

Options are passed to the init() as tuple where the first argument is the DSN and the second the options:

use sentry;

sentry::init(("___PUBLIC_DSN___", sentry::ClientOptions {
    max_breadcrumbs: 50,
    debug: true,
    ..Default::default()
}));

Options are passed to the init() as object:

Sentry.init({
  dsn: '___PUBLIC_DSN___',
  maxBreadcrumbs: 50,
  debug: true,
});

Common Options

The list of common options across SDKs. These work more or less the same in all SDKs but some subtle differences will exist to better support the platform.

dsn

The DSN tells the SDK where to send the events to. This option is always required and different SDKs might pick this up from an environment variable (SENTRY_DSN) or in the case if you are using the CDN version or the Browser SDK, it’s already configured for you.

debug

Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging information if something goes wrong with sending the event. The default is always false and it’s generally not recommended to turn it on in production but doing so will not cause any safety concerns.

release

Sets the release. Some SDKs will try to automatically configure a release out of the box but if you have the chance it’s a better idea to manually set it. That way it’s guaranteed to be in sync with your deploy integrations or sourcemap uploads.

Release names are just strings but some formats are detected by Sentry and might be rendered differently. For more information have a look at the releases documentation.

environment

Sets the environment. This string is freeform and not set by default. A release can be associated with more than one environment to separate them in the UI (think staging vs prod or similar).

sample-rate

Configures the sample rate as a percentage of events to be sent in the range of 0.0 to 1.0. The default is 1.0 which means that 100% of events are sent. If set to 0.1 only 10% of events will be sent. Events are picked randomly.

max-breadcrumbs

This variable controls the total amount of breadcrumbs that should be captured. This defaults to 100.

attach-stacktrace

When enabled, stacktraces are automatically attached to all messages logged. Note that stacktraces are always attached to exceptions but when this is set stacktraces are also sent with messages. This, for instance, means that stacktraces appear next to all log messages.

It’s important to note that grouping in Sentry is different for events with stacktraces and without. This means that you will get new groups as you enable or disable this flag for certain events.

This feature is off by default.

send-default-pii

If this flag is enabled, certain personally identifiable information is added by active integrations. Without this flag they are never added to the event, to begin with. If possible, it’s recommended to turn on this feature and use the server side PII stripping to remove the values instead.

server-name

Can be used to supply a “server name”. When provided, the name of the server is sent along and persisted in the event. Note that for many integrations the server name actually corresponds to the device hostname even in situations where the machine is not actually a server. Most SDKs will attempt to auto-discover this value.

blacklist-urls

A list of strings or regex patterns that match error URLs which should not be sent to Sentry. By default, all errors will be sent.

whitelist-urls

A list of strings or regex patterns that match error URLs which should exclusively be sent to Sentry. By default, all errors will be sent.

request-bodies

This parameter controls if integrations should capture HTTP request bodies. It can be set to one of the following values:

  • never: request bodies are never sent.
  • small: only small request bodies will be captured where the cutoff for small depends on the SDK (typically 4KB)
  • medium: medium-sized requests and small requests will be captured. (typically 10KB)
  • always: the SDK will always capture the request body for as long as sentry can make sense of it

with-locals

When enabled local variables are sent along with stackframes. This can have a performance and PII impact. Enabled by default on platforms where this is available.

ca-certs

A path to an alternative CA bundle file in PEM-format.

Integration Configuration

For many platform SDKs integrations can be configured alongside it. On some platforms that happen as part of the init() call, in some others, different patterns apply.

integrations

In some SDKs, the integrations are configured through this parameter on library initialization. For more information, have a look at the specific integration documentation.

default-integrations

This can be used to disable integrations that are added by default. When set to false no default integrations are added.

Hooks

These options can be used to hook the SDK in various ways to customize the reporting of events.

before-send

This function is called with an SDK specific event object and can return a modified event object or nothing to skip reporting the event. This can be used for instance for manual PII stripping before sending.

before-breadcrumb

This function is called with an SDK specific breadcrumb object before the breadcrumb is added to the scope. When nothing is returned from the function the breadcrumb is dropped. The callback typically gets a second argument (called a “hint”) which contains the original object that the breadcrumb was created from to further customize what the breadcrumb should look like.

Transport Options

Transports are used to send events to Sentry. This can be customized to some degree to better support highly specific deployments.

transport

This switches out the transport that is used to send events. How this works depends on the SDK. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication.

http-proxy

When set a proxy can be configured that should be used for outbound requests. This is also used for HTTPS requests unless a separate https-proxy is configured. Note however that not all SDKs support a separate HTTPS proxy. SDKs will attempt to default to the system-wide configured proxy if possible. For instance, on unix systems, the http_proxy environment variable will be picked up.

https-proxy

Configures a separate proxy for outgoing HTTPS requests. This value might not be supported by all SDKs. When not supported the http-proxy value is also used for HTTPS requests at all times.

shutdown-timeout

Controls how many seconds to wait before shutting down. Sentry SDKs send events from a background queue and this queue is given a certain amount to drain pending events. The default is SDK specific but typically around 2 seconds. Setting this value too low will most likely cause problems for sending events from command line applications. Setting it too high will cause the application to block for a long time for users with network connectivity problems.