Loader Script

Learn about the Sentry JavaScript Loader Script

The Loader Script is the easiest way to initialize the Sentry SDK. The Loader Script also automatically keeps your Sentry SDK up to date and offers configuration for different Sentry features.

To use the loader, go in the Sentry UI to Settings > Projects > (select project) > Client Keys (DSN), and then press the "Configure" button. Copy the script tag from the "JavaScript Loader" section and include it as the first script on your page. By including it first, you allow it to catch and buffer events from any subsequent scripts, while still ensuring the full SDK doesn't load until after everything else has run.

Copied
<script
  src="https://js.sentry-cdn.com/examplePublicKey.min.js"
  crossorigin="anonymous"
></script>

By default, Performance Monitoring and Session Replay are enabled.

To have correct stack traces for minified asset files when using the Loader Script, you will have to either host your Source Maps publicly or upload them to Sentry.

The loader has a few configuration options:

  • What version of the SDK to load
  • Using Performance Monitoring
  • Using Session Replay
  • Showing debug logs

To configure the version, use the dropdown in the "JavaScript Loader" settings, directly beneath the script tag you copied earlier.

JavaScript Loader Settings

Note that because of caching, it can take a few minutes for version changes made here to take effect.

If you only use the Loader for errors, the loader won't load the full SDK until triggered by one of the following:

  • an unhandled error
  • an unhandled promise rejection
  • a call to Sentry.captureException
  • a call to Sentry.captureMessage
  • a call to Sentry.captureEvent

Once one of those occurs, the loader will buffer that event and immediately request the full SDK from our CDN. Any events that occur between that request being made and the completion of SDK initialization will also be buffered, and all buffered events will be sent to Sentry once the SDK is fully initialized.

Alternatively, you can set the loader to request the full SDK earlier: still as part of page load, but after all of the other JavaScript on the page has run. (In other words, in a subsequent event loop.) To do this, include data-lazy="no" in your script tag.

Copied
<script
  src="https://js.sentry-cdn.com/examplePublicKey.min.js"
  crossorigin="anonymous"
  data-lazy="no"
></script>

Finally, if you want to control the timing yourself, you can call Sentry.forceLoad(). You can do this as early as immediately after the loader runs (which has the same effect as setting data-lazy="no") and as late as the first unhandled error, unhandled promise rejection, or call to Sentry.captureMessage or Sentry.captureEvent (which has the same effect as not calling it at all). Note that you can't delay loading past one of the aforementioned triggering events.

If Performance Monitoring and/or Session Replay is enabled, the SDK will immediately fetch and initialize the bundle to make sure it can capture transactions and/or replays once the page loads.

While the Loader Script will work out of the box without any configuration in your application, you can still configure the SDK according to your needs.

For Performance Monitoring, the SDK will be initialized with tracesSampleRate: 1 by default. This means that the SDK will capture all traces.

For Session Replay, the defaults are replaysSessionSampleRate: 0.1 and replaysOnErrorSampleRate: 1. This means Replays will be captured for 10% of all normal sessions and for all sessions with an error.

You can configure the release by adding the following to your page:

Copied
<script>
  window.SENTRY_RELEASE = {
    id: '...',
  };
</script>

The loader script always includes a call to Sentry.init with a default configuration, including your DSN. If you want to configure your SDK beyond that, you can configure a custom init call by defining a window.sentryOnLoad function. Whatever is defined inside of this function will always be called first, before any other SDK method is called.

Be sure to define this function before you add the loader script, to ensure it can be called at the right time:

Copied
<script>
  // Configure sentryOnLoad before adding the Loader Script
  window.sentryOnLoad = function () {
    Sentry.init({
      // add custom config here
    });
  };
</script>

<script
  src="https://js.sentry-cdn.com/examplePublicKey.min.js"
  crossorigin="anonymous"
></script>

Inside of the window.sentryOnLoad function, you can configure a custom Sentry.init() call. You can configure your SDK exactly the way you would if you were using the CDN, with one difference: your Sentry.init() call doesn't need to include your DSN, since it's already been set. Inside of this function, the full Sentry SDK is guaranteed to be loaded & available.

Copied
<script>
  // Configure sentryOnLoad before adding the Loader Script
  window.sentryOnLoad = function () {
    Sentry.init({
      release: " ... ",
      environment: " ... "
    });
    Sentry.setTag(...);
    // etc.
  };
</script>

By default, the loader will make sure you can call these functions directly on Sentry at any time, even if the SDK is not yet loaded:

  • Sentry.captureException()
  • Sentry.captureMessage()
  • Sentry.captureEvent()
  • Sentry.addBreadcrumb()
  • Sentry.withScope()
  • Sentry.showReportDialog()

If you want to call any other method when using the Loader, you have to guard it with Sentry.onLoad(). Any callback given to onLoad() will be called either immediately (if the SDK is already loaded), or later once the SDK has been loaded:

Copied
// Guard against window.Sentry not being available, e.g. due to Ad-blockers
window.Sentry &&
  Sentry.onLoad(function () {
    // Inside of this callback,
    // we guarantee that `Sentry` is fully loaded and all APIs are available
    const client = Sentry.getClient();
    // do something custom here
  });

When using the Loader Script with just errors, the script injects the SDK asynchronously. This means that only unhandled errors and unhandled promise rejections will be caught and buffered before the SDK is fully loaded. Specifically, capturing breadcrumb data will not be available until the SDK is fully loaded and initialized. To reduce the amount of time these features are unavailable, set data-lazy="no" or call forceLoad() as described above.

If you want to understand the inner workings of the loader itself, you can read the documented source code in all its glory over at the Sentry repository.

Sentry supports loading the JavaScript SDK from a CDN. Generally we suggest using our Loader instead. If you must use a CDN, see Available Bundles below.

To use Sentry for error and performance monitoring, you can use the following bundle:

Copied
<script
  src="https://browser.sentry-cdn.com/8.4.0/bundle.tracing.min.js"
  integrity="sha384-OcLIPzmrzhJ94lHt9kikMK+HQ7MOv0kDZH7aYmuxoLa0QoJhMQXXoepWsaBWLgva"
  crossorigin="anonymous"
></script>

To use Sentry for error and performance monitoring, as well as for Session Replay, you can use the following bundle:

Copied
<script
  src="https://browser.sentry-cdn.com/8.4.0/bundle.tracing.replay.min.js"
  integrity="sha384-Rf+XJT/f9AXnkFQISKt/jsSGHRM/8+raZavmU1L2vj7l7sGpHDTmu3pazQemDLZu"
  crossorigin="anonymous"
></script>

To use Sentry for error monitoring, as well as for Session Replay, but not for performance monitoring, you can use the following bundle:

Copied
<script
  src="https://browser.sentry-cdn.com/8.4.0/bundle.replay.min.js"
  integrity="sha384-+7EkxooGHFfLyDm+jdNaybwsSQY1mJJw5ZGLu8hzWrhZFWcAuf7q4+FEEFymOD8W"
  crossorigin="anonymous"
></script>

If you only use Sentry for error monitoring, and don't need performance tracing or replay functionality, you can use the following bundle:

Copied
<script
  src="https://browser.sentry-cdn.com/8.4.0/bundle.min.js"
  integrity="sha384-Q4/HqDWty0P+OQZ3wXY81I/5ZQ6HwGJ5mGxMs7nSjS7CFI/Mpb5NAAxNlBU7vEZH"
  crossorigin="anonymous"
></script>

Once you've included the Sentry SDK bundle in your page, you can use Sentry in your own bundle:

Copied
Sentry.init({
  dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0',
  // this assumes your build process replaces `process.env.npm_package_version` with a value
  release: 'my-project-name@' + process.env.npm_package_version,
  integrations: [
    // If you use a bundle with performance monitoring enabled, add the BrowserTracing integration
    Sentry.browserTracingIntegration(),
    // If you use a bundle with session replay enabled, add the Replay integration
    Sentry.replayIntegration(),
  ],

  // We recommend adjusting this value in production, or using tracesSampler
  // for finer control
  tracesSampleRate: 1.0,

  // Set `tracePropagationTargets` to control for which URLs distributed tracing should be enabled
  tracePropagationTargets: ['localhost', /^https:\/\/yourserver\.io\/api/],
});

Our CDN hosts a variety of bundles:

  • @sentry/browser with error monitoring only (named bundle.<modifiers>.js)
  • @sentry/browser with error and performance monitoring (named bundle.tracing.<modifiers>.js)
  • @sentry/browser with error and session replay (named bundle.replay.<modifiers>.js)
  • @sentry/browser with error, performance monitoring and session replay (named bundle.tracing.replay.<modifiers>.js)
  • each of the integrations in @sentry/integrations (named <integration-name>.<modifiers>.js)

Each bundle is offered in both ES6 and ES5 versions. Since v7 of the SDK, the bundles are ES6 by default. To use the ES5 bundle, add the .es5 modifier.

Each version has three bundle varieties:

  • minified (.min)
  • unminified (no .min), includes debug logging
  • minified with debug logging (.debug.min)

Bundles that include debug logging output more detailed log messages, which can be helpful for debugging problems. Make sure to enable debug to see debug messages in the console. Unminified and debug logging bundles have a greater bundle size than minified ones.

For example:

  • bundle.js is @sentry/browser, compiled to ES6 but not minified, with debug logging included (as it is for all unminified bundles)
  • rewriteframes.es5.min.js is the RewriteFrames integration, compiled to ES5 and minified, with no debug logging
  • bundle.tracing.es5.debug.min.js is @sentry/browser with performance monitoring enabled, compiled to ES5 and minified, with debug logging included
FileIntegrity Checksum
browserprofiling.debug.min.jssha384-11eHCqm6Pl2j+2y+jyuJrKmMG5Fxi4uKQIzStFvTFt+48nhm/TH+NtF3vyljDgXJ
browserprofiling.jssha384-ngqnfL186uIlm9afzBPbBNH7Q/2EfBs6S59Yuyv7Um3ltTyQtFtnJQcsFPe56Vya
browserprofiling.min.jssha384-mViBjY8iY7AqDkWUG40+U/ffLi9sPoMseV3dO1xkWt4MIGmJbUCt/gAeUebYkWaF
bundle.debug.min.jssha384-w3tP34WitaTNMSJfJ7WSAYUQ9vxUAQYrzPIIIRqYkVbazU7sltn4txMp6ZRsOWdJ
bundle.feedback.debug.min.jssha384-U+YOV/LARbup44Qp8JWw/TdxhIB6iaq2GUBocYR3zUYL0Dg/eCnQQOkIzBeVH1ul
bundle.feedback.jssha384-c+LRrsd0AxUVaQMoOTYUFqDWRS3rBhIKckyuqo9aRRi38Iddh8q8tvcAXjYomHs0
bundle.feedback.min.jssha384-rZ8Nw9ibWTNXb503Mk07G3onJZBdz2hC5JsBny/oE9BKeyssvb+eKtww3HYO8n2+
bundle.jssha384-3sHmIhW7miWj2Otg6yGw729H61XCoR/sHVAfKfLkv28XWtBiiVx6g4vmbrJcflDi
bundle.min.jssha384-Q4/HqDWty0P+OQZ3wXY81I/5ZQ6HwGJ5mGxMs7nSjS7CFI/Mpb5NAAxNlBU7vEZH
bundle.replay.debug.min.jssha384-ve1AtDwXM7+FBNJkThY4VMi2MnM2x5lNzU8F/VnaoETgAXr0DQ+hX9hXEd7stPg4
bundle.replay.jssha384-lfTdWQlCwWlfuOJkxXTJ/j8EdMr3BN6YO8ol+MxXJEIX4UEiJZCgXz+gAv9ba9xM
bundle.replay.min.jssha384-+7EkxooGHFfLyDm+jdNaybwsSQY1mJJw5ZGLu8hzWrhZFWcAuf7q4+FEEFymOD8W
bundle.tracing.debug.min.jssha384-PpG6fQOQ+ijCUkfNpSgDAnyul7dqV1FOKNER65hwk3ECvsNd75zrLhxmmXB5z8cN
bundle.tracing.jssha384-GumD+7dKH+NK0+76UDE1ufUKhe1KJPxJ/RaEjfz82X3fj+3GzsjjagJqjW+HkrJK
bundle.tracing.min.jssha384-OcLIPzmrzhJ94lHt9kikMK+HQ7MOv0kDZH7aYmuxoLa0QoJhMQXXoepWsaBWLgva
bundle.tracing.replay.debug.min.jssha384-+2Imy46iXAgpwGgKtIk18OzyZsXl7dK86NHvGp4IaxZScLOCRbOgqAROfEMpxwX5
bundle.tracing.replay.feedback.debug.min.jssha384-Y6xvm8I/L9Kanr5gePZl3qtuOg3YbttKV3H55Gq9jiHGF7KyM1JKgYoISqvWTO/y
bundle.tracing.replay.feedback.jssha384-JHL8HNcF/N9szuMsxpZSFD83jbdACZ6RQt2DqSi0lW/2uWONYVyWw3uyDV6b/o3x
bundle.tracing.replay.feedback.min.jssha384-HNJe1p4C4+vFUdmyybMsi5C39eY4fy/nFiNtBa2ruRmwwv2PaoP6CWpUMJlEP9yx
bundle.tracing.replay.jssha384-G4jatuH/5xfIWZlY4NFTvrP8nUCtidFSS48nIS5/VaC7/F81gSnO/gIy1v2RVMOw
bundle.tracing.replay.min.jssha384-Rf+XJT/f9AXnkFQISKt/jsSGHRM/8+raZavmU1L2vj7l7sGpHDTmu3pazQemDLZu
captureconsole.debug.min.jssha384-5UUFARzSre2Oc3m8KYnAObGAju5zFwSf0u2NspBewDWfOHGpY33O5N0BjmqZON3L
captureconsole.jssha384-qC0pMx4WnO5e4p8PC/Z3ZUSrf4j/BuRm/wKTvu+AIiXSnf3pcRD//NgQd6618Ie9
captureconsole.min.jssha384-UwIB91GyDvKvuJH3ByLFijA7COjhhMoVYMRZvWiHDqlXxdduI+9lcH7zv3ea5SJn
contextlines.debug.min.jssha384-WALQWHW0yWC50q3r3KwN/maduoSuL9UNN8atf3h+sN3Ym/vsV2xXMJipyIIpO/Gk
contextlines.jssha384-r0gaxYeN4452taTrlmO57VW8xhx7gR84jbVAamGWwU0VuHswP1jZIbOzx/7iOMgl
contextlines.min.jssha384-3IgK6vNO8aPc53Coc7456XHjTNpaTmQozR4+2CMUmgR+K0cEtk0njO6eEi+qlEIP
debug.debug.min.jssha384-cGZPRbSkUwQxMQCA4eFuanV2kLj5sQunh7uHWpU39ZP3UTGkHWEOQo5Mqpz2i9b5
debug.jssha384-8s/QYDYJC+8EnOKjraiYa+gv1+Wb9B4r9csh79mgaSqfMKJ5GHHhPcdz2AfL9n6d
debug.min.jssha384-mLMMvcNpg/4PTbVuroJpi3XZ/oy4qbGAfJvsf29Wwdw9T5x0lw2NwFaBA21GTZUP
dedupe.debug.min.jssha384-P7U9sDh+YBO5utZB+ow5xfyhJanipvWaMisTC7dwyjQMz0A1ijZe6eEfJsWtqLhs
dedupe.jssha384-UGKSKMKOuN7QTNo7hXWzgPwbVbRYyUuf8rHs5uBMIDYkMSiFPiXCKTh14mIPcANQ
dedupe.min.jssha384-3/lmfjQ8qXhIcrrikm1f9XFK8RD43j+wM5v/VwcflHbH9P2MtrOAc8J34bsr9m+2
extraerrordata.debug.min.jssha384-ELC2Z71dPTyh/aeT4bOHkShn8/9sSj5laP1ZAai2B1E1MZp0vvu+vt3tIUDRMraN
extraerrordata.jssha384-WxPu/Pn1qyzEv6eI0Mbv+sjdf92i5ckpL2K8aHCHp9ZTnkJIN/NF+zE8Vq9HmDfD
extraerrordata.min.jssha384-ASG7rZhBomOmY7iUZc8Y2tauMMic+pt2Iarninyf0B84mLkhd2HPY7x3V5ahqNE3
feedback-modal.debug.min.jssha384-mxwEBlzMt0/6DvoiOlengtiyJrxWvQ6k6SkXEGa+jgdOTN3NjNrvZf2CoYOdsgep
feedback-modal.jssha384-VM5Stod1Kr47yjdrdsWQ34cwfe3apq38ClQnrBe3/mgXncoxX2o6MPHhlm3x2OKE
feedback-modal.min.jssha384-Y1vwgdMH1jCa/4tZ1YFdcdNF61RtO9Hut8P61YHstb8qgv6SWMQv/7pueK/edOUZ
feedback-screenshot.debug.min.jssha384-FsxjIm3ZMqs5UTB488KWlXQPoVolTH7ky4bB37pT8wXg5H2oaa2trevgUb7eURw4
feedback-screenshot.jssha384-ETgcAzi76G9MsBze81apXKuY6qbQqLba5EGnU6LdjSgpkutxkxRiaWC+t3SEG11S
feedback-screenshot.min.jssha384-VNP6c/viFUYOcaoFox2E/tn1e7yWVTQpXBOmagPwvi9+2NnsO1CTrqey3Dg9ejne
feedback.debug.min.jssha384-zndVNwkzcOAI914DJImD10Z3Cj51DUOfpNKuLfqSn9aRHFsgcrfmLyEsaZ4Sjlak
feedback.jssha384-6woHmmTvFD+iAoob2osjvt2qTbXVWw9FPHyKZ1CdjRuDpZNwH4iL9brVM3UaMrto
feedback.min.jssha384-5R3wNhFOUIeHyIhW7BOLT4uUSmgMin0Aze0T/BJ7cXFDL6DtQqAh1x4rzb29H3dX
httpclient.debug.min.jssha384-JSV7kpKjkh1g15W2qt31z3/JchLCh6R8RnrE/EPj6rmFTJfB/Dri16V/DcY6IBiX
httpclient.jssha384-HLx7pt8GM3Tdqw9x5zRBfdNfyhV1gWWkz9jCBRWUvnugNVGInui1SjFLFcHgIC2w
httpclient.min.jssha384-y0EEU0heOxr5xIRbhOO6pymclgOB9UTPzm9AB9T8Lnt4PpMneDcUJ862hydc3ADn
replay-canvas.debug.min.jssha384-aooYMP++8CzVYZaRVNbvXJYWHeyB3Y6Itib5Rx98rWXzBBH6cI75QmOBg1PDHuSA
replay-canvas.jssha384-h791SCz/fMOgqRgXGgcNdIgz9eGN/UMp1Z4Pf59oW651vyI8fECDyLJIoSasTlJ2
replay-canvas.min.jssha384-/AZMYIEoSEpCXq7M3JxOZGKfuFt6YoL3yLbpmKuI80XCxvJwx33P9atlJzIvcZ5H
reportingobserver.debug.min.jssha384-YGIQ+3dtDhs1xXrOFocKb7KWo/sdW5OYDSqNH/2AQ9lLV+eQRNgbluF9m7odQ5oh
reportingobserver.jssha384-H+jB/cpLqEIeyyiG/JRQez80D7aSP93ceu3BJ1hRJGI7J+Lfme4OGKZMI7JgHItg
reportingobserver.min.jssha384-G4zwztxz6RjoSJ7lCYlUYDwJj29wBS/37+20LvpDSA8MmTWdP95m8Po/N7FakFCn
rewriteframes.debug.min.jssha384-8sy5sWyftmO3qqKxwERdaNHhXsTvXgU6Xu2ExJUFV5Lfw7ssaolrtFBInIafL1HB
rewriteframes.jssha384-7hnAcjV+1jH2PoIoU1mRLgQvD3jtYEIsFUsLS/WOY7znXzT2Z4ev0nbYb+pf7pGG
rewriteframes.min.jssha384-Ev2ihMNjZnxKPEV53DnSpF5zyc0XVBSusOPa2u9stt/9cS2TZ9ygoy+ZpY7Nd9gv
sessiontiming.debug.min.jssha384-vJ4TwrAk0HKxIT//t0jZ5zfQoKK6MNpnvuNJjZ8D8dKa6QXvESr9oTAz2jcZlH0d
sessiontiming.jssha384-DVuBBorPAB7lIj5tpBMTlvHRBpEUKHrrpzf0EoKbypR71S3ZRE37qhI5t4j8IJyp
sessiontiming.min.jssha384-3ex8GxbY0B9G8xMSovp2EZlzq4AjNztc061MgEud6tnerKNELT7+zFkoFmcFJzH+

If you use the defer script attribute, we strongly recommend that you place the script tag for the browser SDK first and mark all of your other scripts with defer (but not async). This will guarantee that that the Sentry SDK is executed before any of the others.

Without doing this you will find that it's possible for errors to occur before Sentry is loaded, which means you'll be flying blind to those issues.

If you have a Content Security Policy (CSP) set up on your site, you will need to add the script-src of wherever you're loading the SDK from, and the origin of your DSN. For example:

  • script-src: https://browser.sentry-cdn.com https://js.sentry-cdn.com
  • connect-src: *.sentry.io
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").