@bugsnag/core

What is @bugsnag/core?

@bugsnag/core is a core library for the Bugsnag error monitoring service. It provides the essential functionality for capturing and reporting errors in your applications. This package is typically used as a dependency for other Bugsnag notifier packages that are specific to different platforms (e.g., JavaScript, React Native, etc.).

What are @bugsnag/core's main functionalities?

Initializing Bugsnag

This code initializes the Bugsnag client with your API key, allowing you to start capturing and reporting errors.

const Bugsnag = require('@bugsnag/core');
const bugsnagClient = Bugsnag.createClient({ apiKey: 'YOUR_API_KEY' });

Notifying Errors

This code sends a notification to Bugsnag about an error. This is useful for capturing and reporting errors that occur in your application.

bugsnagClient.notify(new Error('Test error'));

Adding Metadata

This code adds custom metadata to the error report, which can be useful for providing additional context about the error.

bugsnagClient.notify(new Error('Test error'), event => {
  event.addMetadata('account', {
    id: 123,
    name: 'Acme Co'
  });
});

Breadcrumbs

This code leaves a breadcrumb, which is a log of actions that happened before an error occurred. Breadcrumbs help in understanding the sequence of events leading up to an error.

bugsnagClient.leaveBreadcrumb('User clicked button', { buttonName: 'Submit' });

Other packages similar to @bugsnag/core

sentry

Sentry is another popular error tracking and monitoring service. It provides similar functionalities to Bugsnag, such as capturing and reporting errors, adding metadata, and breadcrumbs. Sentry also offers additional features like performance monitoring and release tracking.

rollbar

Rollbar is an error monitoring service that provides real-time error tracking and debugging tools. It offers similar functionalities to Bugsnag, including error notification, metadata addition, and breadcrumbs. Rollbar also provides features like deployment tracking and error grouping.

airbrake

Airbrake is an error monitoring service that helps you track and fix errors in your applications. It offers similar functionalities to Bugsnag, such as error notification, metadata addition, and breadcrumbs. Airbrake also provides features like performance monitoring and error grouping.

README

@bugsnag/core

This package contains the core classes and utilities common to the Bugsnag notifier for any JS-based platform:

• Client class
• Event class
• Breadcrumb class
• Session class
• config scheme and utils
• Basic JS polyfills that don't pollute the global scope (for support back to IE8)
• and a couple of other small utilities

Unless you are writing your own notifier, it is unlikely that you want to install this module – for the universal error reporting client, see @bugsnag/js.

License

This package is free software released under the MIT License. See LICENSE.txt for details.

Changelog

[8.0.0] - 2024-08-29

Summary

As well as some bug fixes and breaking changes described in the Upgrade Guide, this major SDK release has the following key features:

• Improved API for NodeJS: the Bugsnag client can now be used to call SDK methods in the context of the current request
• Breadcrumb support for NodeJS: we now support manual breadcrumbs and capture console breadcrumbs automatically
• Improved session reporting for single page apps: a session is now created only once per page load to more accurately reflect a user's session in your app

Added

• (node) Add support for manual breadcrumbs #1927 and automatic console breadcrumbs #2107
• Support error correlation properties in event payloads #2174

Fixed

• (plugin-angular) Prevent excess change detection cycles when calling Bugsnag.notify #1861

Changed

• (node) Enable breadcrumbs and context-scoped calls #1927
• (plugin-contextualize) Reimplement without relying on the deprecated node Domain API. From Node 16+ unhandled promise rejections are also supported #1924
• (plugin-navigation-breadcrumbs) Calling pushState or replaceState no longer triggers a new session when autoTrackSessions is enabled #1820
• (plugin-network-breadcrumbs, plugin-electron-net-breadcrumbs) Breaking change: The request metadata field in network breadcrumbs has been renamed to url and is no longer pre-pended with the HTTP method #1988
• (plugin-network-breadcrumbs, plugin-electron-net-breadcrumbs) Add method metadata field to network breadcrumbs #1988
• (plugin-network-breadcrumbs, plugin-electron-net-breadcrumbs) Add duration metadata field to network breadcrumbs #1903
• (react-native) Update bugsnag-android from v5.32.2 to v6.6.1