Ведение журнала исключений для служб WCF с использованием ELMAH

Мы используем отличный ELMAH для обработки необработанных исключений в веб-приложении ASP.NET 3.5. Это очень хорошо работает для всего сайта, кроме служб WCF, которые используются с использованием функций REST. Когда в методах операций, которые не обрабатываются кодом приложения, возникает исключение, WCF обрабатывает его различными способами в зависимости от контрактов на обслуживание и параметров конфигурации. Это означает, что исключение не приводит к запуску события ASP.NET HttpApplication.Error, которое используется ELMAH. Два решения, о которых я знаю, касаются этого:

  • Оберните все вызовы методов в try {} catch (Exception ex) {Elmah.ErrorSignal.FromCurrentContext(). Raise (ex); бросить; }, чтобы явно вызвать Elmah в блоке catch.
  • Используйте IErrorHandler, как описано в Will Hughes ' сообщение в блоге Сделать WCF и ELMAH приятными вместе, чтобы отменить вызов ELMAH отдельному ErrorHandler.

Первый вариант чрезвычайно прост, но не совсем DRY. Второй вариант требует, чтобы вы каждый день украшали пользовательский атрибут после реализации атрибута и ErrorHandler. Я сделал это на основе Will, но я хочу проверить, что это правильный подход, прежде чем отправлять код.

Есть ли лучший способ, который я пропустил?

Документация MSDN для IErrorHandler говорит о том, что метод HandleError - это место для ведения журнала, но ELMAH обращается к HttpContext.Current. ApplicationInstance, который является нулевым в этом методе, хотя доступен HttpContext.Current. Выполнение вызова Elmah в методе ProvideFault является обходным путем, поскольку ApplicationInstance установлен, но это не соответствует намерению, описанному в документации API. Я что-то пропустил здесь? В документации указано, что вы не должны полагаться на метод HandleError, вызываемый в потоке операции, и поэтому ApplicationInstance имеет нулевое значение в этой области.

Ответ 1

Решение из моего сообщения в блоге (упоминалось в OP) было основано на существующем решении, которое мы использовали для изменения кодов ответа HTTP во время состояния ошибки.

Итак, для нас это было однострочное изменение, чтобы передать исключение в ELMAH. Если есть лучшее решение, я бы тоже хотел узнать об этом.

Для Posterity/Reference и потенциального улучшения - здесь код из текущего решения.

классы HttpErrorHandler и ServiceErrorBehaviourAttribute

using System;
using System.ServiceModel;
using System.ServiceModel.Dispatcher;
using System.ServiceModel.Channels;
using System.ServiceModel.Description;
using System.Collections.ObjectModel;
using System.Net;
using System.Web;
using Elmah;
namespace YourApplication
{
    /// <summary>
    /// Your handler to actually tell ELMAH about the problem.
    /// </summary>
    public class HttpErrorHandler : IErrorHandler
    {
        public bool HandleError(Exception error)
        {
            return false;
        }

        public void ProvideFault(Exception error, MessageVersion version, ref Message fault)
        {
            if (error != null ) // Notify ELMAH of the exception.
            {
                if (System.Web.HttpContext.Current == null)
                    return;
                Elmah.ErrorSignal.FromCurrentContext().Raise(error);
            }
        }
    }
    /// <summary>
    /// So we can decorate Services with the [ServiceErrorBehaviour(typeof(HttpErrorHandler))]
    /// ...and errors reported to ELMAH
    /// </summary>
    public class ServiceErrorBehaviourAttribute : Attribute, IServiceBehavior
    {
        Type errorHandlerType;

        public ServiceErrorBehaviourAttribute(Type errorHandlerType)
        {
            this.errorHandlerType = errorHandlerType;
        }

        public void Validate(ServiceDescription description, ServiceHostBase serviceHostBase)
        {
        }

        public void AddBindingParameters(ServiceDescription description, ServiceHostBase serviceHostBase, Collection<ServiceEndpoint> endpoints, BindingParameterCollection parameters)
        {
        }

        public void ApplyDispatchBehavior(ServiceDescription description, ServiceHostBase serviceHostBase)
        {
            IErrorHandler errorHandler;
            errorHandler = (IErrorHandler)Activator.CreateInstance(errorHandlerType);
            foreach (ChannelDispatcherBase channelDispatcherBase in serviceHostBase.ChannelDispatchers)
            {
                ChannelDispatcher channelDispatcher = channelDispatcherBase as ChannelDispatcher;
                channelDispatcher.ErrorHandlers.Add(errorHandler);
            }
        }
    }
}

Пример использования

Украсьте свои службы WCF атрибутом ServiceErrorBehaviour:

[ServiceContract(Namespace = "http://example.com/api/v1.0/")]
[ServiceErrorBehaviour(typeof(HttpErrorHandler))]
public class MyServiceService
{
  // ...
}

Ответ 2

При создании элемента BehaviorExtensionElement возможно активировать поведение с помощью config:

public class ErrorBehaviorExtensionElement : BehaviorExtensionElement
{
    public override Type BehaviorType
    {
        get { return typeof(ServiceErrorBehaviourAttribute); }
    }

    protected override object CreateBehavior()
    {
        return new ServiceErrorBehaviourAttribute(typeof(HttpErrorHandler));
    }
}

Config:

<system.serviceModel>
    <extensions>
      <behaviorExtensions>
        <add name="elmah" type="Namespace.ErrorBehaviorExtensionElement, YourAssembly, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"/>
      </behaviorExtensions>
    </extensions>
    <behaviors>
      <serviceBehaviors>
        <behavior>
          <elmah />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>

Таким образом, также можно использовать ELMAH в сочетании с услугами RIA!

Ответ 3

Я сделал это на основе работы Уилла но я хочу проверить, что это правильный подход перед публикацией код.

Я думаю, что это отличный подход (квеста для этой публикации!). Я не думаю, что Уилл или ты пропустили что-нибудь здесь. Реализация IErrorHandler является предпочтительным способом захвата всех возможных исключений на стороне сервера, которые в противном случае могли бы привести к сбою канала связи (снести его) и, таким образом, это естественное место для подключения к некоторым журналам, таким как ELMAH.

Марк

Ответ 4

Это может быть очевидным для некоторых людей, но я просто потратил довольно много времени, пытаясь понять, почему мой HttpContext.Current был нулевым, несмотря на то, что он отлично ответил на все отзывы Уилла Хьюза. Смутно, я понял, что это связано с тем, что моя служба WCF активируется сообщением MSMQ.

Я закончил переписывание метода ProvideFault():

if (HttpContext.Current == null)
{
    ErrorLog.GetDefault(null).Log(new Error(error));
}
else
{
    ErrorSignal.FromCurrentContext().Raise(error);
}

Ответ 5

Мне не удалось получить предложенный ответ с помощью службы данных WCF. Я подключил атрибут поведения и т.д., Но до сих пор не получил ошибок. Вместо этого я включил следующее в реализацию службы:

protected override void HandleException(HandleExceptionArgs args)
{
    Elmah.ErrorSignal.FromCurrentContext().Raise(args.Exception);
    base.HandleException(args);
}

Ответ 6

Я не пробовал делать это явно с элементами REST и сам не использовал ELMAH, но другой вариант, на который стоит обратить внимание, - это подключиться к WCF с помощью IDispatchMessageInspector вместо IErrorHandler.