@sentry/browser

What is @sentry/browser?

The @sentry/browser package is a JavaScript SDK for Sentry, which is an error tracking service that helps developers monitor and fix crashes in real time. The SDK hooks into the global error handling mechanisms of the browser and captures unhandled exceptions and other errors, providing rich context and insights into the underlying issues.

What are @sentry/browser's main functionalities?

Error Tracking

This feature automatically captures JavaScript exceptions and sends them to Sentry for analysis and tracking. The code initializes Sentry with a DSN (Data Source Name) and sets up a global error handler to capture exceptions.

Sentry.init({ dsn: 'YOUR_DSN' });

window.onerror = function (errorMsg, url, lineNumber, column, errorObj) {
  Sentry.captureException(errorObj);
  return false;
}

Manual Error Reporting

This allows developers to manually report exceptions or errors to Sentry. The code block demonstrates how to catch an error in a try-catch block and manually send it to Sentry using the captureException method.

Sentry.init({ dsn: 'YOUR_DSN' });

try {
  // Code that might fail
} catch (error) {
  Sentry.captureException(error);
}

Performance Monitoring

This feature enables performance monitoring by capturing transactions and spans. The code initializes Sentry with a sample rate for transactions and demonstrates how to start and finish a transaction, which can be used to measure the performance of operations.

Sentry.init({ dsn: 'YOUR_DSN', tracesSampleRate: 1.0 });

const transaction = Sentry.startTransaction({ name: 'test transaction' });
// ... some code ...
transaction.finish();

Breadcrumbs

Breadcrumbs are a trail of events that happened prior to an issue. This feature allows you to record breadcrumbs manually. The code shows how to add a breadcrumb for an authentication event.

Sentry.init({ dsn: 'YOUR_DSN' });

Sentry.addBreadcrumb({
  category: 'auth',
  message: 'User authenticated',
  level: Sentry.Severity.Info
});

User Feedback

This feature allows you to collect user feedback when an error occurs. The code initializes Sentry and then shows a dialog to the user to collect feedback for a specific event.

Sentry.init({ dsn: 'YOUR_DSN' });

Sentry.showReportDialog({ eventId: 'event_id' });

Other packages similar to @sentry/browser

bugsnag-js

Bugsnag provides similar error tracking and monitoring capabilities as Sentry. It offers real-time error reporting and can be used to monitor application stability. Bugsnag also provides features for error diagnostics and supports multiple platforms.

raygun4js

Raygun is another error monitoring service that offers crash reporting with detailed diagnostics. It supports real-time error tracking and performance monitoring, and it can be used to identify and diagnose software errors and performance issues.

rollbar-browser

Rollbar offers real-time error tracking and is similar to Sentry in its capabilities. It includes features like telemetry, person tracking, and version tracking. Rollbar provides a comprehensive dashboard for monitoring and analyzing errors.

README

Sentry Browser SDK Package

General

This package is meant to be used with the Core SDK package.

Usage

First you have to create the core and use a corresponding SDK.

import * as Sentry from '@sentry/core';
import { SentryBrowser } from '@sentry/Sentrybrowser';

Sentry.create('__DSN__')
  .use(SentryBrowser)
  .install();

After that you can call function on the global sharedClient:

Sentry.getSharedClient().setTagsContext({ cordova: true });
Sentry.getSharedClient().captureMessage('test message');
Sentry.getSharedClient().captureBreadcrumb({ message: 'HOHOHOHO' });
Sentry.getSharedClient().captureException(new Error('error'));

If you don't want to use a global static instance of Sentry, you can create one on your own:

const client = await new Sentry.Client(dsn).use(MockAdapter).install()
client.setTagsContext({ cordova: true });
client.captureMessage('test message');
client.captureBreadcrumb({ message: 'HOHOHOHO' });

// OR

new Sentry.Client('__DSN__')
  .use(MockAdapter)
  .install()
  .then(client => {
    client.setTagsContext({ cordova: true });
    client.captureMessage('test message');
    client.captureBreadcrumb({ message: 'HOHOHOHO' });
  });

Notice, install() is a Promise but we internally wait until it is resolved, so it is save to call other function without waiting for it.