Sentry for Browser JavaScript
Learn how to manually set up Sentry in your JavaScript app and capture your first errors.
Use curl to download, read and follow https://skills.sentry.dev/instrument to set up the Sentry Browser JavaScript SDK.Using a framework?
This guide focuses on plain JavaScript. If you're working with React, Next.js, or any other framework, choose the fitting SDK from the left-hand dropdown.
You need:
We recommend installing Sentry via a package manager. If that isn't an option for you, you can use the Loader Script or a CDN bundle.
Run the command for your preferred package manager to add the Sentry SDK to your application:
npm install @sentry/browser --save
npm install @sentry/browser --save
yarn add @sentry/browser
pnpm add @sentry/browser
In Sentry, go to Settings > Projects > (select project) > SDK Setup > Loader Script. Enable Tracing, Session Replay, Logs and Metrics, and User Feedback. Then, copy the script tag and place it before all other scripts in your app.
Sentry provides bundles with different feature combinations. In this guide, we'll use the full bundle with all features. Copy the script tag and place it before all other scripts in your app.
If you're updating your Sentry SDK to the latest version, check out our migration guide to learn more about breaking changes.
Error Monitoring starts working as soon as you call Sentry.init(). Logs and Application Metrics need no extra configuration, and you'll learn how to send them in steps #3 and #4. This guide also enables Tracing, Session Replay, and User Feedback.
Initialize Sentry as early as possible in your application's lifecycle. Use the tab that matches how you installed the SDK (npm, Loader, or CDN).
The snippet also turns on:
- Tracing: via
browserTracingIntegration()andtracesSampleRate - Session Replay: via
replayIntegration(), sampled withreplaysSessionSampleRateandreplaysOnErrorSampleRate - User Feedback: via
feedbackIntegration()
import * as Sentry from "@sentry/browser";
Sentry.init({
dsn: "___PUBLIC_DSN___",
// Alternatively, use `process.env.npm_package_version` for a dynamic release version
// if your build tool supports it.
release: "my-project-name@2.3.12",
integrations: [
// enables automatic instrumentation
Sentry.browserTracingIntegration(),
// enables Session Replay
Sentry.replayIntegration(),
// enables User Feedback
Sentry.feedbackIntegration({
// Additional integration configuration goes in here
colorScheme: "system",
}),
],
// Enables Tracing.
// Set to 1.0 to capture 100% of spans for tracing.
// We recommend reducing this value in production.
tracesSampleRate: 1.0,
// Set trace propagation targets for your API requests
tracePropagationTargets: ["localhost", /^https:\/\/yourserver\.io\/api/],
// Capture replays for 10% of all sessions,
// plus for 100% of sessions with an error
// Requires Sentry.replayIntegration()
replaysSessionSampleRate: 0.1,
replaysOnErrorSampleRate: 1.0,
});
import * as Sentry from "@sentry/browser";
Sentry.init({
dsn: "___PUBLIC_DSN___",
// Alternatively, use `process.env.npm_package_version` for a dynamic release version
// if your build tool supports it.
release: "my-project-name@2.3.12",
integrations: [
// enables automatic instrumentation
Sentry.browserTracingIntegration(),
// enables Session Replay
Sentry.replayIntegration(),
// enables User Feedback
Sentry.feedbackIntegration({
// Additional integration configuration goes in here
colorScheme: "system",
}),
],
// Enables Tracing.
// Set to 1.0 to capture 100% of spans for tracing.
// We recommend reducing this value in production.
tracesSampleRate: 1.0,
// Set trace propagation targets for your API requests
tracePropagationTargets: ["localhost", /^https:\/\/yourserver\.io\/api/],
// Capture replays for 10% of all sessions,
// plus for 100% of sessions with an error
// Requires Sentry.replayIntegration()
replaysSessionSampleRate: 0.1,
replaysOnErrorSampleRate: 1.0,
});
<script
src="https://js.sentry-cdn.com/___PUBLIC_KEY___.min.js"
crossorigin="anonymous"
></script>
<script>
window.sentryOnLoad = function () {
Sentry.init({
dsn: "___PUBLIC_DSN___",
// Alternatively, use `process.env.npm_package_version` for a dynamic release version
// if your build tool supports it.
release: "my-project-name@2.3.12",
integrations: [
// enables automatic instrumentation
Sentry.browserTracingIntegration(),
// enables Session Replay
Sentry.replayIntegration(),
// enables User Feedback
Sentry.feedbackIntegration({
// Additional integration configuration goes in here
colorScheme: "system",
}),
],
// Enables Tracing.
// Set to 1.0 to capture 100% of spans for tracing.
// We recommend reducing this value in production.
tracesSampleRate: 1.0,
// Set trace propagation targets for your API requests
tracePropagationTargets: [
"localhost",
/^https:\/\/yourserver\.io\/api/,
],
// Capture replays for 10% of all sessions,
// plus for 100% of sessions with an error
// Requires Sentry.replayIntegration()
replaysSessionSampleRate: 0.1,
replaysOnErrorSampleRate: 1.0,
});
};
</script>
<script
src="https://browser.sentry-cdn.com/11.10.0/bundle.tracing.replay.feedback.logs.metrics.min.js"
integrity="sha384-yEPSDc2odeKHBN1UBbG8IumntGfX4SKrLzNeeVilTcEI5v+y7szAjhJziANdaUOK"
crossorigin="anonymous"
></script>
<script>
Sentry.init({
dsn: "___PUBLIC_DSN___",
// Alternatively, use `process.env.npm_package_version` for a dynamic release version
// if your build tool supports it.
release: "my-project-name@2.3.12",
integrations: [
// enables automatic instrumentation
Sentry.browserTracingIntegration(),
// enables Session Replay
Sentry.replayIntegration(),
// enables User Feedback
Sentry.feedbackIntegration({
// Additional integration configuration goes in here
colorScheme: "system",
}),
],
// Enables Tracing.
// Set to 1.0 to capture 100% of spans for tracing.
// We recommend reducing this value in production.
tracesSampleRate: 1.0,
// Set trace propagation targets for your API requests
tracePropagationTargets: ["localhost", /^https:\/\/yourserver\.io\/api/],
// Capture replays for 10% of all sessions,
// plus for 100% of sessions with an error
// Requires Sentry.replayIntegration()
replaysSessionSampleRate: 0.1,
replaysOnErrorSampleRate: 1.0,
});
</script>
The stack traces in your Sentry errors probably won't look like your actual code without unminifying them. To fix this, upload your source maps to Sentry. The easiest way to do this is by using the Sentry Wizard.
Alternatively, take a look at our Uploading Source Maps documentation.
npx @sentry/wizard@latest -i sourcemaps
npx @sentry/wizard@latest -i sourcemaps
By default, the SDK sends user identity data (IP address, ID, and similar) and other data like HTTP bodies and URL query parameters. This will give you rich debugging context.
The SDK always filters sensitive values whose keys match a built-in denylist, such as auth or password, and sends [Filtered] instead.
To send less data, turn off the categories you don't need in the dataCollection option. For the full list of categories and their defaults, see the dataCollection options.
Sentry.init({
dsn: "___PUBLIC_DSN___",
dataCollection: {
userInfo: false,
// other categories
},
});
Sentry.init({
dsn: "___PUBLIC_DSN___",
dataCollection: {
userInfo: false,
// other categories
},
});
Use Sentry.logger to send logs at different levels, such as info, warn, or error. You can pass any attributes you want and search or filter by them later. See Set Up Logs for all available logging methods and the syntax for formatting messages.
Sentry.logger.info("User example action completed");
Sentry.logger.warn("Slow operation detected", {
operation: "data_fetch",
duration: 3500,
});
Sentry.logger.error("Validation failed", {
form_field: "email",
reason: "Invalid email",
});
Sentry.logger.info("User example action completed");
Sentry.logger.warn("Slow operation detected", {
operation: "data_fetch",
duration: 3500,
});
Sentry.logger.error("Validation failed", {
form_field: "email",
reason: "Invalid email",
});
If you're already logging with console or Consola, you can capture those logs with our console integrations.
Use Sentry.metrics to send counters, gauges, and distributions from your app to Sentry. You can pass any attributes you want and search or filter by them later. See Set Up Metrics for all available metric types and configuration options.
Sentry.metrics.count("checkout.failed", 1);
Sentry.metrics.gauge("time_since_refresh", 4, { unit: "hour" });
Sentry.metrics.distribution("api_latency", 187, {
unit: "millisecond",
attributes: { endpoint: "/api/orders" },
});
Sentry.metrics.count("checkout.failed", 1);
Sentry.metrics.gauge("time_since_refresh", 4, { unit: "hour" });
Sentry.metrics.distribution("api_latency", 187, {
unit: "millisecond",
attributes: { endpoint: "/api/orders" },
});
Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.
Add a test button to one of your pages. Open the page in a browser and click the button to trigger an error for Sentry to capture.
<script>
function triggerError() {
throw new Error("Sentry Test Error");
}
</script>
<button onclick="triggerError()">Break the World</button>
<script>
function triggerError() {
throw new Error("Sentry Test Error");
}
</script>
<button onclick="triggerError()">Break the World</button>
Important
Errors triggered from within your browser's developer tools (like the browser console) are sandboxed, so they will not trigger Sentry's error monitoring.
Now, head over to your project on Sentry.io to view the collected data (it takes a couple of moments for the data to appear).
At this point, you should have integrated Sentry into your JavaScript application. Here's what to explore next:
- Explore practical guides on what to monitor, log, track, and investigate after setup
- Extend Sentry to your backend using one of our SDKs
- Set up tunneling to avoid ad blockers from blocking Sentry events
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").