Integrations

Learn more about how integrations extend the functionality of our SDK to cover common libraries and environments automatically.

The Sentry SDK uses integrations to hook into the functionality of popular libraries to automatically instrument your application and give you the best data out of the box.

Integrations automatically add error instrumentation, performance instrumentation, and/or extra context information to your application. Some are enabled by default, but you can disable them or modify their settings.

Auto EnabledErrorsTracingAdditional Context
awsIntegration✓✓
awsLambdaIntegration✓✓
consoleIntegration✓✓
contextLinesIntegration✓✓
dedupeIntegration✓✓
functionToStringIntegration✓
httpIntegration✓✓✓✓
inboundFiltersIntegration✓✓
linkedErrorsIntegration✓✓
modulesIntegration✓✓
nodeContextIntegration✓✓
nativeNodeFetchIntegration✓✓✓
onUncaughtExceptionIntegration✓✓
onUnhandledRejectionIntegration✓✓
childProcessIntegration✓✓
amqplibIntegration✓
anrIntegration✓
captureConsoleIntegration✓
dataloaderIntegration✓
debugIntegration
extraErrorDataIntegration✓
fsIntegration✓
genericPoolIntegration✓
graphqlIntegration✓
kafkaIntegration✓
knexIntegration✓
localVariablesIntegration✓
lruMemoizerIntegration✓
mongoIntegration✓
mongooseIntegration✓
mysqlIntegration✓
mysql2Integration✓
nodeProfilingIntegration✓
postgresIntegration✓
prismaIntegration✓
redisIntegration✓
requestDataIntegration✓
rewriteFramesIntegration✓
sessionTimingIntegration✓
tediousIntegration✓
trpcMiddleware✓✓✓

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:

Copied
Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",

  integrations: [
    Sentry.linkedErrorsIntegration({
      limit: 7,
    }),
  ],
});

You can add additional integrations in your init call:

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

Copied
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:

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

Previous
Environments
Next
Amqplib
Help improve this content
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").