Skip to content
Official Sentry SDKs for Javascript
Branch: master
Clone or download
BYK and HazAT meta(changelog): Fix items incorrectly added to 5.4.1 (#2120)
Moves items that were incorrectly added under the 5.4.1 release instead of "Unreleased".
Latest commit 2f994a2 Jun 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update issue templates May 7, 2019
.vscode fix: Node 10 tests (#1827) Jan 10, 2019
packages fix(options): Fix description of `maxBreadcrumb` (#2118) Jun 13, 2019
scripts v5 migration docs (#1959) Mar 28, 2019
.craft.yml fix: Fix browser dist build (#1972) Apr 1, 2019
.editorconfig feat: Prepare mono repo, new SDKs (#1349) Jun 7, 2018
.gitignore feat: Tracing + Reduced Bundle Size + build updates (#2038) May 8, 2019
.prettierignore ref: Mangle more internal names (#2036) Apr 25, 2019
.prettierrc.json Change code style from 80 to 120 columns Jul 20, 2018
.travis.yml feat: Expose prio scope functions (#2092) May 31, 2019
.yarnrc feat: Prepare mono repo, new SDKs (#1349) Jun 7, 2018
CHANGELOG.md meta(changelog): Fix items incorrectly added to 5.4.1 (#2120) Jun 14, 2019
CONTRIBUTING.md meta: Fix links Aug 10, 2018
LICENSE Create LICENSE Aug 10, 2018
MIGRATION.md fix: Fix typo Apr 2, 2019
Makefile fix: Docs publish script May 31, 2019
README.md ref: Changelog and Readme Mar 20, 2019
codecov.yml meta: Disable codecov command Sep 25, 2018
dangerfile.ts feat: Tracing + Reduced Bundle Size + build updates (#2038) May 8, 2019
lerna.json release: 5.4.1 Jun 1, 2019
package.json fix: Force agent-base to be at version 4.3.0 to fix various issues (#… Jun 7, 2019
tsconfig.esm.json fix: Provide es5 build for esm (#1991) Apr 3, 2019
tsconfig.json fix: Remove angular types (#1986) Apr 2, 2019
typedoc.js feat: Expose prio scope functions (#2092) May 31, 2019
yarn.lock fix: Force agent-base to be at version 4.3.0 to fix various issues (#… Jun 7, 2019

README.md


Build Status codecov npm version typedoc

Official Sentry SDKs for JavaScript

This is 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.

Links

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/hub: Global state management of SDKs
  • @sentry/minimal: 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/integrations: Pluggable integrations that can be used to enhance JS SDKs
  • @sentry/electron: SDK for Electron with support for native crashes
  • sentry-cordova: SDK for Cordova Apps and Ionic with support for native crashes
  • raven-js: Our old stable JavaScript SDK, we still support and release bug fixes for the SDK but all new features will be implemented in @sentry/browser which is the successor.
  • raven: Our old stable Node SDK, same as for raven-js we still support and release bug fixes for the SDK but all new features will be implemented in @sentry/node which is the successor.

Installation and Usage

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

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

Setup and usage of these SDKs always follows the same principle.

import { init, captureMessage } from '@sentry/browser';

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/opentracing: OpenTracing compatible integration that can be used as a pluggable integration for the SDKs.
  • @sentry/typescript: Shared Typescript compiler and linter options.
  • @sentry/types: Types used in all packages.
You can’t perform that action at this time.