Latar Belakang

Saya mengembangkan Lapisan Layanan API untuk klien dan saya telah diminta untuk menangkap dan mencatat semua kesalahan secara global.

Jadi, sementara sesuatu seperti titik akhir yang tidak diketahui (atau tindakan) mudah ditangani dengan menggunakan ELMAH atau dengan menambahkan sesuatu seperti ini ke Global.asax:

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

. . Kesalahan .unhandled yang tidak terkait dengan perutean tidak bisa login. Sebagai contoh:

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

Saya juga telah mencoba mengatur [HandleError]atribut secara global dengan mendaftarkan filter ini:

filters.Add(new HandleErrorAttribute());

Tapi itu juga tidak mencatat semua kesalahan.

Masalah / pertanyaan

Bagaimana cara mencegat kesalahan seperti yang dihasilkan oleh panggilan di /testatas sehingga saya bisa mencatatnya? Tampaknya jawaban ini harus jelas, tetapi saya telah mencoba semua yang dapat saya pikirkan sejauh ini.

Idealnya, saya ingin menambahkan beberapa hal ke log kesalahan, seperti alamat IP pengguna yang meminta, tanggal, waktu, dan sebagainya. Saya juga ingin dapat mengirim email kepada staf pendukung secara otomatis ketika kesalahan terjadi. Semua ini bisa saya lakukan seandainya saya bisa mencegat kesalahan ini ketika itu terjadi!

TERSELESAIKAN!

Terima kasih kepada Darin Dimitrov, yang jawabannya saya terima, saya mengerti hal ini. WebAPI tidak menangani kesalahan dengan cara yang sama seperti pengontrol MVC biasa.

Inilah yang berhasil:

1) Tambahkan filter khusus ke namespace Anda:

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) Sekarang daftarkan filter secara global di kelas 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());
     }
}

ATAU Anda dapat melewati pendaftaran dan hanya menghiasi satu pengontrol dengan [ExceptionHandling]atribut.

Jika API web Anda di-host di dalam aplikasi ASP.NET, Application_Erroracara tersebut akan dipanggil untuk semua pengecualian yang tidak ditangani dalam kode Anda, termasuk yang ada dalam tindakan uji yang telah Anda tunjukkan. Jadi yang harus Anda lakukan adalah menangani pengecualian ini di dalam acara Application_Error. Dalam kode sampel yang telah Anda tunjukkan, Anda hanya menangani pengecualian tipe HttpExceptionyang jelas tidak demikian dengan Convert.ToInt32("a")kode tersebut. Jadi pastikan Anda masuk dan menangani semua pengecualian di sana:

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

Penanganan pengecualian di API Web dapat dilakukan di berbagai tingkatan. Berikut ini detailed articlepenjelasan berbagai kemungkinan:

• atribut filter pengecualian khusus yang dapat didaftarkan sebagai filter pengecualian 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"
          });
      }
  }

• penyerbu tindakan khusus

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

Sebagai tambahan untuk jawaban sebelumnya.

Kemarin, ASP.NET Web API 2.1 secara resmi dirilis .
Ini menawarkan kesempatan lain untuk menangani pengecualian secara global.
Rinciannya diberikan dalam sampel .

Secara singkat, Anda menambahkan log pengecualian global dan / atau handler pengecualian global (hanya satu).
Anda menambahkannya ke konfigurasi:

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

Dan realisasinya:

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

Mengapa rethrow dll? Ini berfungsi dan itu akan membuat status pengembalian layanan 500 dll

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

pernahkah Anda berpikir untuk melakukan sesuatu seperti filter tindakan penanganan kesalahan

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

Anda juga dapat membuat versi khusus untuk [HandleError]menulis info kesalahan dan semua detail lainnya untuk dicatat

Bungkus semuanya dengan mencoba / menangkap dan mencatat pengecualian yang tidak tertangani, kemudian meneruskannya. Kecuali ada cara built-in yang lebih baik untuk melakukannya.

Berikut referensi Pengecualian Catch All (ditangani atau tidak ditangani)

(edit: oh API)