Backtrace 2.0.1

Backtrace

Backtrace's integration with C# applications allows customers to capture and report handled and unhandled C# exceptions to their Backtrace instance, instantly offering the ability to prioritize and debug software errors.

Features Summary

• Light-weight C# client library that quickly submits C#/.NET exceptions and crashes to your Backtrace dashboard
  • Can include callstack, system metadata, custom metadata, and file attachments (e.g. minidump) if needed.
• Supports a wide range of .NET versions such as .NET Framework, .NET Core, Mono, Xamarin and Unity
• Supports both CLI and IDE work environments
• Supports asynchronous Tasks in .NET 4.5+
• Supports offline database for error report storage and re-submission in case of network outage
• Fully customizable and extendable event handlers and base classes for custom implementations
• Available as a NuGet Package as well as a fully open-sourced Github Release.

Supported .NET Frameworks

• .NET Framework 3.5 +
• .NET Framework 4.5 +
  • getting information about application thread
  • handling unhandled application exceptions
• .NET Standard:
  • .NET Core 2.0 application
  • Xamarin
  • Universal Windows Platform
• Unity

Prerequisites

Development Environment

• On Windows, we recommend Visual Studio 2017 or above for IDE. You can download and install Visual Studio here. As an alternative to Visual Studio you can use .NET Core command line interface, see installation guide here
• On Mac OS X, you can download and install Visual Studio here if you prefer using an IDE. For command line, you should to download and install .NET Core 2.0 or above.
• On Linux, Visual Studio Code is available as a light-weight IDE. Similarly, you can use .NET Core command line interface, see instruction for Linux here

NuGet

The Backtrace library is available on NuGet. You can read more about NuGet and how to download the packages here

Installing Backtrace via NuGet

You can install Backtrace via NuGet using the following commands:

Windows NuGet CLI:

Install-Package Backtrace

Linux/Mac OS X .NET Core CLI:

dotnet add package Backtrace

Documentation

Initialize a new BacktraceClient

First create a BacktraceCredential instance with your Backtrace endpoint URL (e.g. https://xxx.sp.backtrace.io:6098) and submission token, and supply it as a parameter in the BacktraceClient constructor:

var credentials = new BacktraceCredentials("backtrace_endpoint_url", "token");
var backtraceClient = new BacktraceClient(credentials);

For more advanced usage of BacktraceClient, you can supply BacktraceClientConfiguration as a parameter. See the following example:

var credentials = new BacktraceCredentials("backtrace_endpoint_url", "token");
var configuration = new BacktraceClientConfiguration(credentials){
    ClientAttributes = new Dictionary<string, object>() { 
        { "attribute_name", "attribute_value" } },
    ReportPerMin = 3,
}
var backtraceClient = new BacktraceClient(configuration);

Database initialization <a name="documentation-database-initialization"></a>

BacktraceClient allows you to customize the initialization of BacktraceDatabase for local storage of error reports by supplying a BacktraceDatabaseSettings parameter, as follows:

var dbSettings = new BacktraceDatabaseSettings("databaseDirectory"){
    MaxRecordCount = 100,
    MaxDatabaseSize = 1000,
    AutoSendMode = true,
    RetryBehavior = Backtrace.Types.RetryBehavior.ByInterval
};
var database = new BacktraceDatabase<object>(dbSettings);
var credentials = new BacktraceCredentials("backtrace_endpoint_url", "token");
var configuration = new BacktraceClientConfiguration(credentials);
var backtraceClient = new BacktraceClient(configuration, database);

TLS/SSL Support

For .NET Standard 2.0 and .NET Framework 4.6+, TLS 1.2 support is built-in.

For .NET Framework 4.5 (and below) as well as .NET Standard 2.0 (and below), TLS 1.2 support may not be available, but you can use still enable lower TLS/SSL support by adding the following code before BacktraceClient initialization.

ServicePointManager.SecurityProtocol =
                     SecurityProtocolType.Tls
                    | (SecurityProtocolType)0x00000300
                    | (SecurityProtocolType)0x00000C00;

ServicePointManager.ServerCertificateValidationCallback 
    += (sender, certificate, chain, errors) => true;