@sentry/integrations

  • Version 7.0.0
  • Published
  • 146 kB
  • 4 dependencies
  • BSD-3-Clause license

Install

npm i @sentry/integrations
yarn add @sentry/integrations
pnpm add @sentry/integrations

Overview

Pluggable integrations that can be used to enhance JS SDKs

Index

Classes

class CaptureConsole

class CaptureConsole implements Integration {}
  • Send Console API calls as Sentry Events

constructor

constructor(options?: { levels?: string[] });

property id

static id: string;

property name

name: string;

method setupOnce

setupOnce: (
_: (callback: EventProcessor) => void,
getCurrentHub: () => Hub
) => void;

class Debug

class Debug implements Integration {}
  • Integration to debug sent Sentry events. This integration should not be used in production

constructor

constructor(options?: DebugOptions);

    property id

    static id: string;

    property name

    name: string;

    method setupOnce

    setupOnce: (
    addGlobalEventProcessor: (callback: EventProcessor) => void,
    getCurrentHub: () => Hub
    ) => void;

    class Dedupe

    class Dedupe implements Integration {}
    • Deduplication filter

    property id

    static id: string;

    property name

    name: string;

    method setupOnce

    setupOnce: (
    addGlobalEventProcessor: (callback: EventProcessor) => void,
    getCurrentHub: () => Hub
    ) => void;

    class ExtraErrorData

    class ExtraErrorData implements Integration {}
    • Patch toString calls to return proper name for wrapped functions

    constructor

    constructor(options?: ExtraErrorDataOptions);

    property id

    static id: string;

    property name

    name: string;

    method enhanceEventWithErrorData

    enhanceEventWithErrorData: (event: Event, hint?: EventHint) => Event;
    • Attaches extracted information from the Error object to extra field in the Event

    method setupOnce

    setupOnce: (
    addGlobalEventProcessor: (callback: EventProcessor) => void,
    getCurrentHub: () => Hub
    ) => void;

    class Offline

    class Offline implements Integration {}
    • cache offline errors and send when connected

    constructor

    constructor(options?: { maxStoredEvents?: number });

    property global

    global: any;
    • the global instance

    property hub

    hub?: Hub;
    • the current hub instance

    property id

    static id: string;

    property maxStoredEvents

    maxStoredEvents: number;
    • maximum number of events to store while offline

    property name

    readonly name: string;

    property offlineEventStore

    offlineEventStore: LocalForage;
    • event cache

    method setupOnce

    setupOnce: (
    addGlobalEventProcessor: (callback: EventProcessor) => void,
    getCurrentHub: () => Hub
    ) => void;

    class ReportingObserver

    class ReportingObserver implements Integration {}
    • Reporting API integration - https://w3c.github.io/reporting/

    constructor

    constructor(_options?: { types?: ReportTypes[] });

    property id

    static id: string;

    property name

    readonly name: string;

    method handler

    handler: (reports: Report[]) => void;

    method setupOnce

    setupOnce: (
    _: (callback: EventProcessor) => void,
    getCurrentHub: () => Hub
    ) => void;

    class RewriteFrames

    class RewriteFrames implements Integration {}
    • Rewrite event frames paths

    constructor

    constructor(options?: {
    root?: string;
    prefix?: string;
    iteratee?: StackFrameIteratee;
    });

    property id

    static id: string;

    property name

    name: string;

    method process

    process: (originalEvent: Event) => Event;
    • JSDoc

    method setupOnce

    setupOnce: (
    addGlobalEventProcessor: (callback: EventProcessor) => void,
    getCurrentHub: () => Hub
    ) => void;

    class SessionTiming

    class SessionTiming implements Integration {}
    • This function adds duration since Sentry was initialized till the time event was sent

    property id

    static id: string;

    property name

    name: string;

    method process

    process: (event: Event) => Event;

    method setupOnce

    setupOnce: (
    addGlobalEventProcessor: (callback: EventProcessor) => void,
    getCurrentHub: () => Hub
    ) => void;

    class Transaction

    class Transaction implements Integration {}
    • Add node transaction to the event

    property id

    static id: string;

    property name

    name: string;

    method process

    process: (event: Event) => Event;

    method setupOnce

    setupOnce: (
    addGlobalEventProcessor: (callback: EventProcessor) => void,
    getCurrentHub: () => Hub
    ) => void;

    Package Files (10)

    Dependencies (4)

    Dev Dependencies (1)

    Peer Dependencies (0)

    No peer dependencies.

    Badge

    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@sentry/integrations.

    • Markdown
      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@sentry/integrations)
    • HTML
      <a href="https://www.jsdocs.io/package/@sentry/integrations"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>