missing items after upgrade to Mindscape.Raygun4Net.AspNetCore 11.0.3 from 9.0.4

Hi Dave,

There have been some breaking changes between version 9 and 11 of the raygun4net provider. The full change log can be found here.

Specifically for you, RaygunMiddlewareSettings and DefaultRaygunAspNetCoreClientProvider have been removed in favour of a singleton approach to the RaygunClient.

Translating your setup to the new approach would look something like this:

services.AddSingleton(s => 
{
  var client = new RaygunClient(s.GetService<RaygunSettings>()!, s.GetService<IRaygunUserProvider>()!);

  client.SendingMessage += (sender, args) =>
  {
        if (args.Message.Details.Error.ClassName == "System.OperationCanceledException" ||
            args.Message.Details.Error.ClassName == "System.Threading.Tasks.TaskCanceledException" ||
            args.Message.Details.Error.ClassName == "Microsoft.AspNetCore.Connections.ConnectionResetException")
        {
            args.Cancel = true;
        }
  };

  return client;
});

services.AddRaygun(Configuration, settings => 
{
  settings.ApplicationVersion = System.Reflection.Assembly.GetEntryAssembly().GetName().Version.ToString();
});

See this GitHub issue for more information about the SendingMessage event.

Let me know if there is anything else you need assistance with.

Kind regards,

Jasen

Hello Dave,

Based on the original post I don't think you need to make lots of changes.

As Jasen showed, it should be a case of moving the code in the RaygunAspNetCoreClientProvider class to your registration.

So:

services.AddRaygun(Configuration, new RaygunMiddlewareSettings()
{
    ClientProvider = new RaygunAspNetCoreClientProvider()
});

To:

services.AddSingleton(s => 
{
    var client = new RaygunClient(s.GetService<RaygunSettings>()!, s.GetService<IRaygunUserProvider>()!);

    client.SendingMessage += (sender, args) =>
    {
        if (args.Message.Details.Error.ClassName == "System.OperationCanceledException" ||
            args.Message.Details.Error.ClassName == "System.Threading.Tasks.TaskCanceledException" ||
            args.Message.Details.Error.ClassName == "Microsoft.AspNetCore.Connections.ConnectionResetException")
        {
            args.Cancel = true;
        }
    };

    return client;
});

services.AddRaygun(Configuration, settings => 
{
    settings.ApplicationVersion = System.Reflection.Assembly.GetEntryAssembly().GetName().Version.ToString();
});

If you want to handle errors yourself in your controller you can inject the RaygunClient and call SendInBackground:

public class TestController
{
    private RaygunClient _client;

    public TestController(RaygunClient client)
    {
        _client = client;
    }

    public async Task<IActionResult> DoSomething()
    {
        try
        {
            throw new Exception("Throwing things");
        }
        catch (Exception e)
        {
            // If you want HTTP Request Data
            await _client.SendInBackground(ex, null, HttpContext);

            // If you don't want HTTP Request Data
            await _client.SendInBackground(ex);
        }
    }
}

We don't like making breaking changes and we try to minimize them as much as possible. The major reasoning for alot of these changes are that we treated the RaygunClient as transient, and this can cause some problems with applications that have a high number of errors being raised. For example, in Azure it can cause thread exhaustion, and in other cases it can generally cause high memory usage and/or thread count.

Typically we would mark apis as Obsolete for a period of time before deciding to remove them, however these particular APIs had to break in order for us to better the RaygunClient. We do indicate this with semantic versioning and have a change log in the repository which is linked from Nuget.

While the new features of collecting Environment variables, added support for breadcrumbs, offline storage, as well as performance improvements. I do think its worth the effort to upgrade.

Thank you. Phill

Hey Dave,

Thank you for the feedback, we do appreciate it and I've passed it on.

I think if you're not suffering from any thread exhaustion or similar issues, you could defer upgrading the library for the time being.

If you do want to go ahead with the upgrade and the time consuming bit is the custom handling, it may speed things up to use regex find/replace:

find:

([a-zA-Z]+).SetCurrentContext(HttpContext);[\n\r]\W+(?:await\W)?[a-zA-Z]+.SendAsync(([a-zA-Z]+));

replace:

await $1.SendInBackground($2, null, HttpContext)

I found this way helpful when fixing 1000s of unit tests in NUnit when their API changed.

I do apologize for the inconvenience that this API change causes you, we really do try hard to not break APIs or at least obsolete them first, this one was unavoidable and I believe probably the biggest API change we've had to make.

Thank you.

Phill