Как регистрировать все исключения глобально для приложения c# MVC4 WebAPI?

фон

Я разрабатываю уровень сервиса 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-адрес запрашивающего пользователя, дата, время, и так далее. Я также хочу иметь возможность автоматически отправлять по электронной почте вспомогательный персонал при возникновении ошибки. Все это я могу сделать, если только смогу перехватить эти ошибки, когда они происходят!

решено!

благодаря Дарину Димитрову, ответ которого я принял, я понял это. 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());
     }
}

или вы можете пропустить регистрацию и просто украсить один контроллер с .

5 ответов


если ваш веб-API размещен внутри ASP.NET применение,Application_Error событие будет вызвано для всех необработанных исключений в вашем коде, включая одно в показанном вами тестовом действии. Поэтому все, что вам нужно сделать, это обработать это исключение внутри событий application_error. В показанном примере кода обрабатывается только исключение типа HttpException что, очевидно, не относится к Convert.ToInt32("a") код. Поэтому убедитесь, что вы регистрируете и обрабатываете все исключения в там:

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

обработка исключений в веб-API может выполняться на разных уровнях. Вот 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"
            });
        }
    }
    
  • пользовательское действие invoker

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

в дополнение к предыдущим ответам.

вчера, ASP.NET Web API 2.1 был официально освобожден.
Это дает еще одну возможность обрабатывать исключения глобально.
Подробности приведены в пример.

вкратце, вы добавляете глобальные регистраторы исключений и / или глобальный обработчик исключений (только один).
Вы добавляете их в конфигурацию:

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

почему rethrow etc? Это работает и это сделает статус возврат 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);
    }
}

вы думали о том, чтобы сделать что-то вроде фильтра действий ошибки дескриптора, например

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

вы также можете создать пользовательскую версию [HandleError] С помощью которого вы можете записать информацию об ошибке и все другие данные для входа


оберните все это в try / catch и зарегистрируйте необработанное исключение, а затем передайте его. Если есть встроенный способ сделать это.

вот ссылка поймать все (обработанные или необработанные) исключения

(edit: oh API)