如何使 elmah.io 与 ASP.NET 核心和错误处理中间件一起工作？

Question

注意：这个问题是关于 elmah.io (https://elmah.io/)，基于云的异常日志记录服务，而不是传统的 Elmah .Net 库。

我正在使用 ASP.NET Core 并且有一个简单的异常处理中间件。

public class HandleExceptionMiddleware
{
    public HandleExceptionMiddleware(RequestDelegate next)
    {
        Next = next;
    }

    RequestDelegate Next { get; }

    public async Task Invoke(HttpContext httpContext)
    {
        try
        {
            await Next(httpContext);
        }
        catch (Exception ex)
        {
            await HandleExceptionAsync(httpContext, ex);
        }
    }

    Task HandleExceptionAsync(HttpContext context, Exception ex)
    {
        var code = HttpStatusCode.InternalServerError;

        if (ex is ArgumentException)
            code = HttpStatusCode.BadRequest;

        var result = JsonConvert.SerializeObject(new { message = ex.Message });
        context.Response.ContentType = "application/json";
        context.Response.StatusCode = (int)code;
        return context.Response.WriteAsync(result);
    }
}

此中间件将 return 以下 JSON 响应取决于它看到的异常：

对于 ArgumentException：

HTTP/1.1 400 Bad Request

{"message":""}

对于所有其他例外情况：

HTTP/1.1 500 Internal Server Error

{"message":""}

我希望 elmah.io 记录 500 响应并忽略 400 响应（这是默认的 elmah.io 配置）。但是，当异常处理程序和 elmah.io 在 Startup 的 Configure 挂钩中按此顺序注册时，不会记录任何内容 elmah.io:

    app.UseElmahIo("API_KEY", new Guid("LOG_ID"));
    app.UseMiddleware<HandleExceptionMiddleware>()

但是，如果我将注册顺序更改为以下内容，所有内容都会被记录（包括 400 条回复）。这是有道理的，因为 elmah.io 在 HandleExceptionMiddleware 有机会更改响应之前处理异常：

    app.UseMiddleware<HandleExceptionMiddleware>()
    app.UseElmahIo("API_KEY", new Guid("LOG_ID"));

配置这些服务以便 elmah.io 记录 500 个响应并忽略 400 个响应的最佳方法是什么？

我想出的唯一解决方法是创建并注册 2 个异常处理中间件，而不是 1 个。一个在 elmah.io 之前注册，一个在 elmah.io 之后注册。它有效，但看起来有点难看：

    app.UseMiddleware<HandleInternalExceptionMiddleware>() // set 500 responses (these will have already been logged in elmah.io)
    app.UseElmahIo("API_KEY", new Guid("LOG_ID"));
    app.UseMiddleware<HandleExternalExceptionMiddleware>() // set 400 responses but ignore exceptions that should return 500 (these won't be logged in elmah.io)

我在这里创建了一个示例项目来演示此行为： https://github.com/johnnyoshika/elmah-io-experiment

Answer 1

配置 elmah.io 的正确方法是使用行为 2。您想在调用其他处理异常的方法之后调用 UseElmahIo 方法。这是因为很多错误处理中间件（包括你的 HandleExceptionMiddleware）吞噬了所有异常并将结果转换为其他东西。在您的情况下，HandleExceptionMiddleware 捕获所有异常并设置新的响应。在这种情况下，我们的中间件永远不会收到有关异常的通知（正如您提到的那样）。

我们有几种不同的方法来解决这个问题：

解决方案 1

在调用 UseMiddleware 之后调用 UseElmahIo 并添加自定义忽略过滤器以忽略最终成为错误请求的错误：

app.UseMiddleware<HandleExceptionMiddleware>();
app.UseElmahIo("API_KEY", new Guid("LOG_ID"), new ElmahIoSettings
{
    OnFilter = msg => msg.Type == typeof(ArgumentException).Name
});

这种方法的缺点是，您需要在 HandleExceptionMiddleware 和 elmah.io 配置中维护一组相似的规则。

解决方案 2

在调用 UseMiddleware 之前调用 UseElmahIo 并指定要记录的状态代码，即使未抛出异常（在本例中被 HandleExceptionMiddleware 吞没）：

app.UseElmahIo("API_KEY", new Guid("LOG_ID"), new ElmahIoSettings
{
    HandledStatusCodesToLog = new List<int> { 404, 500, ... }
});
app.UseMiddleware<HandleExceptionMiddleware>();

这种方法的缺点是，您需要手动指定所有状态代码，并且来自实际抛出的异常的信息在 elmah.io 上不可用。再次这样做的原因是，HandleExceptionMiddleware 使 elmah.io 无法看到抛出的异常。

我个人更喜欢解决方案 1，因为它可以确保捕获所有异常，包括堆栈跟踪和异常类型等信息。

如何使 elmah.io 与 ASP.NET 核心和错误处理中间件一起工作？

How to make elmah.io work well with ASP.NET Core and error handing middleware?

c#

asp.net

elmah

.net-core

asp.net-core