Class NodeClient

The Sentry Node SDK Client.

See

  • NodeClientOptions for documentation on configuration options.
  • SentryClient for usage documentation.

Hierarchy

  • ServerRuntimeClient<NodeClientOptions>
    • NodeClient

Constructors

constructor

Properties

_dsn? _eventProcessors _integrations _integrationsInitialized _numProcessing _options _sessionFlusher _transport? metricsAggregator?

Methods

_captureEvent _captureRequestSession _clearOutcomes _isClientDoneProcessing _isEnabled _prepareEvent _process _processEvent _sendEnvelope _setupIntegrations _updateSessionFromEvent addEventProcessor addIntegration captureAggregateMetrics captureCheckIn captureEvent captureException captureMessage captureSession close emit eventFromException eventFromMessage flush getDsn getEventProcessors getIntegration getIntegrationById getIntegrationByName getOptions getSdkMetadata getTransport init initSessionFlusher on recordDroppedEvent sendEvent sendSession setupIntegrations

Constructors

constructor

  • new NodeClient(options: NodeClientOptions): NodeClient

  • Creates a new Node SDK instance.

    Parameters

    • options: NodeClientOptions

      Configuration options for this SDK.

    Returns NodeClient

Properties

Protected Optional Readonly_dsn

_dsn?: DsnComponents

The client Dsn, if specified in options. Without this Dsn, the SDK will be disabled.

Protected_eventProcessors

_eventProcessors: EventProcessor[]

Protected_integrations

_integrations: IntegrationIndex

Array of set up integrations.

Protected_integrationsInitialized

_integrationsInitialized: boolean

Indicates whether this client's integrations have been set up.

Protected_numProcessing

_numProcessing: number

Number of calls being processed

Protected Readonly_options

_options: NodeClientOptions

Options passed to the SDK.

Protected_sessionFlusher

_sessionFlusher: undefined | SessionFlusher

Protected Optional Readonly_transport

_transport?: Transport

Optional ExperimentalmetricsAggregator

metricsAggregator?: MetricsAggregator

A reference to a metrics aggregator

Note this is alpha API. It may experience breaking changes in the future.

Methods

Protected_captureEvent

  • _captureEvent(
        event: Event,
        hint?: EventHint,
        scope?: Scope,
    ): PromiseLike<undefined | string>

  • Processes the event and logs an error in case of rejection

    Parameters

    Returns PromiseLike<undefined | string>

Protected_captureRequestSession

  • _captureRequestSession(): void

  • Method responsible for capturing/ending a request session by calling incrementSessionStatusCount to increment appropriate session aggregates bucket

    Returns void

Protected_clearOutcomes

  • _clearOutcomes(): Outcome[]

  • Clears outcomes on this client and returns them.

    Returns Outcome[]

Protected_isClientDoneProcessing

  • _isClientDoneProcessing(timeout?: number): PromiseLike<boolean>

  • Determine if the client is finished processing. Returns a promise because it will wait timeout ms before saying "no" (resolving to false) in order to give the client a chance to potentially finish first.

    Parameters

    • Optionaltimeout: number

      The time, in ms, after which to resolve to false if the client is still busy. Passing 0 (or not passing anything) will make the promise wait as long as it takes for processing to finish before resolving to true.

    Returns PromiseLike<boolean>

    A promise which will resolve to true if processing is already done or finishes before the timeout, and false otherwise

Protected_isEnabled

  • _isEnabled(): boolean

  • Determines whether this SDK is enabled and a transport is present.

    Returns boolean

Protected_prepareEvent

  • _prepareEvent(
        event: Event,
        hint: EventHint,
        scope?: Scope,
        isolationScope?: Scope,
    ): PromiseLike<null | Event>

  • Parameters

    Returns PromiseLike<null | Event>

    Inherit Doc

Protected_process

  • _process<T>(promise: PromiseLike<T>): void

  • Occupies the client with processing and event

    Type Parameters

    • T

    Parameters

    • promise: PromiseLike<T>

    Returns void

Protected_processEvent

  • _processEvent(event: Event, hint: EventHint, scope?: Scope): PromiseLike<Event>

  • Processes an event (either error or message) and sends it to Sentry.

    This also adds breadcrumbs and context information to the event. However, platform specific meta data (such as the User's IP address) must be added by the SDK implementor.

    Parameters

    • event: Event

      The event to send to Sentry.

    • hint: EventHint

      May contain additional information about the original exception.

    • Optionalscope: Scope

      A scope containing event metadata.

    Returns PromiseLike<Event>

    A SyncPromise that resolves with the event or rejects in case event was/will not be send.

Protected_sendEnvelope

  • _sendEnvelope(
        envelope: Envelope,
    ): void | PromiseLike<void | TransportMakeRequestResponse>

  • Parameters

    • envelope: Envelope

    Returns void | PromiseLike<void | TransportMakeRequestResponse>

    Inherit Doc

Protected_setupIntegrations

  • _setupIntegrations(): void

  • Setup integrations for this client.

    Returns void

Protected_updateSessionFromEvent

  • _updateSessionFromEvent(session: Session, event: Event): void

  • Updates existing session based on the provided event

    Parameters

    Returns void

addEventProcessor

  • addEventProcessor(eventProcessor: EventProcessor): void

  • Parameters

    • eventProcessor: EventProcessor

    Returns void

    Inherit Doc

addIntegration

  • addIntegration(integration: Integration): void

  • Parameters

    • integration: Integration

    Returns void

    Inherit Doc

captureAggregateMetrics

  • captureAggregateMetrics(metricBucketItems: MetricBucketItem[]): void

  • Parameters

    • metricBucketItems: MetricBucketItem[]

    Returns void

    Inherit Doc

captureCheckIn

  • captureCheckIn(
        checkIn: CheckIn,
        monitorConfig?: MonitorConfig,
        scope?: Scope,
    ): string

  • Create a cron monitor check in and send it to Sentry.

    Parameters

    • checkIn: CheckIn

      An object that describes a check in.

    • OptionalmonitorConfig: MonitorConfig
    • Optionalscope: Scope

    Returns string

captureEvent

  • captureEvent(event: Event, hint?: EventHint, scope?: Scope): undefined | string

  • Parameters

    Returns undefined | string

    Inherit Doc

captureException

  • captureException(
        exception: any,
        hint?: EventHint,
        scope?: Scope,
    ): undefined | string

  • Parameters

    Returns undefined | string

    Inherit Doc

captureMessage

  • captureMessage(
        message: ParameterizedString,
        level?: Severity | SeverityLevel,
        hint?: EventHint,
        scope?: Scope,
    ): undefined | string

  • Parameters

    Returns undefined | string

    Inherit Doc

captureSession

  • captureSession(session: Session): void

  • Parameters

    Returns void

    Inherit Doc

close

  • close(timeout?: number): PromiseLike<boolean>

  • Parameters

    • Optionaltimeout: number

    Returns PromiseLike<boolean>

    Inherit Doc

emit

  • emit(hook: "startTransaction", transaction: Transaction): void

  • Parameters

    Returns void

    Inherit Doc

  • emit(hook: "finishTransaction", transaction: Transaction): void

  • Parameters

    Returns void

    Inherit Doc

  • emit(hook: "beforeEnvelope", envelope: Envelope): void

  • Parameters

    • hook: "beforeEnvelope"
    • envelope: Envelope

    Returns void

    Inherit Doc

  • emit(hook: "beforeSendEvent", event: Event, hint?: EventHint): void

  • Parameters

    Returns void

    Inherit Doc

  • emit(hook: "preprocessEvent", event: Event, hint?: EventHint): void

  • Parameters

    Returns void

    Inherit Doc

  • emit(
        hook: "afterSendEvent",
        event: Event,
        sendResponse: void | TransportMakeRequestResponse,
    ): void

  • Parameters

    • hook: "afterSendEvent"
    • event: Event
    • sendResponse: void | TransportMakeRequestResponse

    Returns void

    Inherit Doc

  • emit(
        hook: "beforeAddBreadcrumb",
        breadcrumb: Breadcrumb,
        hint?: BreadcrumbHint,
    ): void

  • Parameters

    Returns void

    Inherit Doc

  • emit(hook: "createDsc", dsc: DynamicSamplingContext): void

  • Parameters

    • hook: "createDsc"
    • dsc: DynamicSamplingContext

    Returns void

    Inherit Doc

  • emit(
        hook: "otelSpanEnd",
        otelSpan: unknown,
        mutableOptions: { drop: boolean },
    ): void

  • Parameters

    • hook: "otelSpanEnd"
    • otelSpan: unknown
    • mutableOptions: { drop: boolean }

    Returns void

    Inherit Doc

  • emit(
        hook: "beforeSendFeedback",
        feedback: FeedbackEvent,
        options?: { includeReplay: boolean },
    ): void

  • Parameters

    • hook: "beforeSendFeedback"
    • feedback: FeedbackEvent
    • Optionaloptions: { includeReplay: boolean }

    Returns void

    Inherit Doc

  • emit(hook: "startPageLoadSpan", options: StartSpanOptions): void

  • Parameters

    • hook: "startPageLoadSpan"
    • options: StartSpanOptions

    Returns void

    Inherit Doc

  • emit(hook: "startNavigationSpan", options: StartSpanOptions): void

  • Parameters

    • hook: "startNavigationSpan"
    • options: StartSpanOptions

    Returns void

    Inherit Doc

eventFromException

  • eventFromException(exception: unknown, hint?: EventHint): PromiseLike<Event>

  • Parameters

    Returns PromiseLike<Event>

    Inherit Doc

eventFromMessage

  • eventFromMessage(
        message: ParameterizedString,
        level?: Severity | SeverityLevel,
        hint?: EventHint,
    ): PromiseLike<Event>

  • Parameters

    Returns PromiseLike<Event>

    Inherit Doc

flush

  • flush(timeout?: number): PromiseLike<boolean>

  • Parameters

    • Optionaltimeout: number

    Returns PromiseLike<boolean>

    Inherit Doc

getDsn

  • getDsn(): undefined | DsnComponents

  • Returns undefined | DsnComponents

    Inherit Doc

getEventProcessors

  • getEventProcessors(): EventProcessor[]

  • Get all installed event processors.

    Returns EventProcessor[]

getIntegration

  • getIntegration<T extends Integration>(
        integration: IntegrationClass<T>,
    ): null | T

  • Returns the client's instance of the given integration class, it any.

    Type Parameters

    • T extends Integration

    Parameters

    • integration: IntegrationClass<T>

    Returns null | T

    Deprecated

    Use getIntegrationByName() instead.

getIntegrationById

  • getIntegrationById(integrationId: string): undefined | Integration

  • Gets an installed integration by its id.

    Parameters

    • integrationId: string

    Returns undefined | Integration

    The installed integration or undefined if no integration with that id was installed.

    Deprecated

    Use getIntegrationByName() instead.

getIntegrationByName

  • getIntegrationByName<T extends Integration = Integration>(
        integrationName: string,
    ): undefined | T

  • Gets an installed integration by its name.

    Type Parameters

    • T extends Integration = Integration

    Parameters

    • integrationName: string

    Returns undefined | T

    The installed integration or undefined if no integration with that name was installed.

getOptions

  • getOptions(): NodeClientOptions

  • Returns NodeClientOptions

    Inherit Doc

getSdkMetadata

  • getSdkMetadata(): undefined | SdkMetadata

  • Returns undefined | SdkMetadata

    The metadata of the SDK

    See

    SdkMetadata in @sentry/types

getTransport

  • getTransport(): undefined | Transport

  • Returns undefined | Transport

    Inherit Doc

init

  • init(): void

  • Returns void

    Inherit Doc

initSessionFlusher

  • initSessionFlusher(): void

  • Method that initialises an instance of SessionFlusher on Client

    Returns void

on

  • on(hook: "startTransaction", callback: (transaction: Transaction) => void): void

  • Parameters

    • hook: "startTransaction"
    • callback: (transaction: Transaction) => void

    Returns void

    Inherit Doc

  • on(
        hook: "finishTransaction",
        callback: (transaction: Transaction) => void,
    ): void

  • Parameters

    • hook: "finishTransaction"
    • callback: (transaction: Transaction) => void

    Returns void

    Inherit Doc

  • on(hook: "beforeEnvelope", callback: (envelope: Envelope) => void): void

  • Parameters

    • hook: "beforeEnvelope"
    • callback: (envelope: Envelope) => void

    Returns void

    Inherit Doc

  • on(
        hook: "beforeSendEvent",
        callback: (event: Event, hint?: EventHint) => void,
    ): void

  • Parameters

    • hook: "beforeSendEvent"
    • callback: (event: Event, hint?: EventHint) => void

    Returns void

    Inherit Doc

  • on(
        hook: "preprocessEvent",
        callback: (event: Event, hint?: EventHint) => void,
    ): void

  • Parameters

    • hook: "preprocessEvent"
    • callback: (event: Event, hint?: EventHint) => void

    Returns void

    Inherit Doc

  • on(
        hook: "afterSendEvent",
        callback: (
            event: Event,
            sendResponse: void | TransportMakeRequestResponse,
        ) => void,
    ): void

  • Parameters

    • hook: "afterSendEvent"
    • callback: (event: Event, sendResponse: void | TransportMakeRequestResponse) => void

    Returns void

    Inherit Doc

  • on(
        hook: "beforeAddBreadcrumb",
        callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void,
    ): void

  • Parameters

    Returns void

    Inherit Doc

  • on(hook: "createDsc", callback: (dsc: DynamicSamplingContext) => void): void

  • Parameters

    • hook: "createDsc"
    • callback: (dsc: DynamicSamplingContext) => void

    Returns void

    Inherit Doc

  • on(
        hook: "otelSpanEnd",
        callback: (otelSpan: unknown, mutableOptions: { drop: boolean }) => void,
    ): void

  • Parameters

    • hook: "otelSpanEnd"
    • callback: (otelSpan: unknown, mutableOptions: { drop: boolean }) => void

    Returns void

    Inherit Doc

  • on(
        hook: "beforeSendFeedback",
        callback: (
            feedback: FeedbackEvent,
            options?: { includeReplay: boolean },
        ) => void,
    ): void

  • Parameters

    • hook: "beforeSendFeedback"
    • callback: (feedback: FeedbackEvent, options?: { includeReplay: boolean }) => void

    Returns void

    Inherit Doc

  • on(
        hook: "startPageLoadSpan",
        callback: (options: StartSpanOptions) => void,
    ): void

  • Parameters

    • hook: "startPageLoadSpan"
    • callback: (options: StartSpanOptions) => void

    Returns void

    Inherit Doc

  • on(
        hook: "startNavigationSpan",
        callback: (options: StartSpanOptions) => void,
    ): void

  • Parameters

    • hook: "startNavigationSpan"
    • callback: (options: StartSpanOptions) => void

    Returns void

    Inherit Doc

recordDroppedEvent

  • recordDroppedEvent(
        reason: EventDropReason,
        category: DataCategory,
        eventOrCount?: number | Event,
    ): void

  • Parameters

    • reason: EventDropReason
    • category: DataCategory
    • OptionaleventOrCount: number | Event

    Returns void

    Inherit Doc

sendEvent

  • sendEvent(event: Event, hint?: EventHint): void

  • Parameters

    Returns void

    Inherit Doc

sendSession

  • sendSession(session: Session | SessionAggregates): void

  • Parameters

    • session: Session | SessionAggregates

    Returns void

    Inherit Doc

setupIntegrations

  • setupIntegrations(forceInitialize?: boolean): void

  • This is an internal function to setup all integrations that should run on the client.

    Parameters

    • OptionalforceInitialize: boolean

    Returns void

    Deprecated

    Use client.init() instead.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods