Source Maps

Sentry supports un-minifying JavaScript via Source Maps. This lets you view source code context obtained from stack traces in their original untransformed form, which is particularly useful for debugging minified code (e.g. UglifyJS), or transpiled code from a higher-level language (e.g. TypeScript, ES6).

Generating a Source Map

Most modern JavaScript transpilers support source maps. Below are instructions for some common tools.

Webpack

Webpack is a powerful build tool that resolves and bundles your JavaScript modules into files fit for running in the browser. It also supports many different “loaders” which can convert higher-level languages like TypeScript and ES6/ES2015 into browser-compatible JavaScript.

Webpack can be configured to output source maps by editing webpack.config.js.

module.exports = {
    // ... other config above ...
    target: 'node',
    devtool: 'source-map',
    entry: {
      "app": 'src/app.js'
    },
    output: {
      path: path.join(__dirname, 'dist'),
      filename: '[name].js'
    }
};

Making Source Maps Available to Sentry

Source maps for Node.js projects should be uploaded directly to Sentry.

Uploading Source Maps to Sentry

Sentry provides an abstraction called Releases which you can attach source artifacts to. The release API is intended to allow you to store source files (and sourcemaps) within Sentry.

It can be easily done with a help of the sentry-webpack-plugin, which internally uses our Sentry CLI.

  • Start by creating a new authentication token under [Account] > API.
  • Ensure you you have project:write selected under scopes.
  • Install @sentry/webpack-plugin using npm
  • Create .sentryclirc file with necessary config (see Sentry Webpack Plugin docs below)
  • Update your webpack.config.json
const SentryPlugin = require('@sentry/webpack-plugin');

module.exports = {
    // ... other config above ...
    plugins: [
      new SentryPlugin({
        release: process.env.RELEASE,
        include: './dist',
        ignore: ['node_modules', 'webpack.config.js'],
      })
    ]
};

You can take a look at Sentry Webpack Plugin documentation for more information on how to configure the plugin.

Additionally, you’ll need to configure the client to send the release:

Raven.config('your-dsn', {
    release: process.env.RELEASE
});

Note: You dont have to use RELEASE environment variables. You can provide them in any way you want.

Additional information can be found in the Releases API documentation.

Updating Raven configuration to support Source Maps

In order for Sentry to understand how to resolve errors sources, we need to modify the data we send. Because Source Maps support is still in experimental phase, this task is not integrated into the core library itself. To do that however, we can normalize all urls using dataCallback method:

var path = require('path');

Raven.config('your-dsn', {
    // the rest of configuration
    dataCallback: function (data) {
      var stacktrace = data.exception && data.exception[0].stacktrace;

      if (stacktrace && stacktrace.frames) {
        stacktrace.frames.forEach(function(frame) {
          if (frame.filename.startsWith('/')) {
            frame.filename = 'app:///' + path.basename(frame.filename);
          }
        });
      }

      if (data.culprit) {
        data.culprit = normalizeUrl(data.culprit);
      }

      return data;
    }
  }
).install();