Sentry 1.0.0-rc

Prefix Reserved
This is a prerelease version of Sentry.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Sentry --version 1.0.0-rc                
NuGet\Install-Package Sentry -Version 1.0.0-rc                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Sentry" Version="1.0.0-rc" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Sentry --version 1.0.0-rc                
#r "nuget: Sentry, 1.0.0-rc"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Sentry as a Cake Addin
#addin nuget:?package=Sentry&version=1.0.0-rc&prerelease

// Install Sentry as a Cake Tool
#tool nuget:?package=Sentry&version=1.0.0-rc&prerelease                

Below you will find a basic introduction to the SDK and its API.

For more details, please: refer to the SDK documentation

Main features

  • Automatic Captures global unhandled exceptions (AppDomain)
  • Scope management
  • Duplicate events automatically dropped
  • Events from the same exception automatically dropped
  • Web proxy support
  • HttpClient/HttpClientHandler configuration callback
  • Compress request body
  • Event sampling opt-in
  • Event flooding protection (429 retry-after and internal bound queue)
  • DSN discovered via environment variable
  • Release (version) reported automatically
  • CLS Compliant
  • Strong named
  • SourceLink (including PDB in nuget package)
  • Device OS info sent
  • Device Runtime info sent
  • Enable SDK debug mode (opt-in)
  • Attach stack trace for captured messages (opt-in)
  • Tested on Windows, Linux and macOS
  • Tested on .NET Core, .NET Framework and Mono

Basics

Initialize the SDK:

void Main() 
{
    using (SentrySdk.Init("dsn"))
    {
        // App code
    }
}

The SDK by default will watch for unhandled exceptions in your app. If the DSN is not explicitly passed by parameter to Init, the SDK will try to locate it via environment variable SENTRY_DSN.

To configure advanced settings, for example a proxy server:

void Main() 
{
    using (SentrySdk.Init(o =>
    {
        o.Dsn = new Dsn("dsn");
        o.Http(h =>
        {
            h.Proxy = new WebProxy("https://localhost:3128");
        });
    }))
    {
        // App code
    }
}

Capture an exception:

try
{
    throw null;
}
catch (Exception e)
{
    SentrySdk.CaptureException(e);
}

Capture a message:

SentrySdk.CaptureMessage("this just happened");

Internals/Testability

It's often the case we don't want to couple our code with static class like SentrySdk, especially to allow our code to be testable. If that's your case, you can use 2 abstractions:

  • ISentryClient
  • IHub

The ISentryClient is responsible to queueing the event to be sent to Sentry and abstracting away the internal transport. The IHub on the other hand, holds a client and the current scope. It in fact also implements ISentryClient and is able to dispatch calls to the right client depending on the current scope.

In order to allow different events hold different contextual data, you need to know in which scope you are in. That's the job of the Hub. It holds the scope management as well as a client.

If all you are doing is sending events, without modification/access to the current scope, then you depend on ISentryClient. If on the other hand you would like to have access to the current scope by configuring it or binding a different client to it, etc. You'd depend on IHub.

An example using IHub for testability is SentryLogger and its unit tests SentryLoggerTests.
SentryLogger depends on IHub because it does modify the scope (through AddBreadcrumb). In case it only sent events, it should instead depend on ISentryClient

Compatibility

The packages target .NET Standard 2.0. That means it is compatible with the following versions or newer:

  • .NET Framework 4.6.1
  • .NET Core 2.0
  • Mono 5.4
  • Xamarin.Android 8.0
  • Xamarin.Mac 3.8
  • Xamarin.iOS 10.14
  • Universal Windows Platform 10.0.16299

Of those, we've tested (we run our unit/integration tests) against:

  • .NET Framework 4.6.2 on Windows (AppVeyor)
  • Mono 5.12 macOS and Linux (Travis-CI)
  • .NET Core 2.0 Windows (AppVeyor), macOS and Linux (Travis-CI)
  • .NET Core 2.1 Windows (AppVeyor), macOS and Linux (Travis-CI)
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (78)

Showing the top 5 NuGet packages that depend on Sentry:

Package Downloads
Sentry.Extensions.Logging

Official Microsoft.Extensions.Logging integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.

Sentry.Serilog

Official Serilog integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.

Sentry.NLog

Official NLog integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.

Sentry.DiagnosticSource

Official Diagnostic.Listener integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time. Note: This package is not needed when using Sentry with .NET Core 3 or higher.

VisioForge.DotNet.Core

VisioForge .Net products for video capture, editing and playback (Video Capture SDK, Media Player SDK, Video Edit SDK). Core package.

GitHub repositories (46)

Showing the top 5 popular GitHub repositories that depend on Sentry:

Repository Stars
files-community/Files
A modern file manager that helps users organize their files and folders.
ppy/osu
rhythm is just a *click* away!
Sonarr/Sonarr
Smart PVR for newsgroup and bittorrent users.
Radarr/Radarr
Movie organizer/manager for usenet and torrent users.
LykosAI/StabilityMatrix
Multi-Platform Package Manager for Stable Diffusion
Version Downloads Last updated
4.13.0 107,254 11/5/2024
4.12.2 27,272 11/2/2024
4.12.1 374,532 10/10/2024
4.12.1-segv1 619 11/1/2024
4.12.0 148,974 10/2/2024
4.11.0 339,900 9/22/2024
4.10.2 691,517 8/21/2024
4.10.1 122,733 8/16/2024
4.10.0 47,034 8/14/2024
4.9.0 996,051 7/11/2024
4.9.0-sync.collection.2 190 7/30/2024
4.9.0-sync.collection.1 89 7/30/2024
4.8.1 213,492 7/2/2024
4.8.0 186,156 6/26/2024
4.7.0 865,236 5/27/2024 4.7.0 is deprecated.
4.6.2 392,704 5/14/2024 4.6.2 is deprecated.
4.6.0 90,152 5/9/2024 4.6.0 is deprecated.
4.5.0 261,913 4/30/2024 4.5.0 is deprecated.
4.4.0 450,710 4/12/2024 4.4.0 is deprecated.
4.3.0 142,800 4/10/2024 4.3.0 is deprecated.
4.2.1 781,274 3/12/2024 4.2.1 is deprecated.
4.2.0 41,696 3/11/2024 4.2.0 is deprecated.
4.1.2 1,088,271 2/20/2024 4.1.2 is deprecated.
4.1.1 179,268 2/14/2024 4.1.1 is deprecated.
4.1.0 164,843 2/9/2024 4.1.0 is deprecated.
4.0.3 70,074 2/7/2024 4.0.3 is deprecated.
4.0.2 65,585 2/6/2024 4.0.2 is deprecated.
4.0.1 40,221 2/5/2024 4.0.1 is deprecated.
4.0.0 107,367 2/1/2024 4.0.0 is deprecated.
4.0.0-beta.9 1,122 1/30/2024
4.0.0-beta.8 17,304 1/11/2024
4.0.0-beta.7 7,890 1/5/2024
4.0.0-beta.6 16,167 12/13/2023
4.0.0-beta.5 2,521 12/12/2023
4.0.0-beta.4 18,958 12/5/2023
4.0.0-beta.3 587 12/2/2023
4.0.0-beta.2 4,736 11/23/2023
4.0.0-beta.1 1,031 11/19/2023
4.0.0-beta.0 554 11/17/2023
4.0.0-alpha.0 5,781 11/9/2023
3.41.4 1,050,706 1/23/2024
3.41.3 1,487,652 11/29/2023
3.41.2 319,072 11/23/2023
3.41.1 71,577 11/22/2023
3.41.0 897,302 11/8/2023
3.40.1 764,986 10/12/2023
3.40.0 137,634 10/10/2023
3.40.0-beta.0 14,597 9/21/2023
3.39.1 1,440,189 9/12/2023
3.39.0 211,877 9/7/2023
3.36.0 603,253 8/22/2023
3.35.1 244,972 8/16/2023
3.35.0 170,577 8/8/2023 3.35.0 is deprecated.
3.34.0 1,099,754 7/13/2023
3.33.1 1,301,859 6/13/2023
3.33.0 1,148,287 5/22/2023
3.32.0 26,414 5/22/2023
3.31.0 748,080 5/2/2023
3.30.0 1,167,595 4/11/2023
3.29.1 1,771,309 3/11/2023
3.29.0 237,703 3/6/2023
3.28.1 1,365,470 2/10/2023
3.28.0 74,213 2/8/2023
3.27.1 328,778 2/3/2023
3.27.0 145,056 2/1/2023
3.26.2 678,232 1/24/2023
3.26.1 274,050 1/17/2023
3.26.0 357,990 1/13/2023
3.25.0 1,174,510 12/23/2022
3.24.1 340,274 12/16/2022
3.24.0 1,663,945 11/18/2022
3.23.1 892,164 10/31/2022
3.23.0 101,474 10/27/2022
3.22.0 1,376,117 10/7/2022
3.21.0 1,697,415 9/2/2022
3.20.1 1,674,036 7/26/2022
3.19.0 947,598 6/28/2022
3.18.0 607,936 6/15/2022
3.17.1 1,417,578 5/8/2022
3.17.0 145,725 5/3/2022
3.16.0 972,301 4/7/2022
3.15.0 982,405 3/15/2022
3.14.1 897,498 2/18/2022
3.14.0 207,925 2/14/2022
3.13.0 1,477,844 1/11/2022
3.12.3 1,056,849 12/19/2021
3.12.2 83,057 12/15/2021
3.12.1 364,742 12/6/2021
3.12.0 292,734 11/23/2021
3.12.0-alpha.1 5,939 11/7/2021
3.11.1 673,797 11/5/2021
3.11.0 151,472 11/2/2021
3.10.0 644,219 10/15/2021
3.9.4 967,587 9/29/2021
3.9.3 171,180 9/21/2021
3.9.2 235,095 9/10/2021
3.9.1 14,391 9/9/2021
3.9.0 304,558 8/27/2021
3.8.3 818,134 7/25/2021
3.8.2 141,199 7/17/2021
3.8.1 27,819 7/15/2021
3.8.0 120,145 7/14/2021
3.7.0 134,869 7/10/2021
3.6.1 180,922 7/2/2021
3.6.0 235,632 6/23/2021
3.6.0-alpha.2 645 6/18/2021
3.6.0-alpha.1 1,257 6/11/2021
3.5.0 476,606 6/7/2021 3.5.0 is deprecated because it has critical bugs.
3.4.0 151,758 5/31/2021 3.4.0 is deprecated because it has critical bugs.
3.4.0-beta.0 325 5/27/2021 3.4.0-beta.0 is deprecated because it has critical bugs.
3.3.5-beta.0 2,564 5/13/2021
3.3.4 759,551 4/26/2021
3.3.3 9,121 4/23/2021
3.3.2 24,782 4/23/2021
3.3.1 575,415 4/5/2021
3.3.0 33,953 4/3/2021
3.2.0 132,105 3/26/2021
3.1.0 385,332 3/10/2021
3.0.8 70,839 3/4/2021
3.0.7 240,770 2/20/2021
3.0.6 101,844 2/14/2021
3.0.5 70,251 2/9/2021
3.0.4 31,865 2/8/2021
3.0.3 79,494 2/3/2021
3.0.2 22,482 2/3/2021
3.0.1 142,376 1/29/2021
3.0.0 40,620 1/28/2021
3.0.0-beta.0 5,580 1/20/2021
3.0.0-alpha.11 487 1/15/2021
3.0.0-alpha.10 63,678 1/10/2021
3.0.0-alpha.9 2,258 12/29/2020
3.0.0-alpha.8 4,538 12/25/2020
3.0.0-alpha.7 2,991 12/16/2020
3.0.0-alpha.6 3,667 11/30/2020
3.0.0-alpha.5 3,289 11/21/2020
3.0.0-alpha.4 2,448 11/2/2020
3.0.0-alpha.3 1,799 10/29/2020
3.0.0-alpha.2 840 10/21/2020
3.0.0-alpha.1 6,061 10/16/2020
3.0.0-alpha.0 2,116 9/25/2020
2.2.0-alpha 2,441 9/19/2020
2.1.8 2,033,612 11/21/2020
2.1.6 2,106,302 8/20/2020
2.1.5 601,442 7/27/2020
2.1.5-beta 4,231 6/30/2020
2.1.4 627,594 6/25/2020
2.1.3 690,331 6/5/2020
2.1.2-beta5 7,971 5/19/2020
2.1.2-beta4 4,972 5/12/2020
2.1.2-beta3 2,107 5/7/2020
2.1.2-beta2 22,178 4/16/2020
2.1.2-beta 4,397 3/31/2020
2.1.1 1,578,043 3/19/2020
2.1.0 769,254 2/24/2020
2.0.3 593,086 2/12/2020
2.0.2 36,315 2/8/2020
2.0.1 275,201 1/28/2020
2.0.0-beta8 24,225 1/15/2020
2.0.0-beta7 162,483 12/17/2019
2.0.0-beta6 102,978 10/31/2019
2.0.0-beta5 7,348 10/29/2019
2.0.0-beta4 75,878 9/4/2019
2.0.0-beta3 17,198 7/26/2019
2.0.0-beta2 6,254 6/9/2019
2.0.0-beta 3,370 6/4/2019
1.2.1-beta 2,160 5/27/2019
1.2.0 3,147,936 5/23/2019
1.1.3-beta4 2,003 5/15/2019
1.1.3-beta3 1,796 5/13/2019
1.1.3-beta2 7,970 3/28/2019
1.1.3-beta 5,469 2/11/2019
1.1.2 632,461 1/16/2019
1.1.2-beta 3,618 1/8/2019
1.1.1 24,412 1/5/2019
1.1.0 115,690 12/5/2018
1.0.1-beta5 2,713 12/5/2018
1.0.1-beta4 3,461 12/3/2018
1.0.1-beta3 18,438 11/15/2018
1.0.1-beta2 3,355 11/14/2018
1.0.1-beta 20,899 10/24/2018
1.0.0 289,718 10/2/2018
1.0.0-rc2 24,628 9/7/2018
1.0.0-rc 5,974 8/24/2018
0.0.1-preview5 7,569 8/5/2018
0.0.1-preview4 5,123 7/30/2018
0.0.1-preview3 6,693 7/17/2018
0.0.1-preview2 6,070 7/3/2018
0.0.1-preview1 2,648 6/28/2018