Pluggable Integrations
These pluggable integrations are snippets of code that augment functionality for specific applications and/or frameworks. We document them so you can see what they do and that they can be enabled.
How to Enable
Install the @sentry/integrations
package and provide a new instance with your config to integrations
option. Include the plugin after the SDK has been loaded.
For example:
import * as Sentry from "@sentry/browser";
import { ReportingObserver as ReportingObserverIntegration } from "@sentry/integrations";
Sentry.init({
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
integrations: [new ReportingObserverIntegration()],
});
ExtraErrorData
Import name: Sentry.Integrations.ExtraErrorData
This integration extracts all non-native attributes from the Error object and attaches them to the event as the extra
data.
Available options:
{
// limit of how deep the object serializer should go. Anything deeper than limit will
// be replaced with standard Node.js REPL notation of [Object], [Array], [Function] or
// a primitive value. Defaults to 3.
depth: number;
}
CaptureConsole
Import name: Sentry.Integrations.CaptureConsole
This integration captures all Console API
calls and redirects them to Sentry using the captureMessage
call. It then retriggers to preserve default native behavior.
{
// array of methods that should be captured
// defaults to ['log', 'info', 'warn', 'error', 'debug', 'assert']
levels: string[];
}
Dedupe
Import name: Sentry.Integrations.Dedupe
This integration deduplicates certain events; it can be helpful if you are receiving many duplicate errors. Be aware that Sentry will only compare stack traces and fingerprints.
Debug
Import name: Sentry.Integrations.Debug
This integration allows you to inspect the content of the processed event, that will be passed to beforeSend
and effectively send to the Sentry SDK. It will always run as the last integration, no matter when it was registered.
Available options:
{
// trigger DevTools debugger instead of using console.log
debugger: boolean;
// stringify event before passing it to console.log
stringify: boolean;
}
RewriteFrames
Import name: Sentry.Integrations.RewriteFrames
This integration allows you to apply a transformation to each frame of the stack trace. In the streamlined scenario, it can be used to change the name of the file frame it originates from, or it can be fed with an iterated function to apply any arbitrary transformation.
On Windows machines, you have to use Unix paths and skip the volume letter in root
option to enable. For example C:\\Program Files\\Apache\\www
won’t work, however, /Program Files/Apache/www
will.
Available options:
{
// root path that will be appended to the basename of the current frame's url
root: string;
// function that takes the frame, applies a transformation, and returns it
iteratee: (frame) => frame;
}
ReportingObserver
Import name: Sentry.Integrations.ReportingObserver
This integration hooks into the ReportingObserver API and sends captured events through to Sentry. It can be configured to handle only specific issue types.
Available options:
{
types: <'crash'|'deprecation'|'intervention'>[];
}
- Package:
- npm:@sentry/electron
- Version:
- 2.0.4
- Repository:
- https://github.com/getsentry/sentry-electron