rsnext/examples/with-sentry
Shu Uesugi 5f041447bc
Remove Now CLI reference from examples (#10501)
* Find/Replace "Deploy it to the cloud..."

* Find/Replace "Deploy it to the cloud..." (no colon)

* Find/Replace "Deploy it to the cloud..." for firebase

* Convert remaining ones

* Storybook deployment

* Update with-stripe-typescript

* Update contributing.md

* Remove `now`

* Update examples/with-stripe-typescript/README.md

Co-Authored-By: Luis Alvarez D. <luis@zeit.co>
2020-02-12 17:14:57 -05:00
..
pages Improve linting rules to catch more errors (#9374) 2019-11-10 19:24:53 -08:00
utils Update with-sentry example to not use sentry-testkit (#9777) 2019-12-18 17:51:46 +01:00
next.config.js Improve linting rules to catch more errors (#9374) 2019-11-10 19:24:53 -08:00
package.json Update Sentry to v5 and add @sentry/integrations (#6873) 2019-04-03 12:32:36 +02:00
README.md Remove Now CLI reference from examples (#10501) 2020-02-12 17:14:57 -05:00
server.js Improve linting rules to catch more errors (#9374) 2019-11-10 19:24:53 -08:00

Sentry example

An example showing use of Sentry to catch & report errors on both client + server side.

How to use

Using create-next-app

Execute create-next-app with npm or Yarn to bootstrap the example:

npm init next-app --example with-sentry with-sentry-app
# or
yarn create next-app --example with-sentry with-sentry-app

Download manually

Download the example:

Install it and run:

npm

npm install
npm run dev

yarn

yarn
yarn dev

Deploy it to the cloud with ZEIT Now (Documentation).

Configuration

You will need a Sentry DSN for your project. You can get it from the Settings of your Project, in Client Keys (DSN), and copy the string labeled DSN (Public).

The Sentry DSN should then be added as an environment variable when running the dev, build, and start scripts in package.json:

{
  "scripts": {
    "dev": "SENTRY_DSN=<dsn> node server.js",
    "build": "SENTRY_DSN=<dsn> next build",
    "start": "SENTRY_DSN=<dsn> NODE_ENV=production node server.js"
  }
}

Note: Setting environment variables in a package.json is not secure, it is done here only for demo purposes. See the with-dotenv example for an example of how to set environment variables safely.