Merge pull request #223 from hjgraca/fix_tracing_on_exception_thrown

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

Author: sliedig

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

@@ -14,6 +14,7 @@
  */
 
 using System;
+using System.Text;
 using AWS.Lambda.Powertools.Common;
 
 namespace AWS.Lambda.Powertools.Tracing.Internal;
@@ -163,12 +164,26 @@ public T OnException<T>(AspectEventArgs eventArgs, Exception exception)
         if (CaptureError())
         {
             var nameSpace = GetNamespace();
+            
+            var sb = new StringBuilder();
+            sb.AppendLine($"Exception type: {exception.GetType()}");
+            sb.AppendLine($"Exception message: {exception.Message}");
+            sb.AppendLine($"Stack trace: {exception.StackTrace}");
 
+            if (exception.InnerException != null)
+            {
+                sb.AppendLine("---BEGIN InnerException--- ");
+                sb.AppendLine($"Exception type {exception.InnerException.GetType()}");
+                sb.AppendLine($"Exception message: {exception.InnerException.Message}");
+                sb.AppendLine($"Stack trace: {exception.InnerException.StackTrace}");
+                sb.AppendLine("---END Inner Exception");
+            }
+            
             _xRayRecorder.AddMetadata
             (
                 nameSpace,
                 $"{eventArgs.Name} error",
-                exception
+                sb.ToString()
             );
         }
 

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

@@ -15,6 +15,7 @@
 
 using System;
 using System.Linq;
+using System.Text;
 using AWS.Lambda.Powertools.Common;
 using AWS.Lambda.Powertools.Tracing.Internal;
 using Moq;
@@ -590,7 +591,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 +606,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 +652,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 +667,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 +683,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 +698,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 +765,28 @@ public void OnException_WhenTracerCaptureModeIsDisabled_DoesNotCaptureError()
 
         #endregion
 
+        #region Utilities
+
+        static string GetException(Exception exception)
+        {
+            var sb = new StringBuilder();
+            sb.AppendLine($"Exception type: {exception.GetType()}");
+            sb.AppendLine($"Exception message: {exception.Message}");
+            sb.AppendLine($"Stack trace: {exception.StackTrace}");
+
+            if (exception.InnerException != null)
+            {
+                sb.AppendLine("---BEGIN InnerException--- ");
+                sb.AppendLine($"Exception type {exception.InnerException.GetType()}");
+                sb.AppendLine($"Exception message: {exception.InnerException.Message}");
+                sb.AppendLine($"Stack trace: {exception.InnerException.StackTrace}");
+                sb.AppendLine("---END Inner Exception");
+            }
+            return sb.ToString();
+        }
+
+        #endregion
+        
         #region OnExit Tests
 
         [Fact]