Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DSI-HUG/ngx-sentry
📊 Angular wrapper for Sentry JavaScript SDK
https://github.com/DSI-HUG/ngx-sentry
angular crash-reporting crash-reports csp-report error-handling error-logging error-monitoring http-errors http-interceptor monitor monitoring ngx-sentry sentry sentry-client
Last synced: 2 months ago
JSON representation
📊 Angular wrapper for Sentry JavaScript SDK
- Host: GitHub
- URL: https://github.com/DSI-HUG/ngx-sentry
- Owner: DSI-HUG
- License: gpl-3.0
- Created: 2021-01-26T10:48:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T18:40:08.000Z (3 months ago)
- Last Synced: 2024-09-09T23:04:53.889Z (3 months ago)
- Topics: angular, crash-reporting, crash-reports, csp-report, error-handling, error-logging, error-monitoring, http-errors, http-interceptor, monitor, monitoring, ngx-sentry, sentry, sentry-client
- Language: TypeScript
- Homepage:
- Size: 3.05 MB
- Stars: 3
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-angular - ngx-sentry - Angular wrapper for [Sentry JavaScript SDK](https://github.com/getsentry/sentry-javascript). (Table of contents / Angular)
- fucking-awesome-angular - ngx-sentry - Angular wrapper for <b><code> 8026⭐</code></b> <b><code> 1590🍴</code></b> [Sentry JavaScript SDK](https://github.com/getsentry/sentry-javascript)). (Table of contents / Angular)
README
@hug/ngx-sentry
Angular wrapper for the official Sentry JavaScript SDK
## Getting started
To set up or update an Angular project with this library use the Angular CLI's [schematic][schematics] commands:
#### Installation
```sh
ng add @hug/ngx-sentry
```
More details
>
>
> The `ng add` command will ask you the following questions:
>
> 1. **Name of the project in Sentry**: *the name used when creating the Sentry project*
> 2. **Data Source Name (DSN) url**: *the url provided during the Sentry project creation process*
>
> And will also perform the following actions:
>
> - Create a `.sentryclirc` file containing all the Sentry configurations
> - Initialize and configure Sentry in `main.ts`
> - Add `resolveJsonModule` and `allowSyntheticDefaultImports` to `tsconfig.json`
> - Import the `NgxSentryModule` in your Angular application module (if app is not standalone)
#### Update
```sh
ng update @hug/ngx-sentry
```
## Usage
Follow these steps to integrate your project's source maps with Sentry:
1. Generate Source Maps
```sh
ng build --source-map
```
2. Provide Source Maps to Sentry
```sh
npx ngx-sentry ./project-dist-path
```
## Options
This library is a wrapper around the official [Sentry JavaScript SDK][sentry-sdk-url] 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.
#### Sentry Browser's SDK
The Sentry Browser's SDK can be configured in `main.ts`:
```ts
initSentry(options: BrowserOptions);
```
#### Error handler
The behavior of the error handler can be configured either in:
* `main.ts` *(if the app is a standalone Angular application)*
```ts
bootstrapApplication(AppComponent, {
providers: [
provideSentry(options?: ErrorHandlerOptions)
]
});
```
* `app.module.ts` *(if the app is **not** a standalone Angular application)*
```ts
@NgModule({
imports: [
NgxSentryModule.forRoot(options?: ErrorHandlerOptions)
]
})
export class AppModule { }
```
#### Current user
You can define the current user via the `setSentryUser()` api:
```ts
// import { setSentryUser } from '@hug/ngx-sentry/standalone';
// import { setSentryUser } from '@hug/ngx-sentry';
public ngOnInit(): void {
// Set the current user
setSentryUser({
email: '[email protected]',
username: 'rtrm',
attr1: 'attr1'
});
// Remove the current user
setSentryUser(null);
}
```
## Development
See the [developer docs][developer].
## Contributing
#### > Want to Help?
Want to file a bug, contribute some code or improve documentation? Excellent!
But please read up first on the guidelines for [contributing][contributing], and learn about submission process, coding rules and more.
#### > Code of Conduct
Please read and follow the [Code of Conduct][codeofconduct], and help us keep this project open and inclusive.
## Credits
Copyright (C) 2021 [HUG - Hôpitaux Universitaires Genève][dsi-hug]
[][dsi-hug]
[schematics]: https://angular.io/guide/schematics-for-libraries
[sentry-sdk-url]: https://github.com/getsentry/sentry-javascript
[developer]: https://github.com/dsi-hug/ngx-sentry/blob/main/DEVELOPER.md
[contributing]: https://github.com/dsi-hug/ngx-sentry/blob/main/CONTRIBUTING.md
[codeofconduct]: https://github.com/dsi-hug/ngx-sentry/blob/main/CODE_OF_CONDUCT.md
[dsi-hug]: https://github.com/dsi-hug