Skip to content

docs(ember): Point README to SDK documentation #24628

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicohrubec merged 1 commit into from
Sep 23, 2026
+7 −152
Merged

docs(ember): Point README to SDK documentation #24628

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 7 additions & 152 deletions packages/ember/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,159 +10,14 @@
[![npm dm](https://img.shields.io/npm/dm/@sentry/ember.svg)](https://www.npmjs.com/package/@sentry/ember)
[![npm dt](https://img.shields.io/npm/dt/@sentry/ember.svg)](https://www.npmjs.com/package/@sentry/ember)

This SDK is a v2 Ember addon that provides error tracking and performance monitoring for Ember.js applications.
The official Sentry SDK for monitoring Ember.js applications.

## Requirements
## Documentation

- Ember.js 4.0+
- Node.js 20.19.0+
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/ember/)
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/ember/configuration/)

## Installation
## Support

```bash
npm install @sentry/ember
# or
yarn add @sentry/ember
# or
pnpm add @sentry/ember
```

## Basic Setup

Initialize Sentry early in your application, typically in `app/app.ts` or `app/app.js`:

```typescript
import Application from '@ember/application';
import Resolver from 'ember-resolver';
import loadInitializers from 'ember-load-initializers';
import config from 'my-app/config/environment';
import * as Sentry from '@sentry/ember';

// Initialize Sentry before the application
Sentry.init({
dsn: '__YOUR_DSN__',
// Set tracesSampleRate to 1.0 to capture 100% of transactions for tracing.
// We recommend adjusting this value in production
tracesSampleRate: 1.0,
});

export default class App extends Application {
modulePrefix = config.modulePrefix;
podModulePrefix = config.podModulePrefix;
Resolver = Resolver;
}

loadInitializers(App, config.modulePrefix);
```

## Performance Monitoring

For automatic performance instrumentation (page loads, navigation, runloop, components), create an instance-initializer:

```typescript
// app/instance-initializers/sentry-performance.ts
import type ApplicationInstance from '@ember/application/instance';
import { instrumentAppInstancePerformance } from '@sentry/ember';

export function initialize(appInstance: ApplicationInstance): void {
instrumentAppInstancePerformance(appInstance, optionalOptions);
}

export default {
initialize,
};
```

### Performance Options

| Option | Type | Default | Description |
| -------------------------------- | --------------------- | ---------- | ----------------------------------------- |
| `appInstance` | `ApplicationInstance` | _required_ | The Ember application instance |
| `disableRunloopPerformance` | `boolean` | `false` | Disable runloop queue tracking |
| `disableInstrumentComponents` | `boolean` | `false` | Disable component render tracking |
| `enableComponentDefinitions` | `boolean` | `false` | Enable component definition tracking |
| `minimumRunloopQueueDuration` | `number` | `5` | Minimum duration (ms) for runloop spans |
| `minimumComponentRenderDuration` | `number` | `2` | Minimum duration (ms) for component spans |
| `instrumentPageLoad` | `boolean` | `true` | Instrument page load spans |
| `instrumentNavigation` | `boolean` | `true` | Instrument navigation spans |
| `idleTimeout` | `number` | `1000` | Idle timeout (ms) for tracing |

### Route Performance Instrumentation

To instrument individual routes with detailed lifecycle tracking, use the `instrumentRoutePerformance` decorator:

```typescript
// app/routes/application.ts
import Route from '@ember/routing/route';
import { instrumentRoutePerformance } from '@sentry/ember';

class ApplicationRoute extends Route {
async model() {
return this.store.findAll('post');
}
}

export default instrumentRoutePerformance(ApplicationRoute);
```

This wraps the route's `beforeModel`, `model`, `afterModel`, and `setupController` hooks with Sentry spans.

## API

This package re-exports everything from `@sentry/browser`, so you have access to the full Sentry Browser SDK API:

```typescript
import * as Sentry from '@sentry/ember';

// Capture an error
Sentry.captureException(new Error('Something went wrong'));

// Capture a message
Sentry.captureMessage('Something happened');

// Set user context
Sentry.setUser({ id: '123', email: 'user@example.com' });

// Add breadcrumb
Sentry.addBreadcrumb({
category: 'ui.click',
message: 'User clicked button',
level: 'info',
});

// Create a span
Sentry.startSpan({ name: 'my-operation', op: 'task' }, () => {
// ... do work
});
```

## Migration from v1 Addon

If you're upgrading from an older version of `@sentry/ember` (v1 addon format), here are the key changes:

### What Changed

1. **No automatic instance initializer**: You must now explicitly set up performance instrumentation by creating an instance-initializer that calls `instrumentAppInstancePerformance(appInstance)`.

2. **No `contentFor` hooks**: The addon no longer injects scripts via `contentFor`.

3. **No environment config via `ENV['@sentry/ember']`**: Configure Sentry directly via `Sentry.init()` in your app.ts.

4. **Simpler dependency tree**: The v2 addon format has fewer dependencies and works better with modern build tools like Vite and Embroider.

### Migration Steps

1. Update your `app/app.ts` to call `Sentry.init()` directly with your configuration.

2. Create `app/instance-initializers/sentry-performance.ts` to set up performance monitoring using `instrumentAppInstancePerformance`.

3. Remove any `@sentry/ember` configuration from `config/environment.js`.

## Links

- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/ember/)
- [TypeDoc](http://getsentry.github.io/sentry-javascript/)

## License

MIT
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)
Loading