Angular wrapper for the official Sentry JavaScript SDK

To set up or update an Angular project with this library use the Angular CLI's schematic commands:

ng add @hug/ngx-sentry

ng update @hug/ngx-sentry

Follow these steps to integrate your project's source maps with Sentry:

1. Generate Source Maps

   ng build --source-map

2. Provide Source Maps to Sentry

   npx ngx-sentry ./project-dist-path

This library is a wrapper around the official Sentry JavaScript SDK with extra functionalities and configurations.

All options available in @sentry/browser can be configured from @hug/ngx-sentry.

You shouldn't have to configure anything else but in case you wanted to, you can still do it.

The Sentry Browser's SDK can be configured in main.ts:

initSentry(options: BrowserOptions);

The behavior of the error handler can be configured either in:

• main.ts (if the app is a standalone Angular application)

  bootstrapApplication(AppComponent, {
    providers: [
      provideSentry(options?: ErrorHandlerOptions)
    ]
  });

• app.module.ts (if the app is not a standalone Angular application)

  @NgModule({
    imports: [
      NgxSentryModule.forRoot(options?: ErrorHandlerOptions)
    ]
  })
  export class AppModule { }

You can define the current user via the setSentryUser() api:

// import { setSentryUser } from '@hug/ngx-sentry/standalone';
// import { setSentryUser } from '@hug/ngx-sentry';

public ngOnInit(): void {
  // Set the current user
  setSentryUser({
    email: 'rtrm@hcuge.ch',
    username: 'rtrm',
    attr1: 'attr1'
  });

  // Remove the current user
  setSentryUser(null);
}

See the developer docs.

Want to file a bug, contribute some code or improve documentation? Excellent!

But please read up first on the guidelines for contributing, and learn about submission process, coding rules and more.

Please read and follow the Code of Conduct, and help us keep this project open and inclusive.

Copyright (C) 2021 HUG - Hôpitaux Universitaires Genève