Manually sending RayGunMessage does not properly ignore header names

Hi Steve,

The provider strips out headers when the message is being built, which is fine when the provider builds the message from the sending of an exception as we build the message internally and set the options. If you are building the message manually then you need to provide the options to the RaygunAspNetCoreRequestMessageBuilder class in the Build method via the second parameter that takes an instance of the RaygunRequestMessageOptions class.

Here is an example of this, note I'm using the constructor of RaygunRequestMessageOptions that takes the ignore setting values which are coming from my appsettings.json configuration.

public class HomeController : Controller
{
  private readonly IRaygunAspNetCoreClientProvider _clientProvider;
  private readonly IOptions<RaygunSettings> _settings;

  public HomeController(IRaygunAspNetCoreClientProvider clientProvider, IOptions<RaygunSettings> settings)
  {
    _clientProvider = clientProvider;
    _settings = settings;
  }

  public async Task<IActionResult> Test()
  {
    try
    {
      throw new Exception("Test .NET core MVC app");
    }
    catch (Exception ex)
    {
      var msg = new RaygunMessage();
      var options = new RaygunRequestMessageOptions(_settings.Value.IgnoreFormFieldNames ?? new string[0], _settings.Value.IgnoreHeaderNames ?? new string[0], _settings.Value.IgnoreCookieNames ?? new string[0], _settings.Value.IgnoreServerVariableNames ?? new string[0]);

      msg.Details = new RaygunMessageDetails
      {
        Error = RaygunErrorMessageBuilder.Build(ex),
        Request = await RaygunAspNetCoreRequestMessageBuilder.Build(HttpContext, options)
      };

      var raygunClient = _clientProvider.GetClient(_settings.Value);
      await raygunClient.SendInBackground(msg);
    }

    return View();
  }
}

Hi Steve,

The RaygunClient was not originally developed with this usage scenario in mind and the methods were added to support non-standard use cases.

Our recommended approach would be to have your configuration for the Ignore* in the appsettings.json file and to use the RaygunClient to send the Exception object, which will build the message internally according to the defined settings. Building up a RaygunMessage object and sending that is for when you need full control of the message and what is sent, which is why there is no filtering on that method. I understand this may not be clear or well documented as it is something that has evolved over time for different usage scenarios.

It would be good to understand why you are using this method as we may be able to provide some advice on how to use the standard send method with your usage scenario.

Thanks.

However you get an instance of the RaygunClient, if you use the Send or SendInBackground methods that take a RaygunMessage object then none of the ignore* settings will be applied. These are only taken into account when using the Send or SendInBackground methods that take an Exception object. However the ignore* settings are configured, they will always apply when using the methods that take an Exception object.

If you can, I would suggest changing your code to use one of the Send/InBackground methods that take an Exception. If you need to customise the message before it sent to Raygun then it would be best to attach to the SendingMessage event on the RaygunClient and modify the message there. This then ensures that all ignore* settings are applied at the same time as giving complete control over the message sent.

I've set up a public GitHub repository with some examples that may help. In here I've tried to replicate the usage of an ExceptionFilterAttribute, that uses the same ClientProvider that has my logic for getting a user, setting version and attaching to the SendingMessage event. Hopefully this helps a bit.

Exception Filter Attribute https://github.com/j5alive/Raygun4NetCoreExample/blob/master/src/Raygun4NetCoreExample/RaygunErrorAttribute.cs

Custom Client Provider https://github.com/j5alive/Raygun4NetCoreExample/blob/master/src/Raygun4NetCoreExample/ExampleRaygunAspNetCoreClientProvider.cs

My buggy Controller https://github.com/j5alive/Raygun4NetCoreExample/blob/master/src/Raygun4NetCoreExample/Controllers/HomeController.cs

Jeremy