search

getsentry / sentry-toolbar

MIT License
5 stars 0 forks source link
tag-production

readme

@sentry/toolbar

Development

Setup

Development

Get the code and setup your env:

Quickstart

If you have your own app and you want to install the toolbar into it follow these steps:

  1. Create a .env.local file, based on .env.example.
  2. Run pnpm dev - Builds the library and starts a local webserver to serve it.
  3. Add <script src="http://localhost:8080/toolbar.min.js"> to your app.
  4. Configure the SDK in your app with <script>window.SentryToolbar.init({...})</script>.

Be aware that the usual hot-reload of your app will not apply to the toolbar library. Type CTRL+R or CMD+R to reload your app and pull down new toolbar code.

If you want to use the bundled sample app, follow these steps:

  1. Remove/replace your .env.local file with .env.example.
    • The default .env values are configured to work with the standalone dev server.
  2. Run pnpm dev - Builds the library and starts a local webserver to serve it.
  3. Edit src/env/demo/App.tsx to configure the toolbar for your Sentry organization.
  4. Run pnpm dev:standalone - Run the sample app.
  5. Visit http://localhost:5173/ in your browser.

Note that pnpm dev is a convenience for running pnpm dev:watch & pnpm dev:server in parallel.

The local webserver does double-duty, serving the library code (acting as a CDN) and also a mock Sentry instance. Visit http://localhost:8080/logout/ to "log out" of the mock Sentry instance.

Storybook

A storybook is available by running: pnpm start:docs and is published to https://getsentry.github.io/sentry-toolbar.

Publishing

To publish a new version of the toolbar follow the usual steps for craft:

  1. Run the Release github action and put in the version number you'd like to release.
    • To see the previous releases just look at the previous runs of that action.
  2. Check #proj-release-approval in slack, or visit https://github.com/getsentry/publish/issues to find the issue for this release.
  3. Get the 'approved' label added to the issue.
  4. Check that the release actions completed successfully.
    • The issue links to a workflow that should have completed successfully
    • You should see a merge of the release branch into main.

Production

In production you need to do two things to get the toolbar working:

  1. Add or dynamically inject <script src="https://browser.sentry-cdn.com/sentry-toolbar/latest/toolbar.min.js"> into your app
  2. Call window.SentryToolbar.init(initProps) to setup a toolbar instance.
<script src="https://browser.sentry-cdn.com/sentry-toolbar/latest/toolbar.min.js"></script>
<script>
  window.SentryToolbar.init({ ...});
</script>

Deploy targets

It's strongly recommended to think about what environments is your app deployed to, and of those which should have the toolbar available.

In dev and staging environments, it's possible to unconditionally include the toolbar so all developers and testers can use the toolbar and link from the page they're looking at back to sentry.

In production it's strongly recommended to conditionally inlude the toolbar <script> tag so that only developers of your app, or members of your sentry organization can see it. The specific code for this is something you'll need to write based on how your app works.

For example, if work at a company called Joshy's Pizza and need to be logged into the website to place an order. I add a condition like this to a) show the toolbar at all times during development b) show the toolbar only if a pizza employee is logged in to the production environment

The code might look like this:

// example conditions to render the toolbar in different environments.

const env = process.env.SENTRY_ENVIRONMENT || 'development';
const isEmployeeEmail = user.email.endsWith('@joshys-pizza.com')

const isDev = env === 'development';
const isEmployeeInProd = env === 'production' && isEmployee;
if (isDev || isEmployeeInProd) {
  SentryToolbar.init({ ... });
}

If the toolbar <script> is accidentally included on your site, and SentryToolbar.init() is called, then a "Login to Sentry" button will be visible to the public. This is not ideal, but your data in sentry will still be safe as users not inside your sentry organization will not be able to authenticate themselves.

Conditionally inserting script tag

It's possible to dynamically insert the script tag inside an SPA app, prior to calling SentryToolbar.init(), so that only users who are elegible . See docs/conditional-script.md for example code. This will help reduce network traffic for your users because they do not have the credentials needed to login

This example code will be eventually implemented as an NPM package, but for now it's something to be done manually.