如何使ELMAH与ASP.NET MVC [HandleError]属性配合使用?


564

我正在尝试使用ELMAH在ASP.NET MVC应用程序中记录错误,但是,当我在控制器上使用[HandleError]属性时,ELMAH不会在发生错误时记录任何错误。

正如我所猜测的那样,因为ELMAH仅记录未处理的错误,并且[HandleError]属性正在处理错误,因此无需记录它。

如何修改或如何修改属性,以便ELMAH知道有错误并记录下来。

编辑:让我确保每个人都明白,我知道我可以修改属性,那不是我要问的问题...使用handleerror属性时,ELMAH被绕过,这意味着它不会看到错误,因为它已被处理已经在属性中了...我要问的是有一种方法可以使ELMAH看到错误并记录下来,即使该属性已将其记录下来...我四处搜寻,没有看到任何方法来强制将其记录下来错误....


12
哇,我希望Jeff或Jared可以回答这个问题。他们使用ELMAH进行Stackoverflow;)
Jon Limjap 09年

11
嗯,很奇怪-我们不使用HandleErrorAttribute-在我们的web.config的<modules>部分中设置了Elmah。使用HandleErrorAttribute有好处吗?
贾罗德·迪克森

9
@Jarrod-很高兴看到您的ELMAH前叉有什么“习惯”。
Scott Hanselman

3
@dswatik您还可以通过在web.config中将redirectMode设置为ResponseRewrite来防止重定向。参见blog.turlov.com/2009/01/…–
Pavel

6
我一直在浏览Web文档,并发表有关[HandleError]属性和Elmah的文章,但是在设置虚拟案例时,我没有看到解决的行为(例如Elmah未记录“处理的”错误)。这是因为从Elmah.MVC 2.0.x开始,不再需要此自定义HandleErrorAttribute。它包含在nuget软件包中。
plyawn 2012年

Answers:


503

您可以继承HandleErrorAttribute并覆盖其OnException成员(无需复制),以便仅在基本实现对其进行处理的情况下,才使用ELMAH记录异常。您所需的最少代码量如下:

using System.Web.Mvc;
using Elmah;

public class HandleErrorAttribute : System.Web.Mvc.HandleErrorAttribute
{
    public override void OnException(ExceptionContext context)
    {
        base.OnException(context);
        if (!context.ExceptionHandled) 
            return;
        var httpContext = context.HttpContext.ApplicationInstance.Context;
        var signal = ErrorSignal.FromContext(httpContext);
        signal.Raise(context.Exception, httpContext);
    }
}

首先调用基本实现,使其有机会将异常标记为已处理。只有这样,才会发出异常信号。上面的代码很简单,如果在HttpContext无法使用的环境(例如测试)中使用,可能会引起问题。结果,您将需要更具防御性的代码(以稍微更长的时间为代价):

using System.Web;
using System.Web.Mvc;
using Elmah;

public class HandleErrorAttribute : System.Web.Mvc.HandleErrorAttribute
{
    public override void OnException(ExceptionContext context)
    {
        base.OnException(context);
        if (!context.ExceptionHandled       // if unhandled, will be logged anyhow
            || TryRaiseErrorSignal(context) // prefer signaling, if possible
            || IsFiltered(context))         // filtered?
            return;

        LogException(context);
    }

    private static bool TryRaiseErrorSignal(ExceptionContext context)
    {
        var httpContext = GetHttpContextImpl(context.HttpContext);
        if (httpContext == null)
            return false;
        var signal = ErrorSignal.FromContext(httpContext);
        if (signal == null)
            return false;
        signal.Raise(context.Exception, httpContext);
        return true;
    }

    private static bool IsFiltered(ExceptionContext context)
    {
        var config = context.HttpContext.GetSection("elmah/errorFilter")
                        as ErrorFilterConfiguration;

        if (config == null)
            return false;

        var testContext = new ErrorFilterModule.AssertionHelperContext(
                              context.Exception, 
                              GetHttpContextImpl(context.HttpContext));
        return config.Assertion.Test(testContext);
    }

    private static void LogException(ExceptionContext context)
    {
        var httpContext = GetHttpContextImpl(context.HttpContext);
        var error = new Error(context.Exception, httpContext);
        ErrorLog.GetDefault(httpContext).Log(error);
    }

    private static HttpContext GetHttpContextImpl(HttpContextBase context)
    {
        return context.ApplicationInstance.Context;
    }
}

第二个版本将首先尝试使用来自ELMAH的错误信号,该错误信号涉及完全配置的管道,例如日志记录,邮件,过滤以及您所拥有的内容。如果失败,它将尝试查看是否应过滤错误。如果不是,则仅记录错误。此实现不处理邮件通知。如果可以发出异常信号,则将配置为发送邮件。

您可能还必须注意,如果多个HandleErrorAttribute实例有效,则不会发生重复的日志记录,但是上面的两个示例应该可以使您入门。


1
优秀的。我根本没有尝试实施Elmah。我只是试图以一种可以与MVC很好地配合使用的方式来报告自己使用了多年的错误报告。您的代码给了我一个起点。+1
史蒂夫·沃瑟姆

18
您不需要子类HandleErrorAttribute。您可以简单地使用IExceptionFilter实现,并将其与HandleErrorAttribute一起注册。另外我不明白为什么要在ErrorSignal.Raise(..)失败的情况下进行回退。如果管道配置不正确,则应将其修复。对于5衬垫个IExceptionFilter检查点4,在这里- ivanz.com/2011/05/08/...
伊万·勒蒂文

5
请您对@IvanZlatev在以下适用性,缺点等方面的答案发表评论。人们评论说,它更容易/更简短/更简单,并且与您的答案相同,因此应标记为正确答案。对此有您的看法,并通过这些答案获得一定的清晰度,将是很好的。
2012年

7
这是否仍然相关或ELMAH.MVC是否可以处理?
Romias 2014年

2
甚至我也想知道它在今天的版本中是否仍然
重构

299

抱歉,但我认为已被接受的答案太过分了。您需要做的就是:

public class ElmahHandledErrorLoggerFilter : IExceptionFilter
{
    public void OnException (ExceptionContext context)
    {
        // Log only handled exceptions, because all other will be caught by ELMAH anyway.
        if (context.ExceptionHandled)
            ErrorSignal.FromCurrentContext().Raise(context.Exception);
    }
}

然后在Global.asax.cs中注册它(顺序很重要):

public static void RegisterGlobalFilters (GlobalFilterCollection filters)
{
    filters.Add(new ElmahHandledErrorLoggerFilter());
    filters.Add(new HandleErrorAttribute());
}

3
+1非常好,无需扩展HandleErrorAttribute,无需覆盖OnExceptionon BaseController。这是公认的答案。
CallMeLaNN 2011年

1
@bigb我认为您必须将异常包装在您自己的异常类型中,以将内容附加到异常消息等(例如new UnhandledLoggedException(Exception thrown)Message在返回异常之前将其附加到内容之前。)
Ivan Zlatev 2011年

23
Atif Aziz创建了ELMAH,我会回答他的问题
jamiebarrow

48
@jamiebarrow我没有意识到这一点,但是他的回答是2岁左右,可能已经简化了API,以一种更短距离,更独立的方式支持问题的用例。
伊万·兹拉捷夫

6
@Ivan Zlatev真的无法上班,ElmahHandledErrorLoggerFilter()只是记录未处理的错误,但未处理。正如您提到的,我以正确的顺序注册了过滤器,有什么想法吗?
kuncevic.dev 2011年

14

NuGet中现在有一个ELMAH.MVC软件包,其中包括Atif改进的解决方案以及一个控制器,该控制器处理MVC路由中的elmah接口(不再需要使用该axd)
该解决方案的问题(以及此处的所有解决方案) )是Elmah错误处理程序实际上以某种方式处理错误,而忽略了您可能要设置为customError标记或通过ErrorHandler或您自己的错误处理程序设置的内容
恕我直言,最好的解决方案是创建一个过滤器,该过滤器将在所有其他过滤器的末尾起作用,并记录已处理的事件。elmah模块应注意记录应用程序未处理的其他错误。这也将允许您使用运行状况监视器以及可以添加到asp.net的所有其他模块来查看错误事件。

我在elmah.mvc中的ErrorHandler上使用反射器编写了此外观

public class ElmahMVCErrorFilter : IExceptionFilter
{
   private static ErrorFilterConfiguration _config;

   public void OnException(ExceptionContext context)
   {
       if (context.ExceptionHandled) //The unhandled ones will be picked by the elmah module
       {
           var e = context.Exception;
           var context2 = context.HttpContext.ApplicationInstance.Context;
           //TODO: Add additional variables to context.HttpContext.Request.ServerVariables for both handled and unhandled exceptions
           if ((context2 == null) || (!_RaiseErrorSignal(e, context2) && !_IsFiltered(e, context2)))
           {
            _LogException(e, context2);
           }
       }
   }

   private static bool _IsFiltered(System.Exception e, System.Web.HttpContext context)
   {
       if (_config == null)
       {
           _config = (context.GetSection("elmah/errorFilter") as ErrorFilterConfiguration) ?? new ErrorFilterConfiguration();
       }
       var context2 = new ErrorFilterModule.AssertionHelperContext((System.Exception)e, context);
       return _config.Assertion.Test(context2);
   }

   private static void _LogException(System.Exception e, System.Web.HttpContext context)
   {
       ErrorLog.GetDefault((System.Web.HttpContext)context).Log(new Elmah.Error((System.Exception)e, (System.Web.HttpContext)context));
   }


   private static bool _RaiseErrorSignal(System.Exception e, System.Web.HttpContext context)
   {
       var signal = ErrorSignal.FromContext((System.Web.HttpContext)context);
       if (signal == null)
       {
           return false;
       }
       signal.Raise((System.Exception)e, (System.Web.HttpContext)context);
       return true;
   }
}

现在,在过滤器配置中,您想要执行以下操作:

    public static void RegisterGlobalFilters(GlobalFilterCollection filters)
    {
        //These filters should go at the end of the pipeline, add all error handlers before
        filters.Add(new ElmahMVCErrorFilter());
    }

请注意,我在此处留下了一条评论,以提醒人们,如果他们想添加一个将实际处理异常的全局过滤器,则应在最后一个过滤器之前进行处理,否则您将遇到ElmahMVCErrorFilter会忽略未处理的异常的情况,因为它尚未被处理,应该由Elmah模块记录下来,但是下一个过滤器会将异常标记为已处理,模块将忽略它,从而导致该异常永远不会变成elmah。

现在,确保您的webconfig中elmah的应用程序设置如下所示:

<add key="elmah.mvc.disableHandler" value="false" /> <!-- This handles elmah controller pages, if disabled elmah pages will not work -->
<add key="elmah.mvc.disableHandleErrorFilter" value="true" /> <!-- This uses the default filter for elmah, set to disabled to use our own -->
<add key="elmah.mvc.requiresAuthentication" value="false" /> <!-- Manages authentication for elmah pages -->
<add key="elmah.mvc.allowedRoles" value="*" /> <!-- Manages authentication for elmah pages -->
<add key="elmah.mvc.route" value="errortracking" /> <!-- Base route for elmah pages -->

这里重要的是“ elmah.mvc.disableHandleErrorFilter”,如果为false,它将使用elmah.mvc内部的处理程序,该处理程序将通过使用默认的HandleErrorHandler来实际处理异常,该处理程序将忽略您的customError设置

通过此设置,您可以在类和视图中设置自己的ErrorHandler标记,同时仍然通过ElmahMVCErrorFilter记录这些错误,甚至通过elmah模块将customError配置添加到web.config中,甚至编写自己的错误处理程序。您唯一需要做的就是记住,在我们编写的Elmah过滤器之前,不要添加任何将实际处理错误的过滤器。我忘了提:Elmah中没有重复品。


7

您可以采用上面的代码,并通过引入一个自定义控制器工厂来进一步前进,该工厂将HandleErrorWithElmah属性注入到每个控制器中。

有关更多信息,请查看我有关登录MVC的博客系列。第一篇文章介绍如何为MVC设置和运行Elmah。

本文末尾有指向可下载代码的链接。希望能有所帮助。

http://dotnetdarren.wordpress.com/


6
在我看来,将其粘贴在基本控制器类上会容易得多!
内森·泰勒

2
上面关于日志和异常处理的Darren系列非常值得一读!!!很彻底!
瑞安·安德森

6

我是ASP.NET MVC的新手。我遇到了同样的问题,以下是我在Erorr.vbhtml中可用的方法(如果您只需要使用Elmah日志记录错误,则可以使用)

@ModelType System.Web.Mvc.HandleErrorInfo

    @Code
        ViewData("Title") = "Error"
        Dim item As HandleErrorInfo = CType(Model, HandleErrorInfo)
        //To log error with Elmah
        Elmah.ErrorLog.GetDefault(HttpContext.Current).Log(New Elmah.Error(Model.Exception, HttpContext.Current))
    End Code

<h2>
    Sorry, an error occurred while processing your request.<br />

    @item.ActionName<br />
    @item.ControllerName<br />
    @item.Exception.Message
</h2> 

很简单!


到目前为止,这是最简单的解决方案。无需编写或注册自定义处理程序和东西。对我来说
效果

3
对于任何JSON /非HTML响应,将被忽略。
Craig Stuntz

6
这也是在视图中执行服务级别的功能。不属于这里。
Trevor de Koekkoek

6

完全替代的解决方案是不使用MVC HandleErrorAttribute,而是依靠Elmah设计用来处理的ASP.Net错误处理。

您需要HandleErrorAttribute从App_Start \ FilterConfig(或Global.asax)中删除默认的全局变量,然后在Web.config中设置一个错误页面:

<customErrors mode="RemoteOnly" defaultRedirect="~/error/" />

请注意,这可以是MVC路由的URL,因此ErrorController.Index发生错误时,上面的内容将重定向到操作。


这是迄今为止最简单的解决方案,默认重定向可以是MVC操作:)
Jeremy Cook

3
这将重定向到其他类型的请求,例如JSON等-不好。
zvolkov 2014年

5

对我来说,使电子邮件记录正常工作非常重要。一段时间后,我发现在Atif示例中,这仅需要多两行代码。

public class HandleErrorWithElmahAttribute : HandleErrorAttribute
{
    static ElmahMVCMailModule error_mail_log = new ElmahMVCMailModule();

    public override void OnException(ExceptionContext context)
    {
        error_mail_log.Init(HttpContext.Current.ApplicationInstance);
        [...]
    }
    [...]
}

我希望这会帮助某人:)


2

这正是我的MVC站点配置所需要的!

正如Atif Aziz所建议的,我对OnException方法进行了一些修改以处理多个HandleErrorAttribute实例:

请记住,您可能必须注意,如果多个HandleErrorAttribute实例有效,则不会发生重复日志记录。

我只是context.ExceptionHandled在调用基类之前检查一下,只是想知道是否有人在当前处理程序之前处理了异常。
它对我有用,如果有人需要它,我会发布代码,并询问是否有人知道我是否忽略了任何内容。

希望它是有用的:

public override void OnException(ExceptionContext context)
{
    bool exceptionHandledByPreviousHandler = context.ExceptionHandled;

    base.OnException(context);

    Exception e = context.Exception;
    if (exceptionHandledByPreviousHandler
        || !context.ExceptionHandled  // if unhandled, will be logged anyhow
        || RaiseErrorSignal(e)        // prefer signaling, if possible
        || IsFiltered(context))       // filtered?
        return;

    LogException(e);
}

您似乎在调用base.OnException()时没有“ if”语句。并且(exceptionHandledByPreviousHandler ||!context.ExceptionHandled || ...)相互抵消,并且始终为true。我想念什么吗?
joelvh 2011年

首先,我检查在当前事件之前调用的其他任何Handler是否管理了该异常,并将结果存储在变量中:exceptionHandlerdByPreviousHandler。然后,我给当前处理程序一个机会来管理异常本身:base.OnException(context)。
ilmatte 2011年

首先,我检查在当前事件之前调用的其他任何Handler是否管理了该异常,并将结果存储在变量中:exceptionHandlerdByPreviousHandler。然后,我给当前处理程序一个机会来管理异常本身:base.OnException(context)。如果异常先前未得到管理,则可以是:1-由当前处理程序管理,然后:exceptionHandledByPreviousHandler = false和!context.ExceptionHandled = false 2-不由当前处理程序管理:ExceptionHandledByPreviousHandler = false和!context。 ExceptionHandled为true。只有情况1会记录。
ilmatte 2011年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.