如何为C＃MVC4 WebAPI应用程序全局记录所有异常？

Question

背景

我正在为客户端开发API服务层，并且我被要求捕获并记录全局错误。

因此，尽管像一个未知的终结点（或行为）很容易通过使用ELMAH或通过添加像这样的Global.asax处理：

protected void Application_Error() 
{ 
    Exception unhandledException = Server.GetLastError(); 
    //do more stuff 
} 

。 。与路由无关的未处理的错误不会被记录。例如：

public class ReportController : ApiController 
{ 
    public int test() 
    { 
     var foo = Convert.ToInt32("a");//Will throw error but isn't logged!! 
     return foo; 
    } 
} 

我自己也尝试通过注册该过滤器全局设置[HandleError]属性：

filters.Add(new HandleErrorAttribute()); 

但也不会记录所有的错误。

问题/疑问

如何截取喜欢通过调用/test上面，这样我就可以登录他们产生一个错误？看起来这个答案应该是显而易见的，但我已经尝试了迄今为止我能想到的一切。

理想情况下，我想添加一些东西到错误日志记录中，例如请求用户的IP地址，日期，时间等等。我也希望能够在遇到错误时自动发送电子邮件给支持人员。所有这些我都可以做，只要我能在发生这些错误时拦截这些错误！

已解决！

感谢Darin Dimitrov，我接受了他的回答，我弄明白了。 WebAPI不会不是以与常规MVC控制器相同的方式处理错误。

这里是什么工作：

1）添加自定义过滤器，您的命名空间：

public class ExceptionHandlingAttribute : ExceptionFilterAttribute 
{ 
    public override void OnException(HttpActionExecutedContext context) 
    { 
     if (context.Exception is BusinessException) 
     { 
      throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.InternalServerError) 
      { 
       Content = new StringContent(context.Exception.Message), 
       ReasonPhrase = "Exception" 
      }); 

     } 

     //Log Critical errors 
     Debug.WriteLine(context.Exception); 

     throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.InternalServerError) 
     { 
      Content = new StringContent("An error occurred, please try again or contact the administrator."), 
      ReasonPhrase = "Critical Exception" 
     }); 
    } 
} 

2）现在全球注册过滤器在WebApiConfig类：

public static class WebApiConfig 
{ 
    public static void Register(HttpConfiguration config) 
    { 
     config.Routes.MapHttpRoute("DefaultApi", "api/{controller}/{action}/{id}", new { id = RouteParameter.Optional }); 
     config.Filters.Add(new ExceptionHandlingAttribute()); 
    } 
} 

或你可以跳过注册，只是装饰一个单控制器与[ExceptionHandling]属性。

Answer 1

如果您的Web API托管在ASP.NET应用程序中，将调用代码中所有未处理的异常（包括您在测试操作中显示的异常）中的 Application_Error事件。所以你所要做的就是在Application_Error事件中处理这个异常。在示例代码中，您显示的只是处理 HttpException类型的异常，而 Convert.ToInt32("a")代码显然不是这种情况。因此，请确保您登录和处理所有异常在那里：在Web API中

protected void Application_Error() 
{ 
    Exception unhandledException = Server.GetLastError(); 
    HttpException httpException = unhandledException as HttpException; 
    if (httpException == null) 
    { 
     Exception innerException = unhandledException.InnerException; 
     httpException = innerException as HttpException; 
    } 

    if (httpException != null) 
    { 
     int httpCode = httpException.GetHttpCode(); 
     switch (httpCode) 
     { 
      case (int)HttpStatusCode.Unauthorized: 
       Response.Redirect("/Http/Error401"); 
       break; 

      // TODO: don't forget that here you have many other status codes to test 
      // and handle in addition to 401. 
     } 
     else 
     { 
      // It was not an HttpException. This will be executed for your test action. 
      // Here you should log and handle this case. Use the unhandledException instance here 
     } 
    } 
} 

异常处理可在各级进行。这里有一个detailed article解释不同的可能性：这可以被注册为一个全球性的异常过滤器

• 自定义异常筛选器属性

  [AttributeUsage(AttributeTargets.All)] 
  public class ExceptionHandlingAttribute : ExceptionFilterAttribute 
  { 
      public override void OnException(HttpActionExecutedContext context) 
      { 
       if (context.Exception is BusinessException) 
       { 
        throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.InternalServerError) 
        { 
         Content = new StringContent(context.Exception.Message), 
         ReasonPhrase = "Exception" 
        }); 
       } 
  
       //Log Critical errors 
       Debug.WriteLine(context.Exception); 
  
       throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.InternalServerError) 
       { 
        Content = new StringContent("An error occurred, please try again or contact the administrator."), 
        ReasonPhrase = "Critical Exception" 
       }); 
      } 
  } 
  

• 自定义操作调用

  public class MyApiControllerActionInvoker : ApiControllerActionInvoker 
  { 
      public override Task<HttpResponseMessage> InvokeActionAsync(HttpActionContext actionContext, System.Threading.CancellationToken cancellationToken) 
      { 
       var result = base.InvokeActionAsync(actionContext, cancellationToken); 
  
       if (result.Exception != null && result.Exception.GetBaseException() != null) 
       { 
        var baseException = result.Exception.GetBaseException(); 
  
        if (baseException is BusinessException) 
        { 
         return Task.Run<HttpResponseMessage>(() => new HttpResponseMessage(HttpStatusCode.InternalServerError) 
         { 
          Content = new StringContent(baseException.Message), 
          ReasonPhrase = "Error" 
  
         }); 
        } 
        else 
        { 
         //Log critical error 
         Debug.WriteLine(baseException); 
  
         return Task.Run<HttpResponseMessage>(() => new HttpResponseMessage(HttpStatusCode.InternalServerError) 
         { 
          Content = new StringContent(baseException.Message), 
          ReasonPhrase = "Critical Error" 
         }); 
        } 
       } 
  
       return result; 
      } 
  } 
  

Answer 2

将整个事情包装在try/catch中并记录未处理的异常，然后传递它。除非有更好的内置方式来做到这一点。

这里有一个参考Catch All (handled or unhandled) Exceptions

（编辑：哦API）

Answer 3

你有没有想过做这样的处理错误行为过滤像

[HandleError] 
public class BaseController : Controller {...} 

，你还可以创建一个自定义版本[HandleError]与您可以写错误信息和所有其他详细信息登录

Answer 4

为什么重新抛出等？这个工作，它会使服务返回状态500等

public class LogExceptionFilter : ExceptionFilterAttribute 
{ 
    private static readonly ILog log = LogManager.GetLogger(typeof (LogExceptionFilter)); 

    public override void OnException(HttpActionExecutedContext actionExecutedContext) 
    { 
     log.Error("Unhandeled Exception", actionExecutedContext.Exception); 
     base.OnException(actionExecutedContext); 
    } 
} 

Answer 5

作为以前答案的补充。

昨天，ASP.NET Web API 2.1被破解为released。
它为全球处理异常提供了另一个机会。
详细信息请参见sample。

简而言之，您将添加全局异常记录器和/或全局异常处理程序（仅一个）。
将它们添加到配置：

public static void Register(HttpConfiguration config) 
{ 
    config.MapHttpAttributeRoutes(); 

    // There can be multiple exception loggers. 
    // (By default, no exception loggers are registered.) 
    config.Services.Add(typeof(IExceptionLogger), new ElmahExceptionLogger()); 

    // There must be exactly one exception handler. 
    // (There is a default one that may be replaced.) 
    config.Services.Replace(typeof(IExceptionHandler), new GenericTextExceptionHandler()); 
} 

及其实现途径：

public class ElmahExceptionLogger : ExceptionLogger 
{ 
    public override void Log(ExceptionLoggerContext context) 
    { 
    ... 
    } 
} 

public class GenericTextExceptionHandler : ExceptionHandler 
{ 
    public override void Handle(ExceptionHandlerContext context) 
    { 
    context.Result = new InternalServerErrorTextPlainResult(
     "An unhandled exception occurred; check the log for more information.", 
     Encoding.UTF8, 
     context.Request); 
    } 
}