Set Up

Setting up your application to send Sentry releases data fully is a multi-step process, and is adaptable to your organization's needs.

If you're using one of our release automation options, it will automate steps 3.2 and 4 of this process. If you're managing your releases manually, then you should follow all of the steps below.

1. Configure Your SDK

With your SDK configured to provide a release identifer and enable session tracking, you can monitor both releases and release health. Check out the documentation for your specific platform to configure the SDK.

Release Health

Release health is supported for the following SDKs:

2. Upload Source Maps or Other Debug Files

In cases where your code is processed — bundled, minified, transpiled, compiled, or otherwise obfuscated by tools like Webpack, Terser, or the C++ compiler — source maps (or other debug files) are necessary for Sentry to display the source code in your stack traces in its original untransformed form. Setting up source maps is also necessary before suspect commits can be enabled. Check out our SDK documentation to find source map or other debug file set up instructions for your specific platform if it's not in the list below:

3. Enable Suspect Commits

Suspect Commits allow you to more easily pinpoint what changes may be responsible for a given issue. To set them up:

  1. Install a repository integration so Sentry can access your commit history. (You can also upload commit data manually through our API if you don't want to use an integration.)
  2. Configure your release management script to associate commits with each release. If you're using one of our release automation options, this will be done for you.

Learn more about the benefits of tracking commits in Suspect Commits.

4. Notify Sentry

If you're not using one of our release automation options, let Sentry know you’ve deployed your release by sending an additional request after creating a release:

Copied
sentry-cli releases --org ORGANIZATION_SLUG deploys VERSION new -e ENVIRONMENT

Typically, a release = a deployment, but if you have several environments in which you want to deploy a release, this step also allows you to create those deployments individually.

You can also use our API to create a deploy.

When you notify Sentry that you've deployed a release to a new environment, we can automatically send an email to Sentry users who have committed to the release being deployed.

If finalizing the release isn't already included as part of your release automation process, make sure to do that. For more information, check out our CLI documentation.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").