Integrations
Learn more about how integrations extend the functionality of our SDK to cover common libraries and environments automatically.
Sentry provides a number of integrations which are designed to add automatic instrumentation to your application. Some of these integrations are enabled by default, while others have to be explicitly enabled.
To disable system integrations, set defaultIntegrations: false
when calling init()
.
To override their settings, provide a new instance with your config to the integrations
option. For example, to turn off browser capturing console calls:
Sentry.init({
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
integrations: [
Sentry.linkedErrorsIntegration({
limit: 7,
}),
],
});
You can add additional integrations in your init
call:
import * as Sentry from "@sentry/node";
Sentry.init({
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
integrations: [],
});
Sentry.addIntegration(Sentry.captureConsoleIntegration());
Alternatively, you can add integrations via Sentry.addIntegration()
. This is useful if you only want to enable an integration in a specific environment or if you want to load an integration later. For all other cases, we recommend you use the integrations
option.
import * as Sentry from "@sentry/node";
Sentry.init({
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
integrations: [Sentry.captureConsoleIntegration()],
});
If you only want to remove a single or some of the default integrations, instead of disabling all of them with defaultIntegrations: false
, you can use the following syntax to filter out the ones you don't want.
This example removes the integration for adding breadcrumbs to the event, which is enabled by default:
Sentry.init({
// ...
integrations: function (integrations) {
// integrations will be all default integrations
return integrations.filter(function (integration) {
return integration.name !== "Breadcrumbs";
});
},
});
You can also create custom integrations.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").