Introduce Sentry SDK to your Frontend Code

In this tutorial, you import the React demo code into your local development environment, add the Sentry SDK, and initialize it.

  • Follow the instructions on Getting Started for your platform. Notice that you can select the desired platform.
  • Continue with the Next section.

Prerequisites

The demo app source code requires a NodeJS development environment to install and run the application. Make sure that you have the following in place:

Step 1: Get the code

  1. Open the frontend-monitoring sample code repository on GitHub

  2. Click on Fork and select the target GitHub account you wish this repository to be forked in to

    Fork Repository

  3. Once the fork is complete, click on Clone or download, and copy the repository HTTPS URL

    Clone Repository

  4. Clone the forked repository to your local environment

    Copied
    > git clone <repository HTTPS url>
  5. Now that the sample code is available locally open the frontend-monitoring project in your preferred code editor

Step 2: Install the SDK

Sentry captures data by using a platform-specific SDK within your application runtime. To use the SDK, import and configure it in your source code. The demo project uses React and Browser JS. The quickest way to get started is by using the CDN hosted version of the JavaScript browser SDK, however, you can NPM install the browser SDK as well.

  1. Open the index.html file (located under ./frontend-monitoring/public/)

    Import and Configure SDK

    Notice that we import and initialize the SDK as early as possible in our code. When initializing the SDK, we provide the desired configuration. The only mandatory configuration option is the DSN key, however, the SDK supports multiple other configuration options. For more information see Configuration.

  2. In the Sentry SDK configuration, enter the DSN key value you copied from the project created in the previous section.

    Copied
    Sentry.init({
      dsn: "<PASTE YOUR DSN KEY HERE>",
    });

Step 3: Install & run the demo app

To build and run the Demo application on your localhost:

  1. Open a shell terminal and change directory to the frontend-monitoring project folder

  2. Use the .nvmrc file to set the Node version compatible with this project. Run:

    Copied
    > nvm use
  3. Install project dependencies by running:

    Copied
    > npm install
  4. Build, deploy, and run the project on your localhost by running:

    Copied
    > npm run deploy

    Deploy & Serve

    Once the deploy finishes successfully, you'll see the confirmation in your terminal.

Next

Capture your First Error

You can edit this page on GitHub.