Optional _experimentsOptions which are in beta, or otherwise not guaranteed to be stable.
Optional _metadataSet of metadata about the SDK that can be internally used to enhance envelopes and events, and provide additional data about every request.
Optional allowA pattern for error URLs which should exclusively be sent to Sentry. This is the opposite of denyUrls. By default, all errors will be sent.
Requires the use of the InboundFilters integration.
Optional attachAttaches stacktraces to pure capture message / log integrations
Optional autoA flag enabling Sessions Tracking feature. By default, Sessions Tracking is enabled.
Optional beforeA callback invoked when adding a breadcrumb, allowing to optionally modify it before adding it to future events.
Note that you must return a valid breadcrumb from this callback. If you do not wish to modify the breadcrumb, simply return it at the end. Returning null will cause the breadcrumb to be dropped.
The breadcrumb as created by the SDK.
Optional hint: BreadcrumbHintThe breadcrumb that will be added | null.
Optional beforeAn event-processing callback for error and message events, guaranteed to be invoked after all other event processors, which allows an event to be modified or dropped.
Note that you must return a valid event from this callback. If you do not wish to modify the event, simply return
it at the end. Returning null will cause the event to be dropped.
The error or message event generated by the SDK.
Event metadata useful for processing.
A new event that will be sent | null.
Optional beforeAn event-processing callback for transaction events, guaranteed to be invoked after all other event processors. This allows an event to be modified or dropped before it's sent.
Note that you must return a valid event from this callback. If you do not wish to modify the event, simply return
it at the end. Returning null will cause the event to be dropped.
The error or message event generated by the SDK.
Event metadata useful for processing.
A new event that will be sent | null.
Optional debugEnable debug functionality in the SDK itself
Optional defaultIf this is set to false, default integrations will not be added, otherwise this will internally be set to the recommended default integrations.
Optional denyA pattern for error URLs which should not be sent to Sentry. To allow certain errors instead, use allowUrls. By default, all errors will be sent.
Requires the use of the InboundFilters integration.
Optional distSets the distribution for all events
Optional dsnThe Dsn used to connect to Sentry and identify the project. If omitted, the SDK will not send any data to Sentry.
Optional enableIf this is enabled, transactions and trace data will be generated and captured.
This will set the tracesSampleRate to the recommended default of 1.0 if tracesSampleRate is undefined.
Note that tracesSampleRate and tracesSampler take precedence over this option.
Optional enabledSpecifies whether this SDK should send events to Sentry. Defaults to true.
Optional environmentThe current environment of your application (e.g. "production").
Optional ignoreA pattern for error messages which should not be sent to Sentry. By default, all errors will be sent.
Optional ignoreA pattern for transaction names which should not be sent to Sentry. By default, all transactions will be sent.
Optional includeInclude local variables with stack traces.
Requires the LocalVariables integration.
Optional initialInitial data to populate scope.
Optional instrumenterThe instrumenter to use. Defaults to sentry.
When not set to sentry, auto-instrumentation inside of Sentry will be disabled,
in favor of using external auto instrumentation.
NOTE: Any option except for sentry is highly experimental and subject to change!
Optional integrationsList of integrations that should be installed after SDK was initialized. Accepts either a list of integrations or a function that receives default integrations and returns a new, updated list.
Optional maxThe maximum number of breadcrumbs sent with events. Defaults to 100. Sentry has a maximum payload size of 1MB and any events exceeding that payload size will be dropped.
Optional maxMaximum number of chars a single value can have before it will be truncated.
Optional normalizeMaximum number of levels that normalization algorithm will traverse in objects and arrays. Used when normalizing an event before sending, on all of the listed attributes:
breadcrumbs.datausercontextsextra
Defaults to 3. Set to 0 to disable.Optional normalizeMaximum number of properties or elements that the normalization algorithm will output in any single array or object included in the normalized event. Used when normalizing an event before sending, on all of the listed attributes:
breadcrumbs.datausercontextsextra
Defaults to 1000Optional profilesSets profiling sample rate when @sentry/profiling-node is installed
Optional profilesFunction to compute profiling sample rate dynamically and filter unwanted profiles.
Profiling is enabled if either this or profilesSampleRate is defined. If both are defined, profilesSampleRate is
ignored.
Will automatically be passed a context object of default and optional custom data. See Transaction.samplingContext and startTransaction.
A sample rate between 0 and 1 (0 drops the profile, 1 guarantees it will be sent). Returning true is
equivalent to returning 1 and returning false is equivalent to returning 0.
Optional releaseThe release identifier used when uploading respective source maps. Specify this value to allow Sentry to resolve the correct source maps when processing events.
Optional sampleA global sample rate to apply to all events.
0.0 = 0% chance of a given event being sent (send no events) 1.0 = 100% chance of a given event being sent (send all events)
Optional sendSend SDK Client Reports. By default, Client Reports are enabled.
Optional sendControls if potentially sensitive data should be sent to Sentry by default.
Note that this only applies to data that the SDK is sending by default
but not data that was explicitly set (e.g. by calling Sentry.setUser()).
Defaults to false.
NOTE: This option currently controls only a few data points in a selected
set of SDKs. The goal for this option is to eventually control all sensitive
data the SDK sets by default. However, this would be a breaking change so
until the next major update this option only controls data points which were
added in versions above 7.9.0.
Optional serverSets an optional server name (device name)
Optional shutdownControls how many milliseconds to wait before shutting down. The default is SDK-specific but typically around 2 seconds. Setting this too low can cause problems for sending events from command line applications. Setting it too high can cause the application to block for users with network connectivity problems.
Optional stackA stack parser implementation or an array of stack line parsers By default, a stack parser is supplied for all supported browsers
Optional traceList of strings/regex controlling to which outgoing requests the SDK will attach tracing headers.
By default the SDK will attach those headers to all outgoing requests. If this option is provided, the SDK will match the request URL of outgoing requests against the items in this array, and only attach tracing headers if a match was found.
Sentry.init({
tracePropagationTargets: ['api.site.com'],
});
Optional tracesSample rate to determine trace sampling.
0.0 = 0% chance of a given trace being sent (send no traces) 1.0 = 100% chance of a given trace being sent (send all traces)
Tracing is enabled if either this or tracesSampler is defined. If both are defined, tracesSampleRate is
ignored.
Optional tracesFunction to compute tracing sample rate dynamically and filter unwanted traces.
Tracing is enabled if either this or tracesSampleRate is defined. If both are defined, tracesSampleRate is
ignored.
Will automatically be passed a context object of default and optional custom data. See Transaction.samplingContext and startTransaction.
A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning true is
equivalent to returning 1 and returning false is equivalent to returning 0.
Optional transportA function that takes transport options and returns the Transport object which is used to send events to Sentry. The function is invoked internally during SDK initialization. By default, the SDK initializes its default transports.
Optional transportOptions for the default transport that the SDK uses.
Optional tunnelA URL to an envelope tunnel endpoint. An envelope tunnel is an HTTP endpoint that accepts Sentry envelopes for forwarding. This can be used to force data through a custom server independent of the type of data.
Optional onOptional shouldMoved to constructor options of the Http and Undici integration.
Sentry.init({
integrations: [
new Sentry.Integrations.Http({
tracing: {
shouldCreateSpanForRequest: (url: string) => false,
}
});
],
});
Generated using TypeDoc
Configuration options for the Sentry Node SDK
See
@sentry/types Options for more information.