Xamarin.Forms

Installation

The provider targets .NET Standard 2.0 and is available through NuGet packages, found here.

The currently supported platforms are Android and iOS with the following versions or newer:

• Xamarin.Android 8.0
• Xamarin.iOS 10.0

Make sure NuGet is installed in Visual Studio, then right-click on your project and select "Manage NuGet Packages..." Make sure you're in the "Online" section in the left hand pane. Then, in the top right search box, search for Raygun4Xamarin.Forms and install it.

Initialisation

The initialisation of Raygun must occur early in the app's initial startup phase. We recommend doing this in the constructor of your Application class. Using the static Init method will also ensure a shared RaygunClient instance is available through the static property Current.

public partial class App : Application
{
  public App()
  {
    InitializeComponent();

    // Initialising the Raygun client 
    RaygunClient.Init("_API_KEY_");
    RaygunClient.Current.EnableCrashReporting();

    // Remaining application setup logic
    MainPage = new MainPage();
  }
}

Each platform being targeted requires an additional configuration step using the RaygunPlatform class in the following places.

For Android:

public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompatActivity
{
  protected override void OnCreate(Bundle savedInstanceState)
  {
    // MainActivity startup logic
    base.OnCreate(savedInstanceState);
    global::Xamarin.Forms.Forms.Init(this, savedInstanceState);
    LoadApplication(new App());

    // Configure Raygun for the current platform
    RaygunPlatform.Configure(this);
  }
}

For iOS:

public partial class AppDelegate : global::Xamarin.Forms.Platform.iOS.FormsApplicationDelegate
{
  public override bool FinishedLaunching(UIApplication app, NSDictionary options)
  {
    // AppDelegate startup logic
    global::Xamarin.Forms.Forms.Init();
    LoadApplication(new App());

    // Configure Raygun for the current platform
    RaygunPlatform.Configure();

    return base.FinishedLaunching(app, options);
  }
}

Once Crash Reporting is enabled, you are able to:

• Automatically report unhandled exceptions
• Manually report errors
• Record breadcrumbs

Modify or cancel reports

The Raygun client allows you to inspect the reports before they are sent to Raygun servers. You can inspect and modify the report details or cancel the report from being sent altogether.

This is done by setting an event handler on the shared Raygun client and will be called just before a report is sent - either automatically or manually.

RaygunClient.Current.BeforeSendingCrashReportEvent += (sender, e) =>
{
  if (e.Report.Details.Error.ClassName == "NotImplementedException")
  {
    e.Cancel = true;
  }
};

Manually reporting errors

Sometimes you may want to send exceptions manually, such as handled exceptions from within a try/catch block.

Here's an example of manually sending a report from a try/catch block:

try
{
  DoSomethingRisky();
}
catch (Exception exception)
{
  var tags = new List<string>() { "ManuallyReport" };
  var customData = new Dictionary<string, object>()
  {
    { "CustomString", "Value" }, 
    { "CustomNumber", 123 }
  }

  RaygunClient.Current.Send(exception, tags, customData);
}

The tags and custom data that is passed through when manually reporting an error will only appear on the associated error report in Raygun. This allows you to add additional information to a report without worrying that all subsequent reports will include this information.

Unique User Tracking

By default, the Raygun client will give a GUID (Globally Unique Identifier) to each user for distinguishing between them. If possible, we highly recommend providing your own unique identifiers for your users which can be done with the code below. The string you pass into the constructor can be whatever unique user id that works best for you - email address is a recommended example. Providing the first name and full name is optional.

RaygunClient.Current.User = new RaygunUserInfo("_UNIQUE_ID_")
{
  FirstName   = "Ronald",
  FullName    = "Ronald Raygun",
  Email       = "ronald@raygun.com",
  IsAnonymous = false
};

The string properties on a User have a maximum length of 255 characters. Users who have fields that exceed this amount will not be processed.

Recording breadcrumbs

Using the breadcrumbs feature, you can attach an accurate trail of the events through your system leading up to the moment an error report was generated. You'll gain more insight into why the application crashed when it did, making prioritization of fixes much easier. The current breadcrumbs are included with each report sent.

RaygunClient.Current.RecordBreadcrumb("Entered login screen");

Version tracking

The Raygun client supports tracking a version of your application that is in use when a crash occurs. This is helpful to determine what version was in use when an issue occurred and so if the latest version of your application was in use.

var settings = new RaygunSettings("_API_KEY_") 
{ 
  ApplicationVersion = "1.0.0",
};

// Initialise a client instance.
var client = RaygunClient.Init(settings);

Tags

An array of strings can be sent with each report and displayed in Raygun. This can be used to categorise errors or add additional contextual information. These tag values are also searchable in your Raygun dashboard so that you can find all error instances that you've marked with a particular tag.

// Initialise a client instance.
var client = RaygunClient.Init(settings);

// Setting tags that will be sent with every error report.
client.Tags = new List<string>() 
{ 
  "GlobalTag"
};

// Tags can also be added to individual error reports when reported manually
client.Send(exception, new List<string>() { "LocalTag" });

Custom data

Each error can be reported with a dictionary of custom data. This data gets displayed in Raygun and can be used to record useful contextual information for debugging.

// Initialise a client instance.
var client = RaygunClient.Init(settings);

// Setting information that will be sent with every error report.
client.CustomData = new Dictionary<string, object>() 
{
  { "GlobalString", "Value" },
  { "GlobalValue", 123 }
};

// Tags can also be added to individual error reports when reported manually
client.Send(exception, null, new Dictionary<string, object>()
{
  { "LocalString", "Value" }, 
  { "LocalNumber", 123 }
});

Internal logging

For debugging purposes you can set the level of logging that the provider will print to your debug console. This can be helpful to determine what information is or is not being sent to the Raygun API. The logging level can be set before initialising the Raygun client.

var settings = new RaygunSettings("_API_KEY_") 
{ 
  LogLevel = LogLevel.Verbose
};

// Initialise a client instance.
var client = RaygunClient.Init(settings);