fundo

Estou desenvolvendo uma camada de serviço de API para um cliente e fui solicitado a capturar e registrar todos os erros globalmente.

Portanto, enquanto algo como um terminal (ou ação) desconhecido é facilmente manipulado usando o ELMAH ou adicionando algo como isto ao Global.asax:

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

. . Os erros não manipulados que não estão relacionados ao roteamento não são registrados. Por exemplo:

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

Eu também tentei definir o [HandleError]atributo globalmente registrando este filtro:

filters.Add(new HandleErrorAttribute());

Mas isso também não registra todos os erros.

Problema / Pergunta

Como intercepto erros como o gerado pela chamada /testacima para que eu possa registrá-los? Parece que essa resposta deve ser óbvia, mas eu tentei tudo o que consigo pensar até agora.

Idealmente, quero adicionar algumas coisas ao log de erros, como o endereço IP do usuário solicitante, data, hora e assim por diante. Também quero poder enviar um e-mail para a equipe de suporte automaticamente quando um erro for encontrado. Tudo isso eu posso fazer se eu puder interceptar esses erros quando eles acontecerem!

RESOLVIDO!

Graças a Darin Dimitrov, cuja resposta eu aceitei, resolvi isso. O WebAPI não trata erros da mesma maneira que um controlador MVC comum.

Aqui está o que funcionou:

1) Adicione um filtro personalizado ao seu espaço para nome:

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) Agora registre o filtro globalmente na classe 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());
     }
}

OU você pode pular o registro e apenas decorar um único controlador com o [ExceptionHandling]atributo

Se sua API da web estiver hospedada em um aplicativo ASP.NET, o Application_Errorevento será chamado para todas as exceções não tratadas em seu código, incluindo a ação de teste que você mostrou. Portanto, tudo o que você precisa fazer é lidar com essa exceção dentro do evento Application_Error. No código de exemplo que você mostrou, você está manipulando apenas a exceção do tipo HttpExceptionque obviamente não é o caso do Convert.ToInt32("a")código. Portanto, certifique-se de registrar e manipular todas as exceções nele:

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

O tratamento de exceções na API da Web pode ser feito em vários níveis. Aqui está uma detailed articleexplicação das diferentes possibilidades:

• atributo de filtro de exceção personalizado que pode ser registrado como um filtro de exceção global

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

• invocador de ação personalizada

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

Como complemento às respostas anteriores.

Ontem, o ASP.NET Web API 2.1 foi lançado oficialmente .
Oferece outra oportunidade para lidar com exceções globalmente.
Os detalhes são dados na amostra .

Resumidamente, você adiciona registradores de exceções globais e / ou manipulador de exceções globais (apenas um).
Você os adiciona à configuração:

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

E sua realização:

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

Por que relançar etc? Isso funciona e fará com que o serviço retorne o status 500 etc

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

você já pensou em fazer algo como um filtro de ação de erro de manipulação como

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

você também pode criar uma versão personalizada [HandleError]com a qual pode gravar informações de erro e todos os outros detalhes para registrar

Embrulhe a coisa toda em uma tentativa / captura e registre a exceção não tratada e depois a repasse. A menos que haja uma maneira integrada melhor de fazer isso.

Aqui está uma referência Capturar todas (manipuladas ou não) Exceções

(editar: oh API)