Add more Exception details to failed messages.

NimbusAPI · Feb 13, 2014 · 43c30b9 · 43c30b9
1 parent 996ffc3
commit 43c30b9
Show file tree

Hide file tree

Showing 13 changed files with 73 additions and 35 deletions.
diff --git a/src/Nimbus/Infrastructure/Commands/CommandMessagePumpsFactory.cs b/src/Nimbus/Infrastructure/Commands/CommandMessagePumpsFactory.cs
@@ -15,20 +15,23 @@ internal class CommandMessagePumpsFactory : ICreateComponents
         private readonly ICommandBroker _commandBroker;
         private readonly DefaultBatchSizeSetting _defaultBatchSize;
         private readonly INimbusMessagingFactory _messagingFactory;
+        private readonly IClock _clock;
 
         private readonly GarbageMan _garbageMan = new GarbageMan();
 
         public CommandMessagePumpsFactory(ILogger logger,
                                           CommandHandlerTypesSetting commandHandlerTypes,
                                           ICommandBroker commandBroker,
                                           DefaultBatchSizeSetting defaultBatchSize,
-                                          INimbusMessagingFactory messagingFactory)
+                                          INimbusMessagingFactory messagingFactory,
+                                          IClock clock)
         {
             _logger = logger;
             _commandHandlerTypes = commandHandlerTypes;
             _commandBroker = commandBroker;
             _defaultBatchSize = defaultBatchSize;
             _messagingFactory = messagingFactory;
+            _clock = clock;
         }
 
         public IEnumerable<IMessagePump> CreateAll()
@@ -51,7 +54,7 @@ public IEnumerable<IMessagePump> CreateAll()
                 var dispatcher = new CommandMessageDispatcher(_commandBroker, commandType);
                 _garbageMan.Add(dispatcher);
 
-                var pump = new MessagePump(messageReceiver, dispatcher, _logger, _defaultBatchSize);
+                var pump = new MessagePump(messageReceiver, dispatcher, _logger, _defaultBatchSize, _clock);
                 _garbageMan.Add(pump);
 
                 yield return pump;

diff --git a/src/Nimbus/Infrastructure/Events/CompetingEventMessagePumpsFactory.cs b/src/Nimbus/Infrastructure/Events/CompetingEventMessagePumpsFactory.cs
@@ -17,6 +17,7 @@ internal class CompetingEventMessagePumpsFactory : ICreateComponents
         private readonly ILogger _logger;
         private readonly DefaultBatchSizeSetting _defaultBatchSize;
         private readonly INimbusMessagingFactory _messagingFactory;
+        private readonly IClock _clock;
 
         private readonly GarbageMan _garbageMan = new GarbageMan();
 
@@ -25,14 +26,16 @@ internal class CompetingEventMessagePumpsFactory : ICreateComponents
                                                  ICompetingEventBroker competingEventBroker,
                                                  ILogger logger,
                                                  DefaultBatchSizeSetting defaultBatchSize,
-                                                 INimbusMessagingFactory messagingFactory)
+                                                 INimbusMessagingFactory messagingFactory,
+                                                 IClock clock)
         {
             _applicationName = applicationName;
             _competingEventHandlerTypes = competingEventHandlerTypes;
             _competingEventBroker = competingEventBroker;
             _logger = logger;
             _defaultBatchSize = defaultBatchSize;
             _messagingFactory = messagingFactory;
+            _clock = clock;
         }
 
         public IEnumerable<IMessagePump> CreateAll()
@@ -56,7 +59,7 @@ public IEnumerable<IMessagePump> CreateAll()
                 var dispatcher = new CompetingEventMessageDispatcher(_competingEventBroker, eventType);
                 _garbageMan.Add(dispatcher);
 
-                var pump = new MessagePump(receiver, dispatcher, _logger, _defaultBatchSize);
+                var pump = new MessagePump(receiver, dispatcher, _logger, _defaultBatchSize, _clock);
                 _garbageMan.Add(pump);
 
                 yield return pump;

diff --git a/src/Nimbus/Infrastructure/Events/MulticastEventMessagePumpsFactory.cs b/src/Nimbus/Infrastructure/Events/MulticastEventMessagePumpsFactory.cs
@@ -19,6 +19,7 @@ internal class MulticastEventMessagePumpsFactory : ICreateComponents
         private readonly ILogger _logger;
         private readonly IMulticastEventBroker _multicastEventBroker;
         private readonly DefaultBatchSizeSetting _defaultBatchSize;
+        private readonly IClock _clock;
 
         private readonly GarbageMan _garbageMan = new GarbageMan();
 
@@ -28,7 +29,8 @@ internal class MulticastEventMessagePumpsFactory : ICreateComponents
                                                    MulticastEventHandlerTypesSetting multicastEventHandlerTypes,
                                                    ILogger logger,
                                                    IMulticastEventBroker multicastEventBroker,
-                                                   DefaultBatchSizeSetting defaultBatchSize)
+                                                   DefaultBatchSizeSetting defaultBatchSize,
+                                                   IClock clock)
         {
             _queueManager = queueManager;
             _applicationName = applicationName;
@@ -37,6 +39,7 @@ internal class MulticastEventMessagePumpsFactory : ICreateComponents
             _logger = logger;
             _multicastEventBroker = multicastEventBroker;
             _defaultBatchSize = defaultBatchSize;
+            _clock = clock;
         }
 
         public IEnumerable<IMessagePump> CreateAll()
@@ -62,7 +65,7 @@ public IEnumerable<IMessagePump> CreateAll()
                 var dispatcher = new MulticastEventMessageDispatcher(_multicastEventBroker, eventType);
                 _garbageMan.Add(dispatcher);
 
-                var pump = new MessagePump(receiver, dispatcher, _logger, _defaultBatchSize);
+                var pump = new MessagePump(receiver, dispatcher, _logger, _defaultBatchSize, _clock);
                 _garbageMan.Add(pump);
 
                 yield return pump;

diff --git a/src/Nimbus/Infrastructure/ExceptionExtensions.cs b/src/Nimbus/Infrastructure/ExceptionExtensions.cs
@@ -1,21 +1,34 @@
 using System;
 using System.Collections.Generic;
 using System.Reflection;
+using System.Threading;
 
 namespace Nimbus.Infrastructure
 {
     public static class ExceptionExtensions
     {
-        public static Dictionary<string, object> ExceptionDetailsAsProperties(this Exception exception)
+        public static Dictionary<string, object> ExceptionDetailsAsProperties(this Exception exception, DateTimeOffset timestamp)
         {
-            if (exception is TargetInvocationException || exception is AggregateException) return ExceptionDetailsAsProperties(exception.InnerException);
+            if (exception is TargetInvocationException || exception is AggregateException) return ExceptionDetailsAsProperties(exception.InnerException, timestamp);
 
             return new Dictionary<string, object>
                    {
-                       {MessagePropertyKeys.ExceptionTypeKey, exception.GetType().FullName},
-                       {MessagePropertyKeys.ExceptionMessageKey, exception.Message},
-                       {MessagePropertyKeys.ExceptionStackTraceKey, exception.StackTrace},
+                       {MessagePropertyKeys.ExceptionType, exception.GetType().FullName},
+                       {MessagePropertyKeys.ExceptionMessage, exception.Message},
+                       {MessagePropertyKeys.ExceptionStackTrace, exception.StackTrace},
+                       {MessagePropertyKeys.ExceptionTimestamp, timestamp.ToString()},
+                       {MessagePropertyKeys.ExceptionMachineName, Environment.MachineName},
+                       {MessagePropertyKeys.ExceptionIdentityName, GetCurrentIdentityName()},
                    };
         }
+
+        private static string GetCurrentIdentityName()
+        {
+            return (Thread.CurrentPrincipal != null &&
+                    Thread.CurrentPrincipal.Identity != null &&
+                    Thread.CurrentPrincipal.Identity.IsAuthenticated)
+                ? Thread.CurrentPrincipal.Identity.Name
+                : "";
+        }
     }
 }
diff --git a/src/Nimbus/Infrastructure/MessagePropertyKeys.cs b/src/Nimbus/Infrastructure/MessagePropertyKeys.cs
@@ -2,11 +2,14 @@
 {
     public static class MessagePropertyKeys
     {
-        public const string RequestTimeoutInMillisecondsKey = "RequestTimeoutInMilliseconds";
-        public const string RequestSuccessfulKey = "RequestSuccessful";
-        public const string ExceptionMessageKey = "ExceptionMessage";
-        public const string ExceptionTypeKey = "ExceptionType";
-        public const string ExceptionStackTraceKey = "ExceptionStackTrace";
+        public const string RequestTimeoutInMilliseconds = "RequestTimeoutInMilliseconds";
+        public const string RequestSuccessful = "RequestSuccessful";
+        public const string ExceptionMessage = "ExceptionMessage";
+        public const string ExceptionType = "ExceptionType";
+        public const string ExceptionStackTrace = "ExceptionStackTrace";
+        public const string ExceptionTimestamp = "ExceptionTimestamp";
+        public const string ExceptionMachineName = "ExceptionMachineName";
+        public const string ExceptionIdentityName = "ExceptionIdentityName";
         public const string MessageType = "MessageType";
     }
 }
diff --git a/src/Nimbus/Infrastructure/MessagePump.cs b/src/Nimbus/Infrastructure/MessagePump.cs
@@ -18,15 +18,17 @@ internal class MessagePump : IMessagePump
         private readonly IMessageDispatcher _dispatcher;
         private readonly ILogger _logger;
         private readonly DefaultBatchSizeSetting _defaultBatchSize;
+        private readonly IClock _clock;
 
         private Task _internalMessagePump;
 
-        public MessagePump(INimbusMessageReceiver receiver, IMessageDispatcher dispatcher, ILogger logger, DefaultBatchSizeSetting defaultBatchSize)
+        public MessagePump(INimbusMessageReceiver receiver, IMessageDispatcher dispatcher, ILogger logger, DefaultBatchSizeSetting defaultBatchSize, IClock clock)
         {
             _receiver = receiver;
             _dispatcher = dispatcher;
             _logger = logger;
             _defaultBatchSize = defaultBatchSize;
+            _clock = clock;
         }
 
         public async Task Start()
@@ -121,7 +123,7 @@ private async Task Dispatch(BrokeredMessage message)
             _logger.Error(exception, "Message dispatch failed");
 
             _logger.Debug("Abandoning message {0} from {1}", message, message.ReplyTo);
-            await message.AbandonAsync(exception.ExceptionDetailsAsProperties());
+            await message.AbandonAsync(exception.ExceptionDetailsAsProperties(_clock.UtcNow));
             _logger.Debug("Abandoned message {0} from {1}", message, message.ReplyTo);
         }
 

diff --git a/src/Nimbus/Infrastructure/RequestResponse/BusMulticastRequestSender.cs b/src/Nimbus/Infrastructure/RequestResponse/BusMulticastRequestSender.cs
@@ -44,7 +44,7 @@ internal class BusMulticastRequestSender : IMulticastRequestSender
                               ReplyTo = _replyQueueName,
                           };
             message.Properties.Add(MessagePropertyKeys.MessageType, typeof (TRequest).FullName);
-            message.Properties.Add(MessagePropertyKeys.RequestTimeoutInMillisecondsKey, (int) timeout.TotalMilliseconds);
+            message.Properties.Add(MessagePropertyKeys.RequestTimeoutInMilliseconds, (int) timeout.TotalMilliseconds);
             var expiresAfter = _clock.UtcNow.Add(timeout);
             var responseCorrelationWrapper = _requestResponseCorrelator.RecordMulticastRequest<TResponse>(correlationId, expiresAfter);
 

diff --git a/src/Nimbus/Infrastructure/RequestResponse/MulticastRequestMessageDispatcher.cs b/src/Nimbus/Infrastructure/RequestResponse/MulticastRequestMessageDispatcher.cs
@@ -31,14 +31,14 @@ public async Task Dispatch(BrokeredMessage message)
 
             var busRequest = requestMessage.GetBody(_requestType);
 
-            var requestTimeoutInMilliseconds = (int) requestMessage.Properties[MessagePropertyKeys.RequestTimeoutInMillisecondsKey];
+            var requestTimeoutInMilliseconds = (int) requestMessage.Properties[MessagePropertyKeys.RequestTimeoutInMilliseconds];
             var timeout = TimeSpan.FromMilliseconds(requestTimeoutInMilliseconds);
 
             var responses = InvokeGenericHandleMethod(_multicastRequestBroker, busRequest, timeout);
             foreach (var response in responses)
             {
                 var responseMessage = new BrokeredMessage(response);
-                responseMessage.Properties.Add(MessagePropertyKeys.RequestSuccessfulKey, true);
+                responseMessage.Properties.Add(MessagePropertyKeys.RequestSuccessful, true);
                 responseMessage.CorrelationId = requestMessage.CorrelationId;
                 await replyQueueClient.Send(responseMessage);
             }

diff --git a/src/Nimbus/Infrastructure/RequestResponse/MulticastRequestMessagePumpsFactory.cs b/src/Nimbus/Infrastructure/RequestResponse/MulticastRequestMessagePumpsFactory.cs
@@ -18,6 +18,7 @@ internal class MulticastRequestMessagePumpsFactory : ICreateComponents
         private readonly IMulticastRequestBroker _multicastRequestBroker;
         private readonly DefaultBatchSizeSetting _defaultBatchSize;
         private readonly INimbusMessagingFactory _messagingFactory;
+        private readonly IClock _clock;
 
         private readonly GarbageMan _garbageMan = new GarbageMan();
 
@@ -27,7 +28,8 @@ internal class MulticastRequestMessagePumpsFactory : ICreateComponents
                                                    IQueueManager queueManager,
                                                    IMulticastRequestBroker multicastRequestBroker,
                                                    DefaultBatchSizeSetting defaultBatchSize,
-                                                   INimbusMessagingFactory messagingFactory)
+                                                   INimbusMessagingFactory messagingFactory,
+                                                   IClock clock)
         {
             _logger = logger;
             _requestHandlerTypes = requestHandlerTypes;
@@ -36,6 +38,7 @@ internal class MulticastRequestMessagePumpsFactory : ICreateComponents
             _multicastRequestBroker = multicastRequestBroker;
             _defaultBatchSize = defaultBatchSize;
             _messagingFactory = messagingFactory;
+            _clock = clock;
         }
 
         public IEnumerable<IMessagePump> CreateAll()
@@ -61,7 +64,7 @@ public IEnumerable<IMessagePump> CreateAll()
                 var dispatcher = new MulticastRequestMessageDispatcher(_messagingFactory, _multicastRequestBroker, requestType);
                 _garbageMan.Add(dispatcher);
 
-                var pump = new MessagePump(messageReceiver, dispatcher, _logger, _defaultBatchSize);
+                var pump = new MessagePump(messageReceiver, dispatcher, _logger, _defaultBatchSize, _clock);
                 _garbageMan.Add(pump);
 
                 yield return pump;

diff --git a/src/Nimbus/Infrastructure/RequestResponse/RequestMessageDispatcher.cs b/src/Nimbus/Infrastructure/RequestResponse/RequestMessageDispatcher.cs
@@ -14,12 +14,14 @@ internal class RequestMessageDispatcher : IMessageDispatcher
         private readonly INimbusMessagingFactory _messagingFactory;
         private readonly Type _messageType;
         private readonly IRequestBroker _requestBroker;
+        private readonly IClock _clock;
 
-        public RequestMessageDispatcher(INimbusMessagingFactory messagingFactory, Type messageType, IRequestBroker requestBroker)
+        public RequestMessageDispatcher(INimbusMessagingFactory messagingFactory, Type messageType, IRequestBroker requestBroker, IClock clock)
         {
             _messagingFactory = messagingFactory;
             _messageType = messageType;
             _requestBroker = requestBroker;
+            _clock = clock;
         }
 
         public async Task Dispatch(BrokeredMessage message)
@@ -34,14 +36,14 @@ public async Task Dispatch(BrokeredMessage message)
             {
                 var response = InvokeGenericHandleMethod(_requestBroker, request);
                 responseMessage = new BrokeredMessage(response);
-                responseMessage.Properties.Add(MessagePropertyKeys.RequestSuccessfulKey, true);
+                responseMessage.Properties.Add(MessagePropertyKeys.RequestSuccessful, true);
                 responseMessage.Properties.Add(MessagePropertyKeys.MessageType, _messageType.FullName);
             }
             catch (Exception exc)
             {
                 responseMessage = new BrokeredMessage();
-                responseMessage.Properties.Add(MessagePropertyKeys.RequestSuccessfulKey, false);
-                foreach (var prop in exc.ExceptionDetailsAsProperties()) responseMessage.Properties.Add(prop.Key, prop.Value);
+                responseMessage.Properties.Add(MessagePropertyKeys.RequestSuccessful, false);
+                foreach (var prop in exc.ExceptionDetailsAsProperties(_clock.UtcNow)) responseMessage.Properties.Add(prop.Key, prop.Value);
             }
 
             responseMessage.CorrelationId = message.CorrelationId;

diff --git a/src/Nimbus/Infrastructure/RequestResponse/RequestMessagePumpsFactory.cs b/src/Nimbus/Infrastructure/RequestResponse/RequestMessagePumpsFactory.cs
@@ -17,6 +17,7 @@ internal class RequestMessagePumpsFactory : ICreateComponents
         private readonly DefaultBatchSizeSetting _defaultBatchSize;
         private readonly IRequestBroker _requestBroker;
         private readonly INimbusMessagingFactory _messagingFactory;
+        private readonly IClock _clock;
 
         private readonly GarbageMan _garbageMan = new GarbageMan();
 
@@ -25,14 +26,16 @@ internal class RequestMessagePumpsFactory : ICreateComponents
                                           IQueueManager queueManager,
                                           DefaultBatchSizeSetting defaultBatchSize,
                                           IRequestBroker requestBroker,
-                                          INimbusMessagingFactory messagingFactory)
+                                          INimbusMessagingFactory messagingFactory,
+                                          IClock clock)
         {
             _logger = logger;
             _requestHandlerTypes = requestHandlerTypes;
             _queueManager = queueManager;
             _defaultBatchSize = defaultBatchSize;
             _requestBroker = requestBroker;
             _messagingFactory = messagingFactory;
+            _clock = clock;
         }
 
         public IEnumerable<IMessagePump> CreateAll()
@@ -53,10 +56,10 @@ public IEnumerable<IMessagePump> CreateAll()
                 var messageReceiver = new NimbusQueueMessageReceiver(_queueManager, queuePath);
                 _garbageMan.Add(messageReceiver);
 
-                var dispatcher = new RequestMessageDispatcher(_messagingFactory, requestType, _requestBroker);
+                var dispatcher = new RequestMessageDispatcher(_messagingFactory, requestType, _requestBroker, _clock);
                 _garbageMan.Add(dispatcher);
 
-                var pump = new MessagePump(messageReceiver, dispatcher, _logger, _defaultBatchSize);
+                var pump = new MessagePump(messageReceiver, dispatcher, _logger, _defaultBatchSize, _clock);
                 _garbageMan.Add(pump);
 
                 yield return pump;

diff --git a/src/Nimbus/Infrastructure/RequestResponse/ResponseMessagePumpDispatcher.cs b/src/Nimbus/Infrastructure/RequestResponse/ResponseMessagePumpDispatcher.cs
@@ -20,7 +20,7 @@ public async Task Dispatch(BrokeredMessage message)
             var responseCorrelationWrapper = _requestResponseCorrelator.TryGetWrapper(correlationId);
             if (responseCorrelationWrapper == null) return;
 
-            var success = (bool)message.Properties[MessagePropertyKeys.RequestSuccessfulKey];
+            var success = (bool)message.Properties[MessagePropertyKeys.RequestSuccessful];
             if (success)
             {
                 var responseType = responseCorrelationWrapper.ResponseType;
@@ -29,8 +29,8 @@ public async Task Dispatch(BrokeredMessage message)
             }
             else
             {
-                var exceptionMessage = (string)message.Properties[MessagePropertyKeys.ExceptionMessageKey];
-                var exceptionStackTrace = (string)message.Properties[MessagePropertyKeys.ExceptionStackTraceKey];
+                var exceptionMessage = (string)message.Properties[MessagePropertyKeys.ExceptionMessage];
+                var exceptionStackTrace = (string)message.Properties[MessagePropertyKeys.ExceptionStackTrace];
                 responseCorrelationWrapper.Throw(exceptionMessage, exceptionStackTrace);
             }
         }