Как использовать ELMAH для регистрации ошибок вручную - PullRequest
Новая
       37

Как использовать ELMAH для регистрации ошибок вручную

256 голосов
/ 16 сентября 2011

Можно ли сделать следующее, используя ELMAH? 

logger.Log(" something");

Я делаю что-то вроде этого: 

try 
{
    // Code that might throw an exception 
}
catch(Exception ex)
{
    // I need to log error here...
}

Это исключение не будет автоматически регистрироваться ELMAH, посколькуэто было обработано.

Ответы [ 8 ]

407 голосов
/ 16 сентября 2011

Метод прямой записи в журнал, работает с ELMAH 1.0: 

try 
{
    some code 
}
catch(Exception ex)
{
    Elmah.ErrorLog.GetDefault(HttpContext.Current).Log(new Elmah.Error(ex));
}

ELMAH 1.2 представляет более гибкий API: 

try 
{
    some code 
}
catch(Exception ex)
{
    Elmah.ErrorSignal.FromCurrentContext().Raise(ex);
}

Существует разница между двумя решениями:

  • Raise метод применяет правила фильтрации ELMAH к исключению. Log метод не.
  • Raise основан на подписке и может регистрировать одно исключение в нескольких регистраторах.
90 голосов
/ 08 февраля 2013

Я бы порекомендовал обернуть вызов в Elmah в свой собственный простой класс-оболочку. 

using Elmah;

public static class ErrorLog
{
    /// <summary>
    /// Log error to Elmah
    /// </summary>
    public static void LogError(Exception ex, string contextualMessage=null)
    {
        try
        {
            // log error to Elmah
            if (contextualMessage != null) 
            {
                // log exception with contextual information that's visible when 
                // clicking on the error in the Elmah log
                var annotatedException = new Exception(contextualMessage, ex); 
                ErrorSignal.FromCurrentContext().Raise(annotatedException, HttpContext.Current);
            }
            else 
            {
                ErrorSignal.FromCurrentContext().Raise(ex, HttpContext.Current);
            }

            // send errors to ErrorWS (my own legacy service)
            // using (ErrorWSSoapClient client = new ErrorWSSoapClient())
            // {
            //    client.LogErrors(...);
            // }
        }
        catch (Exception)
        {
            // uh oh! just keep going
        }
    }
}

Затем просто вызывайте его всякий раз, когда вам нужно зарегистрировать ошибку. 

try {
   ...
} 
catch (Exception ex) 
{
    // log this and continue
    ErrorLog.LogError(ex, "Error sending email for order " + orderID);
}

Это имеет следующие преимущества:

  • Вам не нужно помнить этот слегка архаичный синтаксис вызова Elmah
  • Если у вас много DLL, вам не нужно ссылаться на ElmahЯдро каждого из них - и просто поместите это в свою собственную «Системную» DLL.
  • Если вам когда-нибудь понадобится выполнить какую-либо специальную обработку или просто захотите поставить точку останова для отладки ошибок, у вас все это в одном месте.
  • Если вы когда-нибудь отойдете от Elmah, вы можете просто поменять одно место.
  • Если у вас есть устаревшая регистрация ошибок, которую вы хотите сохранить (у меня просто получился простой механизм регистрации ошибок, который связанв некоторые пользовательские интерфейсы, которые я не могу сразу удалить).

Примечание: я добавил свойство contextualMessage для контекстной информации.Вы можете пропустить это, если хотите, но я считаю это очень полезным.Elmah автоматически разворачивает исключения, поэтому базовое исключение все равно будет отображаться в журнале, но contextualMessage будет отображаться при нажатии на него.

29 голосов
/ 16 сентября 2011

Вы можете использовать метод Elmah.ErrorSignal (), чтобы зарегистрировать проблему, не вызывая исключения. 

try
{
    // Some code
}
catch(Exception ex)
{
    // Log error
    Elmah.ErrorSignal.FromCurrentContext().Raise(ex);

    // Continue
}
19 голосов
/ 16 сентября 2011 
catch(Exception ex)
{
    Elmah.ErrorSignal.FromCurrentContext().Raise(ex);
}
14 голосов
/ 16 сентября 2011

Да, это возможно.ELMAH был разработан для перехвата необработанных исключений.Однако вы можете сообщить об исключении в ELMAH через класс ErrorSignal.Эти исключения не генерируются (не всплывают), а отправляются только ELMAH (и подписчикам события Raise класса ErrorSignal).

Небольшой пример: 

protected void ThrowExceptionAndSignalElmah()
{
    ErrorSignal.FromCurrentContext().Raise(new NotSupportedException());
}
13 голосов
/ 08 августа 2013

Я хотел сделать то же самое в потоке, который я начал помещать в очередь почты из моего приложения MVC4, так как у меня не было HttpContext, доступного, когда возникло исключение.Для этого на основе этого вопроса я получил следующее: elmah: исключения без HttpContext?

В файле конфигурации я указал имя приложения: 

<elmah>
    <security allowRemoteAccess="false" />
    <errorLog type="Elmah.SqlErrorLog, Elmah" connectionStringName="ELMAH" applicationName="myApplication"/>   
</elmah>

Затем в коде (как ответ, приведенный выше, но без HttpContext) вы можете передать значение null вместо HttpContext: 

ThreadPool.QueueUserWorkItem(t => {
     try {
         ...
         mySmtpClient.Send(message);
     } catch (SomeException e) {
         Elmah.ErrorLog.GetDefault(null).Log(new Elmah.Error(e));
     }
 });
3 голосов
/ 26 августа 2016

Иногда CurrentHttpContext может быть недоступно.

Определить 

public class ElmahLogger : ILogger
{
    public void LogError(Exception ex, string contextualMessage = null, bool withinHttpContext = true)
    {
        try
        {
            var exc = contextualMessage == null 
                      ? ex 
                      : new ContextualElmahException(contextualMessage, ex);
            if (withinHttpContext)
                ErrorSignal.FromCurrentContext().Raise(exc);
            else
                ErrorLog.GetDefault(null).Log(new Error(exc));
        }
        catch { }
    }
}

Использование 

public class MyClass
{
    readonly ILogger _logger;

    public MyClass(ILogger logger)
    {
        _logger = logger;
    }

    public void MethodOne()
    {
        try
        {

        }
        catch (Exception ex)
        {
            _logger.LogError(ex, withinHttpContext: false);
        }
    }
}
0 голосов
/ 07 марта 2017

Я пытался записать пользовательские сообщения в журналы elmah, используя Signal.FromCurrentContext (). Raise (ex);и обнаружил, что эти исключения всплывают, например: 

try
{
    ...
}
catch (Exception ex)
{
    Elmah.ErrorSignal.FromCurrentContext().Raise(ex);
    // this will write to the log AND throw the exception
}

Кроме того, я не вижу, как elmah поддерживает разные уровни ведения журнала - возможно ли отключить подробное ведение журнала настройкой web.config?

...