@pascaliske/ngx-sentry NPM

`@pascaliske/ngx-sentry`

This library provides an ErrorHandler and a HttpInterceptor for connecting an Angular application with Sentry service.

Requirements

To use this library you need to install the @sentry/browser library into your project

$ yarn add @sentry/browser

Installation

To install the library itself use the following command:

$ yarn add @pascaliske/ngx-sentry

Usage

Import the SentryModule with the forRoot() method in your applications main module. The forRoot() method expects an options object with at least the following two keys: enabled, sentry. More options can be found in the options section.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SentryModule } from '@pascaliske/ngx-sentry'
import { AppComponent } from './app.component'

@NgModule({
    imports: [
        BrowserModule,
        SentryModule.forRoot({
            enabled: true,
            sentry: {
                dsn: 'https://your-sentry-dsn@sentry.io',
            },
        }),
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent],
})
export class AppModule {}

Pro tip: You can reduce your bundle size by using Sentry's ESM build. It can be enabled by aliasing it with webpack:
config.resolve.alias['@sentry/browser'] = '@sentry/browser/esm'

`SentryService`

You can use the SentryService injectable to manually capture errors or events as follows:

@Component({
    // [...]
})
export class AppComponent {
    public constructor(private sentryService: SentryService) {}

    public ngOnInit(): void {
        // capture single error
        this.sentryService.captureException(new Error(''))

        // capture single error with additional context information
        this.sentryService.withScope(scope => {
            scope.setExtra('currentPage', window.location.href)
            this.sentryService.captureException(new Error(''))
        })
    }
}

Note: The SentryService inherits all methods directly from the Sentry library. For more information about their APIs you can visit their documentation.