| title | sidebar_order | description | notSupported | ||
|---|---|---|---|---|---|
Basic Options |
1 |
Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function as an object. |
|
SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first initialized.
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. Options that can be read from an environment variable (SENTRY_DSN, SENTRY_ENVIRONMENT, SENTRY_RELEASE) are read automatically.
The DSN tells the SDK where to send the events. If this value is not provided, the SDK will try to read it from the SENTRY_DSN environment variable. If that variable also does not exist, the SDK will just not send any events.
In runtimes without a process environment (such as the browser) that fallback does not apply.
Learn more about DSN utilization.
<ConfigKey name="stack-trace-mode" supported={["dotnet"]}>
- Original - Default .NET stack trace format.
- Enhanced - Include
async, return type, arguments, and more.
Before version 3.0.0 of the Sentry SDK for .NET, there was no special treatment for the stack trace. Sentry reported what .NET made available at runtime.
This behavior now called StackTraceMode.Original. With the introduction of 3.0, a new default mode is Enhanced.
Changing this value will affect issue grouping. Since the frame significantly changes shape.
<ConfigKey name="debug" notSupported={["php"]}>
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. It's generally not recommended to turn it on in production, though turning debug mode on will not cause any safety concerns.
<ConfigKey name="diagnostic-level" supported={["dotnet", "java", "android", "dart", "flutter"]}>
Enabling debug mode makes the SDK generate as much diagnostic data as possible. However, if you'd prefer to lower the verbosity of the Sentry SDK diagnostics logs, configure this option to set the appropriate level:
debug: default The most verbose modeinfo: Informational messageswarning: Warning that something might not be righterror: Only SDK internal errors are printedfatal: Only critical errors are printed
Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in the releases documentation.
By default the SDK will try to read this value from the SENTRY_RELEASE environment variable (in the browser SDK, this will be read off of the window.SENTRY_RELEASE if available).
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).
By default the SDK will try to read this value from the SENTRY_ENVIRONMENT environment variable (except for the browser SDK where this is not applicable).
<ConfigKey name="error-types" supported={["php"]}>
Sets which errors are reported. It takes the same values as PHP's error_reporting configuration parameter.
By default all types of errors are be reported (equivalent to E_ALL).
Configures the sample rate for error events, in the range of 0.0 to 1.0. The default is 1.0 which means that 100% of error events are sent. If set to 0.1 only 10% of error events will be sent. Events are picked randomly.
This variable controls the total amount of breadcrumbs that should be captured. This defaults to 100.
When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages.
<PlatformSection supported={["android", "apple", "java"]}>
This option is on by default.
This option is off by default.
Grouping in Sentry is different for events with stack traces and without. As a result, you will get new groups as you enable or disable this flag for certain events.
<ConfigKey name="send-default-pii" supported={["apple", "dotnet", "javascript", "node", "react-native", "python", "java", "php", "rust"]}>
If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent.
If possible, we recommended turning on this feature to send all such data by default, and manually remove what you don't want to send using our features for managing Sensitive Data.
<ConfigKey name="server-name" supported={["python", "node", "ruby", "php", "java", "dart", "dotnet"]}>
This option can be used to supply a "server name." When provided, the name of the server is sent along and persisted in the event. 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.
<ConfigKey name="deny-urls" supported={["javascript"]}>
A list of strings or regex patterns that match error URLs that should not be sent to Sentry. By default, all errors will be sent. This is a "contains" match to the entire file URL. As a result, if you add foo.com to it, it will also match on https://bar.com/myfile/foo.com. By default, all errors will be sent.
<ConfigKey name="allow-urls" supported={["javascript"]}>
A legacy alias for 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. This is a "contains" match to the entire file URL. As a result, if you add foo.com to it, it will also match on [https://bar.com/myfile/foo.com](https://bar.com/myfile/foo.com) By default, all errors will be sent.
<ConfigKey name="auto-session-tracking" supported={["javascript"]}>
When set to true, the SDK will send session events to Sentry. This is supported in all browser SDKs, emitting one session per pageload and page navigation to Sentry.
<ConfigKey name="in-app-include" supported={["dotnet", "python", "rust", "csharp", "php", "java", "dart"]}>
A list of string prefixes of module names that belong to the app. This option takes precedence over in-app-exclude.
<ConfigKey name="in-app-exclude" supported={["dotnet", "python", "rust", "csharp", "php", "java", "dart"]}>
A list of string prefixes of module names that do not belong to the app, but rather to third-party packages. Modules considered not part of the app will be hidden from stack traces by default.
This option can be overridden using in-app-include.
<ConfigKey name="request-bodies" supported={["python"]}>
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 sentsmall: only small request bodies will be captured where the cutoff for small depends on the SDK (typically 4KB)medium: medium 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
<ConfigKey name="max-request-body-size" supported={["php", "dotnet.aspnet", "dotnet.aspnetcore"]}>
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 sentsmall: only small request bodies will be captured where the cutoff for small depends on the SDK (typically 4KB)medium: medium 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
<ConfigKey name="with-locals" supported={["python"]}>
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.
<ConfigKey name="ca-certs" supported={["python"]}>
A path to an alternative CA bundle file in PEM-format.
<ConfigKey name="normalize-depth" supported={["javascript", "node"]}>
Sentry SDKs normalize any contextual data to a given depth. Any keys containing data with a structure deeper than this will be trimmed and marked using its type instead ([Object] or [Array]), without walking the tree any further. By default, walking is performed 3 levels deep.
<PlatformSection supported={["javascript", "python", "node"]}>
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.
In some SDKs, the integrations are configured through this parameter on library initialization. For more information, please see our documentation for a specific integration.
This can be used to disable integrations that are added by default. When set to false, no default integrations are added.
These options can be used to hook the SDK in various ways to customize the reporting of events.
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.
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. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object. The callback typically gets a second argument (called a "hint") which contains the original object from which the breadcrumb was created to further customize what the breadcrumb should look like.
<PlatformSection supported={["javascript", "java", "python", "node", "php", "dotnet"]}>
Transports are used to send events to Sentry. Transports can be customized to some degree to better support highly specific deployments.
<ConfigKey name="transport" supported={["javascript", "php", "python", "java", "dotnet"]}>
Switches out the transport 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.
<ConfigKey name="http-proxy" supported={["node", "php", "python", "java", "dotnet"]}>
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. However, 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.
<ConfigKey name="https-proxy" supported={["python", "node"]}>
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.
<ConfigKey name="cache-directory-path" supported={["dotnet"]}>
Specifies a local directory used for cacheing payloads. When this option is enabled (that is, when the directory is set), the Sentry SDK will persist envelopes locally before sending to Sentry. This configuration option is particularly useful if you expect your application to run in environments where internet connectivity is limited.
Default: not set (caching is disabled).
<ConfigKey name="init-cache-flush-timeout" supported={["dotnet"]}>
When cacheing is enabled (that is, is set), this option controls the timeout that limits how long the SDK will attempt to flush existing cache during initialization. Note that flushing the cache involves sending the payload to Sentry in a blocking operation. Setting this option to zero means that Sentry will not attempt to flush the cache during initialization, but instead will do so when the next payload is queued up.
The default is 1 (one) second.
<ConfigKey name="shutdown-timeout" supported={["python", "node", "java", "dotnet"]}>
Controls how many seconds to wait before shutting down. Sentry SDKs send events from a background queue. This queue is given a certain amount to drain pending events. The default is SDK specific but typically around two seconds. Setting this value too low may cause problems for sending events from command line applications. Setting the value too high will cause the application to block for a long time for users experiencing network connectivity problems.
<ConfigKey name="tracesSampleRate" supported={["node", "javascript", "python", "php", "dotnet"]}>
A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or must be defined to enable tracing.
<ConfigKey name="tracesSampler" supported={["node", "javascript", "python", "php", "dotnet"]}>
A function responsible for determining the percentage chance a given transaction will be sent to Sentry. It will automatically be passed information about the transaction and the context in which it's being created, and must return a number between 0 (0% chance of being sent) and 1 (100% chance of being sent). Can also be used for filtering transactions, by returning 0 for those that are unwanted. Either this or must be defined to enable tracing.