Lý lịch

Tôi đang phát triển Lớp dịch vụ API cho khách hàng và tôi đã được yêu cầu bắt và ghi lại tất cả các lỗi trên toàn cầu.

Vì vậy, trong khi một cái gì đó như một điểm cuối (hoặc hành động) không xác định có thể được xử lý dễ dàng bằng cách sử dụng ELMAH hoặc bằng cách thêm một cái gì đó như thế này vào Global.asax:

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

. . .unhandled lỗi không liên quan đến định tuyến không được ghi lại. Ví dụ:

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

Tôi cũng đã thử thiết lập [HandleError]thuộc tính trên toàn cầu bằng cách đăng ký bộ lọc này:

filters.Add(new HandleErrorAttribute());

Nhưng điều đó cũng không ghi lại tất cả các lỗi.

Vấn đề / câu hỏi

Làm cách nào để chặn các lỗi như lỗi được tạo bằng cách gọi /test ở trên để tôi có thể ghi lại chúng? Có vẻ như câu trả lời này là hiển nhiên, nhưng tôi đã thử mọi cách tôi có thể nghĩ cho đến nay.

Lý tưởng nhất, tôi muốn thêm một số thứ vào việc ghi nhật ký lỗi, chẳng hạn như địa chỉ IP của người dùng yêu cầu, ngày, giờ, v.v. Tôi cũng muốn có thể tự động gửi e-mail cho nhân viên hỗ trợ khi gặp lỗi. Tất cả điều này tôi có thể làm nếu chỉ tôi có thể chặn những lỗi này khi chúng xảy ra!

GIẢI QUYẾT!

Nhờ Darin Dimitrov, người mà tôi đã chấp nhận câu trả lời, tôi đã hiểu ra điều này. WebAPI không xử lý lỗi theo cách tương tự như bộ điều khiển MVC thông thường.

Đây là những gì đã làm việc:

1) Thêm bộ lọc tùy chỉnh vào không gian tên của bạn:

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) Bây giờ hãy đăng ký bộ lọc trên toàn cầu trong lớp 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());
     }
}

HOẶC bạn có thể bỏ qua đăng ký và chỉ trang trí một bộ điều khiển duy nhất với [ExceptionHandling]thuộc tính.

Nếu API web của bạn được lưu trữ bên trong một ứng dụng ASP.NET, Application_Errorsự kiện sẽ được gọi cho tất cả các ngoại lệ chưa được xử lý trong mã của bạn, bao gồm cả ngoại lệ trong hành động kiểm tra mà bạn đã thể hiện. Vì vậy, tất cả những gì bạn phải làm là xử lý ngoại lệ này trong sự kiện Application_Error. Trong mã mẫu bạn đã chỉ ra, bạn chỉ xử lý ngoại lệ của loại HttpExceptionrõ ràng không phải là trường hợp với Convert.ToInt32("a")mã. Vì vậy, hãy chắc chắn rằng bạn đăng nhập và xử lý tất cả các ngoại lệ trong đó:

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
        }
    }
}

Xử lý ngoại lệ trong API Web có thể được thực hiện ở nhiều cấp độ khác nhau. Đây là một detailed articlegiải thích các khả năng khác nhau:

• thuộc tính bộ lọc ngoại lệ tùy chỉnh có thể được đăng ký làm bộ lọc ngoại lệ toàn cầu

  [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"
          });
      }
  }

• kẻ xâm lược hành động tùy chỉnh

  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;
      }
  }

Như một bổ sung cho câu trả lời trước.

Hôm qua, ASP.NET Web API 2.1 đã được phát hành chính thức .
Nó cung cấp một cơ hội khác để xử lý các trường hợp ngoại lệ trên toàn cầu.
Các chi tiết được đưa ra trong mẫu .

Tóm lại, bạn thêm logger ngoại lệ toàn cầu và / hoặc xử lý ngoại lệ toàn cầu (chỉ một).
Bạn thêm chúng vào cấu hình:

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());
}

Và nhận ra của họ:

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);
  }
}

Tại sao lại suy nghĩ vv? Điều này hoạt động và nó sẽ làm cho dịch vụ trở lại trạng thái 500 vv

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);
    }
}

Bạn đã nghĩ về việc làm một cái gì đó như một bộ lọc hành động xử lý lỗi như

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

bạn cũng có thể tạo một phiên bản tùy chỉnh [HandleError]mà bạn có thể viết thông tin lỗi và tất cả các chi tiết khác để đăng nhập

Gói toàn bộ trong một thử / bắt và đăng nhập ngoại lệ chưa xử lý, sau đó chuyển nó vào. Trừ khi có một cách tích hợp tốt hơn để làm điều đó.

Đây là một tham chiếu Catch All (xử lý hoặc chưa xử lý) Ngoại lệ

(chỉnh sửa: oh API)