Skip to content
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

docs: explain this library in large projects #667

Merged
merged 1 commit into from
Feb 23, 2024
Merged

docs: explain this library in large projects #667

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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ This is a [sentry](https://sentry.io/) module for [Nest](https://github.com/nest

This package is no longer based on deprecated raven module, but rather on new stable [@sentry/node](https://www.npmjs.com/package/@sentry/node) module.

#### Should i use this for large projects?

This is not a solution for all cases and large applications, just a quick starter that covers the common rest/graphql capturing (the basics).
You might want deeper integration with Sentry, which means you can still use this to cover the rest/graphql error capture, but you will have to use the rest of Sentry SDK to cover other cases.

For really large projects, you might have to take this library as an example of how to integrate sentry with NestJS, and write your custom integration instead.

## Installation

```bash
Expand Down
Loading