Fix Tracing when exception is thrown. Prevent Tracing from throwing InvalidOperationException

Author: hjgraca

libraries/src/AWS.Lambda.Powertools.Tracing/Internal/TracingAspectHandler.cs

@@ -163,12 +163,25 @@ public T OnException<T>(AspectEventArgs eventArgs, Exception exception)
         if (CaptureError())
         {
             var nameSpace = GetNamespace();
-
+            
+            var message =
+                "Exception type " + exception.GetType() + Environment.NewLine +
+                "Exception message: " + exception.Message + Environment.NewLine +
+                "Stack trace: " + exception.StackTrace + Environment.NewLine;
+            if (exception.InnerException != null)
+            {
+                message += "---BEGIN InnerException--- " + Environment.NewLine +
+                           "Exception type " + exception.InnerException.GetType() + Environment.NewLine +
+                           "Exception message: " + exception.InnerException.Message + Environment.NewLine +
+                           "Stack trace: " + exception.InnerException.StackTrace + Environment.NewLine +
+                           "---END Inner Exception";
+            }
+            
             _xRayRecorder.AddMetadata
             (
                 nameSpace,
                 $"{eventArgs.Name} error",
-                exception
+                message
             );
         }
 

libraries/tests/AWS.Lambda.Powertools.Tracing.Tests/TracingAttributeTest.cs

@@ -590,7 +590,8 @@ public void OnException_WhenTracerCaptureErrorEnvironmentVariableIsTrue_Captures
             configurations.Setup(c => c.TracerCaptureError).Returns(true);
             var recorder = new Mock<IXRayRecorder>();
             var exception = new Exception("Test Exception");
-
+            var message = GetException(exception);
+            
             var handler = new TracingAspectHandler(null, nameSpace, TracingCaptureMode.EnvironmentVariable,
                 configurations.Object, recorder.Object);
             var eventArgs = new AspectEventArgs {Name = methodName};
@@ -604,7 +605,7 @@ public void OnException_WhenTracerCaptureErrorEnvironmentVariableIsTrue_Captures
                 v.AddMetadata(
                     It.Is<string>(i => i == nameSpace),
                     It.Is<string>(i => i == $"{methodName} error"),
-                    It.Is<Exception>(i => i == exception
+                    It.Is<string>(i => i == message
                     )
                 ), Times.Once);
         }
@@ -650,7 +651,8 @@ public void OnException_WhenTracerCaptureModeIsError_CapturesError()
             configurations.Setup(c => c.TracingDisabled).Returns(false);
             var recorder = new Mock<IXRayRecorder>();
             var exception = new Exception("Test Exception");
-
+            var message = GetException(exception);
+            
             var handler = new TracingAspectHandler(null, nameSpace, TracingCaptureMode.Error,
                 configurations.Object, recorder.Object);
             var eventArgs = new AspectEventArgs {Name = methodName};
@@ -664,7 +666,7 @@ public void OnException_WhenTracerCaptureModeIsError_CapturesError()
                 v.AddMetadata(
                     It.Is<string>(i => i == nameSpace),
                     It.Is<string>(i => i == $"{methodName} error"),
-                    It.Is<Exception>(i => i == exception
+                    It.Is<string>(i => i == message
                     )
                 ), Times.Once);
         }
@@ -680,7 +682,8 @@ public void OnException_WhenTracerCaptureModeIsResponseAndError_CapturesError()
             configurations.Setup(c => c.TracingDisabled).Returns(false);
             var recorder = new Mock<IXRayRecorder>();
             var exception = new Exception("Test Exception");
-
+            var message = GetException(exception);
+            
             var handler = new TracingAspectHandler(null, nameSpace, TracingCaptureMode.ResponseAndError,
                 configurations.Object, recorder.Object);
             var eventArgs = new AspectEventArgs {Name = methodName};
@@ -694,7 +697,7 @@ public void OnException_WhenTracerCaptureModeIsResponseAndError_CapturesError()
                 v.AddMetadata(
                     It.Is<string>(i => i == nameSpace),
                     It.Is<string>(i => i == $"{methodName} error"),
-                    It.Is<Exception>(i => i == exception
+                    It.Is<string>(i => i == message
                     )
                 ), Times.Once);
         }
@@ -761,6 +764,27 @@ public void OnException_WhenTracerCaptureModeIsDisabled_DoesNotCaptureError()
 
         #endregion
 
+        #region Utilities
+
+        static string GetException(Exception exception)
+        {
+            var message =
+                "Exception type " + exception.GetType() + Environment.NewLine +
+                "Exception message: " + exception.Message + Environment.NewLine +
+                "Stack trace: " + exception.StackTrace + Environment.NewLine;
+            if (exception.InnerException != null)
+            {
+                message += "---BEGIN InnerException--- " + Environment.NewLine +
+                           "Exception type " + exception.InnerException.GetType() + Environment.NewLine +
+                           "Exception message: " + exception.InnerException.Message + Environment.NewLine +
+                           "Stack trace: " + exception.InnerException.StackTrace + Environment.NewLine +
+                           "---END Inner Exception";
+            }
+            return message;
+        }
+
+        #endregion
+        
         #region OnExit Tests
 
         [Fact]