agicto / nextjs-sentry

nextjs-sentry

Sentry example

How to use

Using create-next-app

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

npx create-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 now (download)

now

About example

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

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.