Skip to content

tvanier/sentry-javascript

 
 

Repository files navigation


Official Sentry SDKs for JavaScript (Preview)

This is a preview of the next line of Sentry JavaScript SDKs, comprised in the @sentry/ namespace. It will provide a more convenient interface and improved consistency between various JavaScript environments.

WARNING: All of these SDKs are still undergoing active development, so the public interface might change and break backwards compatibility from time to time. We absolutely recommend raven-js and raven for production use.

Contents

Supported Platforms

For each major JavaScript platform, there is a specific high-level SDK that provides all the tools you need in a single package. Please refer to the README and instructions of those SDKs for more detailed information:

  • @sentry/shim: Minimal SDK for library authors to add Sentry support
  • @sentry/browser: SDK for Browsers, including integrations for React, Angular, Ember, Vue and Backbone
  • @sentry/node: SDK for Node, including integrations for Express, Koa, Loopback, Sails and Connect
  • @sentry/electron: SDK for Electron with support for native crashes
  • sentry-cordova: SDK for Cordova Apps and Ionic with support for native crashes

NOTE: Are you missing an SDK here? It has probably not been integrated into the next line yet.

Installation and Usage

To install an SDK, simply add the high-level package, for example:

npm install --save @sentry/node
yarn add @sentry/node

Setup and usage of these SDKs always follows the same principle. In Node, for example (on another platform simply substitute the import):

const { init, captureMessage } = require('@sentry/node');

init({
  dsn: '__DSN__',
  // ...
});

captureMessage('Hello, world!');

Other Packages

Besides the high-level SDKs, this repository contains shared packages, helpers and configuration used for SDK development. If you're thinking about contributing to or creating a JavaScript-based SDK, have a look at the resources below:

  • @sentry/core: The base for all JavaScript SDKs with interfaces, type definitions and base classes.
  • @sentry/utils: A set of helpers and utility functions useful for various SDKs.
  • @sentry/typescript: Shared Typescript compiler and linter options.

Join the Discussion

Join the discussion in our tracking issue and let us know what you think of the updated interface and new possibilities.

About

Official Sentry SDKs for Javascript

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 67.8%
  • TypeScript 31.0%
  • Other 1.2%