feat: sentry integration

[Kingcedru]

Describe your changes

Integrated Sentry for logging errors in production.

Issue ticket number and link

• Integrate Sentry For error monitoring In The backend #467

Checklist before requesting a review

• Sentry is setup and configured to the DREC backend account
• Sentry logs all the errors and warnings happening in the backend
• We log errors based on the environments production, stage and dev
• Sentry shouldn't be log errors happening in local development
• I have performed a self-review of my code
• No existing features have been broken without good reason.
• The code style guideline have been followed
• Documentation has been updated to reflect your changes.

Testing the implementation

• Create this endpoint

@Get('/test-sentry')
  @UseGuards(AuthGuard('jwt'), PermissionGuard)
  @Permission('Read')
  @ACLModules('READS_MANAGEMENT_CRUDL')
  async throwTestError(): Promise<boolean> {
    throw new HttpException(
      'Test Sentry Error',
      HttpStatus.INTERNAL_SERVER_ERROR,
    );
  }

Add this variables in the .env file

SENTRY_DSN="" //add the sentry url
NODE_ENV= 'production', 'staging', 'development', or 'local'

choose one either production, staging, local

[musayann]

shouldn't we call this sentry why instrument ?

[musayann]

We should separate the environment here with process.env.NODE_ENV.

process.env.NODE_ENV is primarily used to indicate if we are running in local or built (production) mode.

We should have an env Variable that we will assign to the environment property that will be called SENTRY_ENV

We should disable reporting if process.env.NODE_ENV is not equal to production