Releases & Health

Learn how to configure your SDK to tell Sentry about your releases.

A release is a version of your code that is deployed to an environment. When you give Sentry information about your releases, you can:

  • Determine issues and regressions introduced in a new release
  • Predict which commit caused an issue and who is likely responsible
  • Resolve issues by including the issue number in your commit message
  • Receive email notifications when your code gets deployed

Additionally, releases are used for applying source maps to minified JavaScript to view original, untransformed source code.

Include a release ID (often called a "version") when you initialize the SDK.

The release name cannot:

  • contain newlines, tabulator characters, forward slashes(/) or back slashes(\)
  • be (in their entirety) period (.), double period (..), or space ( )
  • exceed 200 characters

The value can be arbitrary, but we recommend either of these naming strategies:

  • Semantic Versioning: package@version or package@version+build (for example,
    • package is the unique identifier of the project/app (CFBundleIdentifier on iOS, packageName on Android)
    • version is the semver-like structure <major>.<minor?>.<patch?>.<revision?>-<prerelease?> (CFBundleShortVersionString on iOS, versionName on Android)
    • build is the number that identifies an iteration of your app (CFBundleVersion on iOS, versionCode on Android)
  • Commit SHA: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, da39a3ee5e6b4b0d3255bfef95601890afd80709). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our Sentry CLI documentation.

Releases are global per organization; prefix them with something project-specific for easy differentiation.

The behavior of a few features depends on whether a project is using semantic or time-based versioning.

  • Regression detection
  • release:latest

We automatically detect whether a project is using semantic or time-based versioning based on:

  • If ≤ 2 releases total: we look at most recent release.
  • If 3-9 releases (inclusive): if any of the most recent 3 releases is semver, project is semver.
  • If 10 or more releases: if any of the most recent 3 releases is semver, and 3 out of the most recent 10 releases is semver, then the project is semver.

  release: "my-project-name@2.3.12",

A common way to do this with JavaScript in a Node/npm environment would be to use the process.env.npm_package_version like so:

  release: "my-project-name@" + process.env.npm_package_version,

How you make the release name (or version) available to your code is up to you. For example, you could use an environment variable that is set during the build process or during initial start-up.

Setting the release name tags each event with that release name. We recommend that you tell Sentry about a new release before sending events with that release name, as this will unlock a few more features. Learn more in our Releases documentation.

If you don't tell Sentry about a new release, Sentry will automatically create a release entity in the system the first time it sees an event with that release ID.

After configuring your SDK, you can install a repository integration or manually supply Sentry with your own commit metadata. Read our documentation about setting up releases for further information about integrations, associating commits, and telling Sentry when deploying releases.

Monitor the health of releases by observing user adoption, usage of the application, percentage of crashes, and session data. Release health will provide insight into the impact of crashes and bugs as it relates to user experience, and reveal trends with each new issue through the Release Details graphs and filters.

Crash reporting and app hang detection are not available for watchOS.

In order to monitor release health, the SDK sends session data.

A session represents the interaction between the user and the application. Sessions contain a timestamp, a status (if the session was OK or if it crashed), and are always linked to a release. Most Sentry SDKs can manage sessions automatically.

Release health on the server side is tracked in two different modes:

  • Single sessions that represent a node process; for example, a CLI application. In single sessions mode, the SDK creates a session for every node process. A session is started on init of the SDK, and ends when the process is exited.
  • Session aggregates represent requests. In session aggregates mode, sessions will be recorded differently and will represent the lifetime of requests. For the SDK to be able to capture request mode sessions, you must enable the requestHandler of the Express middleware.
// The Sentry request handler middleware must be added before any other handlers

The SDK automatically determines which mode release health will operate in. By default, the SDK runs in single sessions mode. However, if the requestHandler Express middleware is enabled, release health is automatically toggled to session aggregates mode. If the requestHandler Express middleware is not enabled, session aggregates mode will not be enabled and sessions will represent the health of the web server application process if, for example, a web server application is being run.

We mark the session as crashed if an unhandled error reached our errorHandler middleware.

We mark the session as an error if the SDK captures an event that contains an exception (this includes manually captured exceptions).

By default, the JavaScript SDKs are sending sessions, to disable this toggle the flag autoSessionTracking to false:

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