sentry-docs/docs/platforms/javascript/common/configuration/options.mdx at 96733e83d298beab7c8354f7c17c1cb67a217246 · getsentry/sentry-docs

title	Options
description	Learn more about how the SDK can be configured via options. These are being passed to the init function and therefore set when the SDK is first initialized.
customCanonicalTag	/platforms/javascript/configuration/options/
sidebar_order	1

Available Options

Core Options

**Note:** Electron `main` process only.

The DSN tells the SDK where to send the events. If this is not set, the SDK will not send any events. Learn more about DSN utilization.

The organization ID for your Sentry project.

The SDK will try to extract the organization ID from the DSN. If it cannot be found, or if you need to override it, you can provide the ID with this option. The organization ID is used for trace propagation and features like strictTraceContinuation.

The organization ID is used for features like strict trace continuation.

Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging information about what the SDK is doing.

**Note:** Electron `main` process only.

Sets the release. 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 or the sandbox.

<PlatformCategorySection supported={["server", "serverless"]}> On the server, the SDK will try to read this value from the SENTRY_RELEASE environment variable.

<PlatformCategorySection supported={["browser"]}> In the browser, the SDK will try to read this value from window.SENTRY_RELEASE.id if available.

<PlatformSection supported={["javascript.electron"]}> The SDK will read properties from the Electron app module to create the release in the format appName@version.

**Note:** Electron `main` process only.

Sets the environment. Defaults to development or production depending on whether the application is packaged.

Environments tell you where an error occurred, whether that's in your production system, your staging server, or elsewhere.

Sentry automatically creates an environment when it receives an event with the environment parameter set.

Environments are case-sensitive. The environment name can't contain newlines, spaces or forward slashes, can't be the string "None", or exceed 64 characters. You can't delete environments, but you can hide them.

Sets the URL that will be used to transport captured events. This can be used to work around ad-blockers or to have more granular control over events sent to Sentry. Adding your DSN is still required when using this option so necessary attributes can be set on the generated Sentry data. This option requires the implementation of a custom server endpoint. Learn more and find examples in Dealing with Ad-Blockers.

Set this option to true to send default PII data to Sentry. Among other things, enabling this will enable automatic IP address collection on events.

This variable controls the total amount of breadcrumbs that should be captured. You should be aware that Sentry has a maximum payload size and any events exceeding that payload size will be dropped.

<PlatformSection supported={["javascript.electron"]}> Enabled per Electron process.

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 messages captured with Sentry.captureMessage().

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.

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.

Note: Electron main process only.

When not set to false, the SDK tracks sessions linked to the lifetime of the Electron main process.

**Note:** Electron `main` process only.

Data to be set to the initial scope. Initial scope can be defined either as an object or a callback function, as shown below.

// Using an object
Sentry.init({
  dsn: "___PUBLIC_DSN___",
  initialScope: {
    tags: { "my-tag": "my value" },
    user: { id: 42, email: "john.doe@example.com" },
  },
});

// Using a callback function
Sentry.init({
  dsn: "___PUBLIC_DSN___",
  initialScope: (scope) => {
    scope.setTags({ a: "b" });
    return scope;
  },
});

Maximum number of characters every string property on events sent to Sentry can have before it will be truncated.

Sentry SDKs normalize any contextual data to a given depth. Any data beyond this depth will be trimmed and marked using its type instead ([Object] or [Array]), without walking the tree any further. By default, walking is performed three levels deep.

This is the maximum number of properties or entries that will be included in any given object or array when the SDK is normalizing contextual data. Any data beyond this depth will be dropped.

Specifies whether this SDK should send events to Sentry. Setting this to enabled: false doesn't prevent all overhead from Sentry instrumentation. To disable Sentry completely, depending on environment, call Sentry.init conditionally.

Set this option to false to disable sending of client reports. Client reports are a protocol feature that let clients send status reports about themselves to Sentry. They are currently mainly used to emit outcomes for events that were never sent.

Set this option to true to add stack local variables to stack traces.

For more advanced configuration options, see the documentation on the Local Variables integration options.

Pass additional integrations that should be initialized with the SDK. Integrations are pieces of code that can be used to extend the SDK's functionality. They can be used to add custom event processors, context providers, or to hook into the SDK's lifecycle.

See integration docs for more information.

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

See integration docs to see how you can modify the default integrations.

<PlatformSection supported={["javascript.electron"]}> Controls breadcrumb capture in the Electron process where callback is set.

This function is called with a 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 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 notSupported={["javascript.electron"]}> The JavaScript SDK uses a transport to send events to Sentry. On modern browsers, most transports use the browsers' fetch API to send events. Transports will drop an event if it fails to send due to a lack of connection.

<PlatformCategorySection supported={["browser"]}> In the browser, a fetch-based transport is used by default.

<PlatformCategorySection supported={["server", "serverless"]}> On the server, a https-based transport is used by default.

<PlatformSection supported={["javascript.electron"]}> In the Electron main process, the default transport handles queuing events when the users device is offline. In Electron renderer processes, the default transport forwards events to the main process.

Options used to configure the transport. This is an object with the following possible optional keys:

<PlatformCategorySection supported={["browser", "desktop"]}> Options for the node httpTransport transport:

headers: An object containing headers to be sent with every request.
proxy: A proxy used for outbound requests. Can be http or https.
caCerts: A path or list of paths to a CA certificate, or a buffer of CA certificates.
httpModule: A custom HTTP module to use for requests. Defaults to the native http and https modules.
keepAlive: Determines whether to keep the socket alive between requests. Defaults to false.

<PlatformCategorySection supported={["server", "serverless"]}> Options for the browser fetch transport:

headers: An object containing headers to be sent with every request.
fetchOptions: An object containing options to be passed to the fetch call. Used by the SDK's fetch transport.

<PlatformSection supported={["javascript.electron"]}> Options for Electron offline support:

The Electron SDK provides built-in offline support that queues events when the app is offline and automatically sends them once the connection is restored. These options let you configure the following behavior:

maxAgeDays: The maximum number of days to keep an envelope in the queue.
maxQueueSize: The maximum number of envelopes to keep in the queue.
flushAtStartup: Whether the offline store should flush shortly after application startup. Defaults to false.
shouldSend: Called before the SDK attempts to send an envelope to Sentry. If this function returns false, shouldStore will be called to determine if the envelope should be stored. Defaults to () => true.
shouldStore: Called before an event is stored. Return false to drop the envelope rather than store it. Defaults to () => true.

Check out the Offline Support documentation for a complete example.

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.

Depending on your setup, the Sentry SDK will try to detect if it has been incorrectly set up. This can result in warnings like this being logged:

[Sentry] < libraryName > is not instrumented. This is likely because you required/imported < libraryName > before calling Sentry.init().

[Sentry] < libraryName > is not instrumented. Please make sure to initialize Sentry in a separate file that you `--import` when running node, see: < docs link >.

This means the SDK detected that the library hasn't been wrapped for automatic performance instrumentation. This may result in some spans not being reported correctly. If this is not affecting you (for example because the warning is a false positive or you do not care about these specific spans), you can disable this warning by setting this option to true.

<PlatformSection supported={['javascript.electron']}> Note: Electron main process only.

Inter-process communication mode to receive event and scope updates from renderer processes.

Available options are:

IPCMode.Classic - Configures Electron IPC modules
IPCMode.Protocol - Configures a custom protocol and fetch
IPCMode.Both (default) - Configures both modes for maximum compatibility

Custom namespace for the inter-process communication (IPC) channels used by the Sentry Electron SDK. This is useful when your Electron application uses multiple IPC channels and you want to prevent potential conflicts between them.

import * as Sentry from "@sentry/electron/main";

Sentry.init({
  dsn: "___PUBLIC_DSN___",
  ipcNamespace: "myCustomNamespace",
});

When set, the IPC channels used by Sentry will be prefixed with the specified namespace. Note that you need to configure the same namespace in your main process, renderer processes, and preload scripts for proper communication. See the Custom IPC Namespace section for complete setup instructions.

A function that returns an array of Electron session objects. These sessions are used to configure communication between the Electron main and renderer processes.

Callback function that allows custom naming of renderer processes. If the callback is not set, or it returns undefined, the default naming scheme is used.

Error Monitoring Options

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 will be sent. If set to 0.1, only 10% of error events will be sent. Events are picked randomly.

<PlatformSection supported={["javascript.electron"]}> In the Electron main process sampleRate applies to events captured all processes. In Electron renderer processes, the sampleRate only applies to that process.

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

By the time beforeSend is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect.

<PlatformSection supported={["javascript.electron"]}> In the Electron main process beforeSend is called for events captured in all processes. In Electron renderer processes, beforeSend only applies to that process.

Controls whether fetch error messages are enhanced by appending the request’s hostname. When enabled, generic fetch errors like "Failed to fetch" will be enhanced to include the hostname (e.g., "Failed to fetch (example.com)") to provide better context in Sentry.

Available options:

'always' (default): Modifies the actual error message directly. This may break third-party packages that rely on exact message matching (e.g., is-network-error, p-retry).
'report-only': Only enhances the message when sending to Sentry. The original error message remains unchanged, preserving compatibility with third-party packages that also check error messages.
false: Disables hostname enhancement completely.

<PlatformSection supported={["javascript.electron"]}> In the Electron main process ignoreErrors applies to events captured in all processes. In Electron renderer processes, ignoreErrors applies only to that process.

<SdkOption name="denyUrls" type='Array<string | RegExp>' defaultValue='[]' categorySupported={['browser']}>

<SdkOption name="allowUrls" type='Array<string | RegExp>' defaultValue='[]' categorySupported={['browser']}>

When enabled, all props of the Vue component where the error was thrown in are attached to the event.

<SdkOption name="attachErrorHandler" type='boolean' defaultValue='true' categorySupported={['browser']}> By default, the SDK attaches a Vue error handler to capture Vue exceptions and report them to Sentry. When attachErrorHandler is set to false, automatic error reporting is disabled.

Usually, this option should stay enabled, unless you want to set up Sentry error reporting yourself. For example, the Sentry Nuxt SDK does not attach an error handler as it's capturing errors through the error hooks provided by Nuxt.

Tracing Options

<PlatformSection supported={["javascript.electron"]}> Note: For Electron, tracing options apply to the process where these options are set.

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 tracesSampler must be defined to enable tracing.

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 tracesSampleRate must be defined to enable tracing.

The samplingContext object passed to the function has the following properties:

parentSampled: The sampling decision of the parent transaction. This is true if the parent transaction was sampled, and false if it was not.
name: The name of the span as it was started.
attributes: The initial attributes of the span. <PlatformCategorySection supported={["server", "serverless"]}>
- normalizedRequest: Request information of the currently active HTTP server request, if applicable.

An optional property that controls which downstream services receive tracing data, in the form of a sentry-trace and a baggage header attached to any outgoing HTTP requests.

The option may contain a list of strings or regex against which the URLs of outgoing requests are matched. If one of the entries in the list matches the URL of an outgoing request, trace data will be attached to that request. String entries do not have to be full matches, meaning the URL of a request is matched when it contains a string provided through the option.

<PlatformCategorySection supported={["browser"]}> On the browser, all outgoing requests to the same origin will be propagated by default.

<PlatformCategorySection supported={["server", "serverless"]}> On the server, all outgoing requests will be propagated by default.

If you want to disable trace propagation, you can set this option to [].

If set to true, the SDK will only continue a trace if the organization ID of the incoming trace found in the baggage header matches the organization ID of the current Sentry client.

The client's organization ID is extracted from the DSN or can be set with the <PlatformLink to={'/configuration/options#orgId'}>orgId option.

If the organization IDs do not match, the SDK will start a new trace instead of continuing the incoming one. This is useful to prevent traces of unknown third-party services from being continued in your application.

This function is called with a transaction event object, and can return a modified transaction event object, or null to skip reporting the event. This can be used, for instance, for manual PII stripping before sending.

This function is called with a serialized span object, and can return a modified span object. This might be useful for manually stripping PII from spans. This function is called for root spans as well as for all child spans. If you want to drop the root span, including all of its child spans, use beforeSendTransaction instead.

Please note that the span you receive as an argument is a serialized object, not a Span class instance.

A list of strings or regex patterns matching span names that shouldn't be sent to Sentry. When using strings, partial matches will be filtered out, so if you need to filter by exact match, use regex patterns instead. You can also provide an object with a name and op property to match both the span name and the operation name. Note that at least name or op must be provided.

If a root span matches any of the specified patterns, the entire local trace will be dropped. If a child span matches, its children will be reparented to the dropped span's parent span.

By default, no spans are ignored.

Here are some predefined matches for common spans to get you started:

Sentry.init({
  ignoreSpans: [
    // Browser connection events
    { op: /^browser\.(cache|connect|DNS)$/ },

    // Fonts
    { op: "resource.other", name: /.+\.(woff2|woff|ttf|eot)$/ },

    // CSS files
    { op: "resource.link", name: /.+\.css.*$/ },

    // JS files
    { op: /resource\.(link|script)/, name: /.+\.js.*$/ },

    // Images
    {
      op: /resource\.(other|img)/,
      name: /.+\.(png|svg|jpe?g|gif|bmp|tiff?|webp|avif|heic?|ico).*$/,
    },

    // Measure spans
    { op: "measure" },
  ],
});

If set to true, the SDK adds the W3C traceparent header to outgoing Http requests made via fetch or XMLHttpRequest. This header is attached in addition to the sentry-trace and baggage headers. Set this option to true if your backend services are instrumented with e.g. OpenTelemetry or other W3C Trace Context compatible libraries and you want to continue traces from the client.

Important: Make sure that your backend services' CORS configuration allows the traceparent header. Otherwise, requests might be blocked. Use the tracePropagationTargets option to control which requests the traceparent header is attached to. See Dealing with CORS Issues for more information.

Logs Options

<PlatformSection supported={["javascript.electron"]}> Note: For Electron, log options apply to the process where these options are set.

Set this option to true to enable log capturing in Sentry. Only when this is enabled will the logger APIs actually send logs to Sentry.

This function is called with a log object, and can return a modified log object, or null to skip sending this log to Sentry. This can be used, for instance, for manual PII stripping before sending, or to add custom attributes to all logs.

Session Replay Options

The sample rate for replays that begin recording immediately and last the entirety of the user's session. 1.0 collects all replays, and 0 collects none.

The sample rate for replays that are recorded when an error happens. This type of replay will record up to a minute of events prior to the error and continue recording until the session ends. 1.0 collects all sessions with an error, and 0 collects none.

Profiling Options

A number between 0 and 1 that sets the percentage of how many sessions should have profiling enabled. 1.0 enables profiling in every session, 0.5 enables profiling for 50% of the sessions, and 0 enables it for none. The sampling decision is made once at the beginning of a session. This option is required to enable profiling.

Determines how profiling sessions are controlled. It has two modes:

'manual' (default): You control when profiling starts and stops using the startProfiler() and stopProfiler() functions. In this mode, profile sampling is only affected by profileSessionSampleRate.<PlatformSection notSupported={["javascript.bun", "javascript.cordova", "javascript.capacitor", "javascript.deno", "javascript.cloudflare"]}> Read more about these functions in the profiling API documentation.
'trace': Profiling starts and stops automatically with transactions, as long as tracing is enabled. The profiler runs as long as there is at least one sampled transaction. In this mode, profiling is affected by both profileSessionSampleRate and your tracing sample rate (tracesSampleRate or tracesSampler).

Deprecated: Use profileSessionSampleRate instead to configure continuous profiling from version 7.4.0 onwards.

A number between 0 and 1, controlling the percentage chance a given sampled transaction will be profiled. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. This is relative to the tracing sample rate - e.g. 0.5 means 50% of sampled transactions will be profiled.

<PlatformCategorySection categorySupported={["server", "serverless"]}> In a server environment, a profiling session starts when the Sentry SDK is initialized and stops when the service terminates. Therefore, the sampling decision is re-evaluated on service restart or redeployment.

<PlatformCategorySection supported={['browser']}> In a browser environment, a profiling session corresponds to a user session. A user session starts with a new SDK initialization on page load and ends when the browser tab is closed.

Determines how profiling sessions are controlled. It has two modes:

'manual' (default): You control when profiling starts and stops using the startProfiler() and stopProfiler() functions. In this mode, profile sampling is only affected by profileSessionSampleRate.<PlatformSection notSupported={["javascript.bun", "javascript.cordova", "javascript.capacitor", "javascript.deno", "javascript.cloudflare"]}> Read more about these functions in the profiling API documentation.
'trace': Profiling starts and stops automatically with transactions, as long as tracing is enabled. The profiler runs as long as there is at least one sampled transaction. In this mode, profiling is affected by both profileSessionSampleRate and your tracing sample rate (tracesSampleRate or tracesSampler).

Deprecated: Use profileSessionSampleRate instead to configure continuous profiling from version 10.27.0 onwards.

Experimental Options

An optional property that configures which features are in experimental mode. This property is either an Object Type with properties or a key/value TypedDict, depending the language. Experimental features are still in-progress and may have bugs. We recognize the irony.

Hybrid SDK Options

Set this option to false to disable the native SDK. This will disable all native crash and error handling and, instead, the SDK will only capture errors on the upper layer.

Set this option to false to disable the release health feature.

Set this to change the default interval to end a session (release health) if the app goes to the background. Default is 30,000.

Set this option to false to disable the scope sync from Java to NDK on Android.

Set this option to true to automatically attach all threads to all logged events on Android.

Set this option to false to disable out of memory tracking on iOS.

Set this option to false to disable hard crash handling from the native layer. Doing so means that the SDK won't capture events for hard crashes on Android and iOS if the error was caused by native code.

Set this option to false to disable the native nagger alert being shown.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Available Options

Core Options

Error Monitoring Options

Tracing Options

Logs Options

Session Replay Options

Profiling Options

Experimental Options

Hybrid SDK Options

Uh oh!

FilesExpand file tree

options.mdx

Latest commit

History

options.mdx

File metadata and controls

Available Options

Core Options

Error Monitoring Options

Tracing Options

Logs Options

Session Replay Options

Profiling Options

Experimental Options

Hybrid SDK Options