Sentry for Ember
Learn how to set up Sentry in your Ember application and capture your first events.
You need:
Run the command for your preferred package manager to add the Sentry SDK to your application:
ember install @sentry/ember
ember install @sentry/ember
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.
Call Sentry.init() in app/app.ts before defining your Application class.
The snippet also turns on:
- Tracing: via
tracesSampleRateplus the instance initializer in the next step - Session Replay: via
replayIntegration(), sampled withreplaysSessionSampleRateandreplaysOnErrorSampleRate - User Feedback: via
feedbackIntegration()
Don't need a feature? Remove its integration and options from the snippet.
app/app.tsimport Application from "@ember/application";
import Resolver from "ember-resolver";
import loadInitializers from "ember-load-initializers";
import config from "./config/environment";
import * as Sentry from "@sentry/ember";
Sentry.init({
dsn: "___PUBLIC_DSN___",
integrations: [
// 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,
// Capture replays for 10% of all sessions,
// plus for 100% of sessions with an error
// Requires Sentry.replayIntegration()
replaysSessionSampleRate: 0.1,
replaysOnErrorSampleRate: 1.0,
});
export default class App extends Application {
modulePrefix = config.modulePrefix;
podModulePrefix = config.podModulePrefix;
Resolver = Resolver;
}
loadInitializers(App, config.modulePrefix);
import Application from "@ember/application";
import Resolver from "ember-resolver";
import loadInitializers from "ember-load-initializers";
import config from "./config/environment";
import * as Sentry from "@sentry/ember";
Sentry.init({
dsn: "___PUBLIC_DSN___",
integrations: [
// 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,
// Capture replays for 10% of all sessions,
// plus for 100% of sessions with an error
// Requires Sentry.replayIntegration()
replaysSessionSampleRate: 0.1,
replaysOnErrorSampleRate: 1.0,
});
export default class App extends Application {
modulePrefix = config.modulePrefix;
podModulePrefix = config.podModulePrefix;
Resolver = Resolver;
}
loadInitializers(App, config.modulePrefix);
To capture page loads, navigation, classic component renders, and runloop timings, create an instance initializer that calls instrumentAppInstancePerformance(). The tracesSampleRate option in Sentry.init() controls how much tracing data Sentry captures.
The SDK skips this instrumentation during FastBoot server rendering. To customize it, see Ember Options.
app/instance-initializers/sentry-performance.tsimport type ApplicationInstance from "@ember/application/instance";
import { instrumentAppInstancePerformance } from "@sentry/ember";
export function initialize(appInstance: ApplicationInstance): void {
instrumentAppInstancePerformance(appInstance);
}
export default { initialize };
import type ApplicationInstance from "@ember/application/instance";
import { instrumentAppInstancePerformance } from "@sentry/ember";
export function initialize(appInstance: ApplicationInstance): void {
instrumentAppInstancePerformance(appInstance);
}
export default { initialize };
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 the following test button to one of your templates, which will trigger an error when you click it:
application.hbs
<button type="button" >
Test Sentry Error
</button>
<button type="button" >
Test Sentry Error
</button>
Next, add the corresponding action to your controller or component.
application.jsimport Controller from "@ember/controller";
import { action } from "@ember/object";
export default class ApplicationController extends Controller {
@action
throwTestError() {
throw new Error("Sentry Test Error");
}
}
import Controller from "@ember/controller";
import { action } from "@ember/object";
export default class ApplicationController extends Controller {
@action
throwTestError() {
throw new Error("Sentry Test Error");
}
}
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 Ember application. Here's what to explore next:
- Explore practical guides on what to monitor, log, track, and investigate after setup
- 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").