Takaro - v0.4.11
    Preparing search index...

    Interface NodeOptions

    Configuration options for the Sentry Node SDK

    @sentry/types Options for more information.

    interface NodeOptions {
        _experiments?: { [key: string]: any };
        _metadata?: SdkMetadata;
        allowUrls?: (string | RegExp)[];
        attachStacktrace?: boolean;
        autoSessionTracking?: boolean;
        beforeBreadcrumb?: (
            breadcrumb: Breadcrumb,
            hint?: BreadcrumbHint,
        ) => Breadcrumb | null;
        beforeSend?: (
            event: ErrorEvent,
            hint: EventHint,
        ) => Event | PromiseLike<Event | null> | null;
        beforeSendTransaction?: (
            event: TransactionEvent,
            hint: EventHint,
        ) => Event | PromiseLike<Event | null> | null;
        debug?: boolean;
        defaultIntegrations?: false | Integration[];
        denyUrls?: (string | RegExp)[];
        dist?: string;
        dsn?: string;
        enabled?: boolean;
        enableTracing?: boolean;
        environment?: string;
        ignoreErrors?: (string | RegExp)[];
        ignoreTransactions?: (string | RegExp)[];
        includeLocalVariables?: boolean;
        initialScope?: CaptureContext;
        instrumenter?: Instrumenter;
        integrations?:
            | Integration[]
            | ((integrations: Integration[]) => Integration[]);
        maxBreadcrumbs?: number;
        maxValueLength?: number;
        normalizeDepth?: number;
        normalizeMaxBreadth?: number;
        profilesSampler?: (samplingContext: SamplingContext) => number | boolean;
        profilesSampleRate?: number;
        release?: string;
        sampleRate?: number;
        sendClientReports?: boolean;
        sendDefaultPii?: boolean;
        serverName?: string;
        shutdownTimeout?: number;
        spotlight?: string | boolean;
        stackParser?: StackParser | StackLineParser[];
        tracePropagationTargets?: TracePropagationTargets;
        tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
        tracesSampleRate?: number;
        transport?: (transportOptions: NodeTransportOptions) => Transport;
        transportOptions?: Partial<NodeTransportOptions>;
        tunnel?: string;
        onFatalError?(this: void, error: Error): void;
        shouldCreateSpanForRequest?(this: void, url: string): boolean;
    }

    Hierarchy

    • Options<NodeTransportOptions>
    • BaseNodeOptions
      • NodeOptions
    Index

    Properties

    _experiments? _metadata? allowUrls? attachStacktrace? autoSessionTracking? beforeBreadcrumb? beforeSend? beforeSendTransaction? debug? defaultIntegrations? denyUrls? dist? dsn? enabled? enableTracing? environment? ignoreErrors? ignoreTransactions? includeLocalVariables? initialScope? instrumenter? integrations? maxBreadcrumbs? maxValueLength? normalizeDepth? normalizeMaxBreadth? profilesSampler? profilesSampleRate? release? sampleRate? sendClientReports? sendDefaultPii? serverName? shutdownTimeout? spotlight? stackParser? tracePropagationTargets? tracesSampler? tracesSampleRate? transport? transportOptions? tunnel?

    Methods

    onFatalError? shouldCreateSpanForRequest?

    Properties

    Optional_experiments

    _experiments?: { [key: string]: any }

    Options which are in beta, or otherwise not guaranteed to be stable.

    Optional_metadata

    _metadata?: SdkMetadata

    Set of metadata about the SDK that can be internally used to enhance envelopes and events, and provide additional data about every request.

    allowUrls?: (string | RegExp)[]

    A pattern for error URLs which should exclusively be sent to Sentry. This is the opposite of Options.denyUrls. By default, all errors will be sent.

    Requires the use of the InboundFilters integration.

    attachStacktrace?: boolean

    Attaches stacktraces to pure capture message / log integrations

    autoSessionTracking?: boolean

    A flag enabling Sessions Tracking feature. By default, Sessions Tracking is enabled.

    beforeBreadcrumb?: (
        breadcrumb: Breadcrumb,
        hint?: BreadcrumbHint,
    ) => Breadcrumb | null

    A 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.

    Type Declaration

    beforeSend?: (
        event: ErrorEvent,
        hint: EventHint,
    ) => Event | PromiseLike<Event | null> | null

    An 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.

    Type Declaration

      • (event: ErrorEvent, hint: EventHint): Event | PromiseLike<Event | null> | null

      • Parameters

        • event: ErrorEvent

          The error or message event generated by the SDK.

        • hint: EventHint

          Event metadata useful for processing.

        Returns Event | PromiseLike<Event | null> | null

        A new event that will be sent | null.

    beforeSendTransaction?: (
        event: TransactionEvent,
        hint: EventHint,
    ) => Event | PromiseLike<Event | null> | null

    An 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.

    Type Declaration

      • (
            event: TransactionEvent,
            hint: EventHint,
        ): Event | PromiseLike<Event | null> | null

      • Parameters

        • event: TransactionEvent

          The error or message event generated by the SDK.

        • hint: EventHint

          Event metadata useful for processing.

        Returns Event | PromiseLike<Event | null> | null

        A new event that will be sent | null.

    debug?: boolean

    Enable debug functionality in the SDK itself

    defaultIntegrations?: false | Integration[]

    If this is set to false, default integrations will not be added, otherwise this will internally be set to the recommended default integrations.

    denyUrls?: (string | RegExp)[]

    A pattern for error URLs which should not be sent to Sentry. To allow certain errors instead, use Options.allowUrls. By default, all errors will be sent.

    Requires the use of the InboundFilters integration.

    dist?: string

    Sets the distribution for all events

    dsn?: string

    The Dsn used to connect to Sentry and identify the project. If omitted, the SDK will not send any data to Sentry.

    enabled?: boolean

    Specifies whether this SDK should send events to Sentry. Defaults to true.

    enableTracing?: boolean

    If 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.

    environment?: string

    The current environment of your application (e.g. "production").

    ignoreErrors?: (string | RegExp)[]

    A pattern for error messages which should not be sent to Sentry. By default, all errors will be sent.

    ignoreTransactions?: (string | RegExp)[]

    A pattern for transaction names which should not be sent to Sentry. By default, all transactions will be sent.

    includeLocalVariables?: boolean

    Include local variables with stack traces.

    Requires the LocalVariables integration.

    initialScope?: CaptureContext

    Initial data to populate scope.

    instrumenter?: Instrumenter

    The 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!

    integrations?: Integration[] | ((integrations: Integration[]) => Integration[])

    List 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.

    maxBreadcrumbs?: number

    The 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.

    maxValueLength?: number

    Maximum number of chars a single value can have before it will be truncated.

    normalizeDepth?: number

    Maximum 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.data
    • user
    • contexts
    • extra Defaults to 3. Set to 0 to disable.
    normalizeMaxBreadth?: number

    Maximum 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.data
    • user
    • contexts
    • extra Defaults to 1000
    profilesSampler?: (samplingContext: SamplingContext) => number | boolean

    Function 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 Hub.startTransaction.

    Type Declaration

      • (samplingContext: SamplingContext): number | boolean

      • Parameters

        • samplingContext: SamplingContext

        Returns number | boolean

        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.

    profilesSampleRate?: number

    Sets profiling sample rate when @sentry/profiling-node is installed

    release?: string

    The release identifier used when uploading respective source maps. Specify this value to allow Sentry to resolve the correct source maps when processing events.

    sampleRate?: number

    A 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)

    sendClientReports?: boolean

    Send SDK Client Reports. By default, Client Reports are enabled.

    sendDefaultPii?: boolean

    Controls 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.

    serverName?: string

    Sets an optional server name (device name)

    shutdownTimeout?: number

    Controls 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.

    spotlight?: string | boolean

    If you use Spotlight by Sentry during development, use this option to forward captured Sentry events to Spotlight.

    Either set it to true, or provide a specific Spotlight Sidecar URL.

    More details: https://spotlightjs.com/

    IMPORTANT: Only set this option to true while developing, not in production!

    stackParser?: StackParser | StackLineParser[]

    A stack parser implementation or an array of stack line parsers By default, a stack parser is supplied for all supported browsers

    tracePropagationTargets?: TracePropagationTargets

    List of strings/regex controlling to which outgoing requests the SDK will attach tracing headers.

    By default the SDK will attach those headers to all requests to localhost and same origin. 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'],
    });

    Default: ['localhost', /^//] {@see DEFAULT_TRACE_PROPAGATION_TARGETS}

    tracesSampler?: (samplingContext: SamplingContext) => number | boolean

    Function 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 Hub.startTransaction.

    Type Declaration

      • (samplingContext: SamplingContext): number | boolean

      • Parameters

        • samplingContext: SamplingContext

        Returns number | boolean

        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.

    tracesSampleRate?: number

    Sample 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.

    transport?: (transportOptions: NodeTransportOptions) => Transport

    A 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.

    transportOptions?: Partial<NodeTransportOptions>

    Options for the default transport that the SDK uses.

    tunnel?: string

    A 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.

    Methods

    • Callback that is executed when a fatal global error occurs.

      Parameters

      • this: void
      • error: Error

      Returns void

    • Parameters

      • this: void
      • url: string

      Returns boolean

      Moved to constructor options of the Http and Undici integration.

      Sentry.init({
        integrations: [
          new Sentry.Integrations.Http({
            tracing: {
              shouldCreateSpanForRequest: (url: string) => false,
            }
          });
        ],
      });

    Settings

    Member Visibility

    On This Page

    Properties
    Methods