Raygun.Blazor.Server 0.0.1

Raygun for Blazor

Usage

Installation

• TODO: Package installation instructions. e.g.

dotnet add package <something>

Setup

Using WebAssemblyHostBuilder to create the client

Use UseRaygunBlazor extension to configure the RaygunBlazorClient and related services for use in a Blazor WebAssembly application.

var builder = WebAssemblyHostBuilder.CreateDefault(args);

builder.UseRaygunBlazor();

Raygun Settings

Raygun for Blazor uses the appsettings.json to load configuration settings.

RaygunSettings will be obtained from the configuration section name Raygun.

For example:

{
  "Raygun": {
    "ApiKey": "YOUR_API_KEY",
    "CatchUnhandledExceptions": "false",
    "LogLevel": "Debug"
  }
}

For all configuration values, check the RaygunSettings class under src/Raygun.Blazor/RaygunSettings.cs.

See Configuration in ASP.NET Core to learn more about managing application settings.

Initalize the client

Inject the RaygunBlazorClient in your code:

@inject RaygunBlazorClient raygunClient;

And call to raygunClient.InitializeAsync() at least once.

This method should be called as early as possible in the course of using the app. The best place to do it is inside the OnAfterRenderAsync method of the main layout page. However it will also be called automatically before sending any exceptions, just in case.

Recording an error

To send an exception to Raygun call to raygunClient.RecordExceptionAsync(...)

This method accepts the following arguments:

• ex: The Exception to send back to Raygun.
• userDetails: Optional. Attach user details to exception, takes priority over IRaygunUserProvider.
• tags: Optional. User-specified tags that should be applied to the error.
• userCustomData: Optional. Any custom data that you you like sent with the report to assist with troubleshooting.
• cancellationToken: Optional. A CancellationToken to allow you to cancel the current request, if necessary.

Recording a breadcrumb

Records a Breadcrumb to help you track what was going on in your application before an error occurred.

Call to raygunClient.RecordBreadcrumb(...);

This method accepts the following arguments:

• message: The message you want to record for this Breadcrumb.
• type: The BreadcrumbType for the message. Defaults to BreadcrumbType.Manual.
• category: A custom value used to arbitrarily group this Breadcrumb.
• customData: Any custom data you want to record about application state when the Breadcrumb was recorded.

Attaching user details

Raygun for Blazor provides two ways to attach user details to error reports:

1. Provide UserDetails in the RecordExceptionAsync method call.
2. Implement a IRaygunUserProvider.

User details class

The following properties can be provided as user details:

• UserId: Unique identifier for the user is the user identifier.
• IsAnonymous: Flag indicating if the user is anonymous or not.
• Email: User's email address.
• FullName: User's full name.
• FirstName: User's first name (what you would use if you were emailing them - "Hi {{firstName}}, ...")
• DeviceId: Device unique identifier. Useful if sending errors from a mobile device.

All properties are strings except isAnonymous, which is a boolean. As well, they are all optional.

User details in RecordExceptionAsync

The simplest way to attach user details to an error report, is to do it when calling to RecordExceptionAsync.

Pass a UserDetails object to the method call:

var userDetails = new UserDetails() { Email = "test@example.com", FullName = "Test User", UserId = "123456" };

await RaygunClient.RecordExceptionAsync(ex, userDetails);

Implementing IRaygunUserProvider

Providing an instance of IRaygunUserProvider to the Raygun Blazor client allows you to attach user details also to errors reported automatically, for example, captured unhandled exceptions or exceptions from the JavaScript layer.

Implement an IRaygunUserProvider, for example:

public class MyUserProvider : IRaygunUserProvider
{
    public Task<UserDetails?> GetCurrentUser()
    {
        return Task.FromResult(new UserDetails());
    }
}

And inject it into the Raygun Blazor client:

builder.Services.AddSingleton<IRaygunUserProvider, MyUserProvider>();

For a complete example on how to implement a IRaygunUserProvider with the AuthenticationStateProvider check the example project file src/Raygun.Samples.Blazor.WebAssembly/Program.cs.

Internal logger

Raygun for Blazor uses an internal logger to help facilitate the integration of the package. The default log level is "Warning". To completely disable the internal logger, set the "LogLevel" setting to "None".

For example:

{
  "Raygun": {
    "LogLevel": "None"
  }
}

For all configuration values, check the RaygunLogLevel enum under src/Raygun.Blazor/Logging/RaygunLogLevel.cs.

Blazor WebAssembly

Setup

• TODO: setup WebAssembly instructions

Example

Example project is located in src/Raygun.Samples.Blazor.WebAssembly

To run the example:

1. Install dotnet-sdk minimum version supported in 8.0.300.
2. Add the ApiKey property to in src/Raygun.Samples.Blazor.WebAssembly/wwwroot/appsettings.json

{
  "Raygun": {
    "ApiKey": "YOUR_API_KEY"
  }
}

3. Run dotnet watch from the example folder.

A browser window to http://localhost:5010/ should automatically open.

Blazor Server

Installation

• TODO: NuGet install instructions

Setup

Add a scoped RaygunBlazorClient by calling to UseRaygunBlazor() with your WebApplication builder.

var builder = WebApplication.CreateBuilder(args);

...

builder.UseRaygunBlazor();

Accessing RaygunBlazorClient

You can access the RaygunBlazorClient using @inject in your code:

@inject RaygunBlazorClient RaygunClient

...

RaygunClient.RecordExceptionAsync(...)

Capturing unhandled exceptions

Use RaygunErrorBoundary to wrap compoments and capture unhandled exceptions automatically.

Note: You have to set @rendermode="InteractiveServer" in your HeadOutlet and Routes component to enable error capturing, as explained in Handle errors in ASP.NET Core Blazor apps

For example, in your MainLayout.razor:

@using Raygun.Blazor.Server.Controls

...

<article class="content px-4">
  <RaygunErrorBoundary>
    @Body
  </RaygunErrorBoundary>
</article>

You can set ShowExceptionsUI="true to display a custom error message:

<RaygunErrorBoundary ShowExceptionUI="true">
  <ChildContent>
    @Body
  </ChildContent>
  <ErrorContent>
    <p class="errorUI">👾 Error captured by Raygun!</p>
  </ErrorContent>
</RaygunErrorBoundary>

Example

Example project is located in src/Raygun.Samples.Blazor.Server

To run the example:

1. Install dotnet-sdk minimum version supported in 8.0.300.
2. Add the ApiKey property to in src/Raygun.Samples.Blazor.Server/appsettings.Development.json

{
  "Raygun": {
    "ApiKey": "YOUR_API_KEY"
  }
}

3. Run dotnet watch from the example folder.

A browser window to http://localhost:5010/ should automatically open.

Publishing

• TODO: Packagre publishing instructions, e.g. NuGet publish instructions