Solid

If you're seeing deprecation warnings in your code, please note that we're currently working on version 8 of the JavaScript SDKs. In v8, some methods and properties will be removed or renamed. Check out the Migration docs and learn how to update your code to be compatible with v8.

Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.

Install

Sentry captures data by using an SDK within your application’s runtime.

In order to get started using the Sentry JavaScript SDK, add the following code to the top of your application, before all other scripts:

<script
  src="https://js.sentry-cdn.com/examplePublicKey.min.js"
  crossorigin="anonymous"
></script>

The Loader Script allows you to configure some SDK features from the Sentry UI, without having to redeploy your application. The Loader Script documentation shows more information about how to use it.

Alternatively, you can also install the SDK via a package manager:

npm install --save @sentry/browser

If you're updating your Sentry SDK to the latest version, check out our migration guide to learn more about breaking changes.

If you are using our previous Browser Javascript SDK, you can access the legacy SDK documentation, until further notice.

Configure

Configuration should happen as early as possible in your application's lifecycle.

To use the SDK, initialize it in your Solid entry point before bootstrapping your app. (In a typical Solid project that's the render-client.js, or render-client.tsx.)

import {render} from 'solid-js/web';
import App from './app';
import * as Sentry from '@sentry/browser';
import {DEV} from 'solid-js';

// this will only initialize your Sentry client in production builds.
if (!DEV) {
  Sentry.init({
    dsn: '<Sentry DSN>',
    integrations: [
      Sentry.browserTracingIntegration(),
      Sentry.replayIntegration(),
    ],

    // Set tracesSampleRate to 1.0 to capture 100%
    // of transactions for performance monitoring.
    // We recommend adjusting this value in production
    tracesSampleRate: 1.0,

    // Set `tracePropagationTargets` to control for which URLs distributed tracing should be enabled
    tracePropagationTargets: ['localhost', /^https:\/\/yourserver\.io\/api/],

    // Capture Replay for 10% of all sessions,
    // plus 100% of sessions with an error
    replaysSessionSampleRate: 0.1,
    replaysOnErrorSampleRate: 1.0,
  });
}

const app = document.getElementById('app');

if (!app) throw new Error('No #app element found in the DOM.');

render(() => <App />, app);

Once you've done this, the SDK will automatically capture unhandled errors and promise rejections, and monitor performance in the client.

It's also possible to add Client-Side routing to your app with Solid-Router without changing any additional settings. As long as you use the default HTML History API to handle routing.

Once you've done this, the SDK will automatically capture unhandled errors and promise rejections, and monitor performance in the client. You can also manually capture errors.

Add Readable Stack Traces to Errors

Depending on how you've set up your project, the stack traces in your Sentry errors probably don't look like your actual code.

To fix this, upload your source maps to Sentry. The easiest way to do this is to use the Sentry Wizard:

npx @sentry/wizard@latest -i sourcemaps

The wizard will guide you through the following steps:

• Logging into Sentry and selecting a project
• Installing the necessary Sentry packages
• Configuring your build tool to generate and upload source maps
• Configuring your CI to upload source maps

For more information on source maps or for more options to upload them, head over to our Source Maps documentation.

Verify

This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.

<button
  type="button"
  onClick={() => {
    throw new Error('Sentry Frontend Error');
  }}
>
  Throw error
</button>;

This snippet adds a button that throws an error in any Solid component you choose. It's useful for testing. It's recommended to base wrap your app within an Error Boundary:

import {ErrorBoundary} from 'solid-js';
import Routes from './routes.tsx';
import ErrorFallbackComponent from './components/error-fallback';
import * as Sentry from '@sentry/browser';

export default function App() {
  const Routes = useRoutes(ROUTES);

  return (
    <ErrorBoundary
      fallback={error => {
        Sentry.captureException(error);
        return <ErrorFallbackComponent />;
      }}
    >
      <Routes />
    </ErrorBoundary>
  );
}

To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.