如何爲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); 
    } 
}