feat: implement crash reporter #365
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // initialize Sentry | ||
| Sentry.init({ | ||
| dsn: SENTRY_DSN, | ||
| integrations: [Sentry.electronMinidumpIntegration()], |
There was a problem hiding this comment.
ElectronMinidump will enable integration with crashReporter. This is only configured in Prod mode to reduce noise.
| const def = { | ||
| [VITE_DEV_SERVER_URL]: | ||
| command === 'serve' | ||
| ? JSON.stringify(process.env[VITE_DEV_SERVER_URL]) | ||
| : undefined, | ||
| [VITE_NAME]: JSON.stringify(name), | ||
| [SENTRY_DSN]: JSON.stringify(process.env.SENTRY_DSN), |
There was a problem hiding this comment.
We need the Sentry DSN variable to be statically replaced during build time since env variables are not available during runtime in Prod.
Comment on lines
+30
to
+34
| sentryVitePlugin({ | ||
| authToken: process.env.SENTRY_AUTH_TOKEN, | ||
| org: process.env.SENTRY_ORG, | ||
| project: process.env.SENTRY_PROJECT, | ||
| }), |
There was a problem hiding this comment.
This plugin uploads the source map to Sentry to help us identify the actual stack trace of an issue
cristianoventura
requested review from
going-confetti,
e-fisher and
Llandy3d
and removed request for
a team
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR integrates Sentry so we can collect information about crashes and other errors in the main process for production builds.
How to Test
This integration only works in production. You can either:
main.tslocally to work in development environment and manually throw an error. Source maps will not be available in Sentry unless you configureSENTRY_AUTH_TOKEN,SENTRY_PROJECTandSENTRY_ORGenv vars locallyChecklist
npm run lint) and all checks pass.npm test) and all tests pass.Screenshots (if appropriate):
Related PR(s)/Issue(s)
Resolves #349