Releases & Health
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
Bind the Version
Include a release ID (often called a "version") when you configure your client 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
orpackage@version+build
(for example,my.project.name@2.3.12+1234
)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 DVCS, 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 withsentry-cli releases propose-version
.
Releases are global per organization; prefix them with something project-specific for easy differentiation.
using Sentry;
// Add this to the SDK initialization callback
options.Release = "my-project-name@2.3.12";
The SDK attempts to locate the release to add to events sent to Sentry.
The SDK will first look at the entry assembly's AssemblyInformationalVersionAttribute
, which accepts a string as
value and is often used to set a GIT commit hash.
If that returns null, it'll look at the default AssemblyVersionAttribute
which accepts the numeric version number.
How you make the version available to your code is up to you. For example, you could use an environment variable that is set during the build process.
This tags each event with the release value. We recommend that you tell Sentry about a new release before deploying it, as this will unlock a few more features as discussed in our documentation about releases. But if you don’t, 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.
Release Health
Release health support for .NET is currently limited to single-instance client applications only. This means it can be used with WPF, Xamarin, WinForms and similar app models. Support for server frameworks such as ASP.NET is planned.
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.
The SDK will automatically manage the start and end of the sessions when the SDK is initialized.
We mark the session as:
- Healthy
- Abnormal
- Errored: if the SDK captures an event that contains an exception (this includes manually captured errors).
- Crashed
To enable sending sessions, set the AutoSessionTracking
flag to true
. When enabled, the .NET SDK is creating a session on application startup and ending it on shut down.
using Sentry;
// Add this to the SDK initialization callback
options.AutoSessionTracking = true; // default: false
- Package:
- nuget:Sentry.Serilog
- Version:
- 4.9.0
- Repository:
- https://github.com/getsentry/sentry-dotnet