BHoM_Engine: Add methods to record events from exceptions

BHoM_Engine/Compute/RecordError.cs

@@ -23,6 +23,8 @@
 using BH.oM.Base.Debugging;
 using BH.oM.Base.Attributes;
 using System.Linq;
+using System.ComponentModel;
+using System;
 
 namespace BH.Engine.Base
 {
@@ -32,13 +34,23 @@ public static partial class Compute
         /**** Public Methods                            ****/
         /***************************************************/
 
+        [Description("Record an error within the BHoM logging system.")]
+        [Input("message", "The message to be recorded for this error.")]
+        [Output("success", "True if the error has been successfully recorded as a BHoM Event.")]
         public static bool RecordError(string message)
         {
             return RecordEvent(new Event { Message = message, Type = EventType.Error });
         }
-    }
-}
-
-
 
+        /***************************************************/
 
+        [Description("Record an error with details of a C# exception within the BHoM logging system.")]
+        [Input("exception", "The C# exception being caught to provide the error and stack information for.")]
+        [Input("message", "An optional additional message which will be displayed first in the event log.")]
+        [Output("success", "True if the error has been successfully recorded as a BHoM Event.")]
+        public static bool RecordError(Exception exception, string message = "")
+        {
+            return RecordEvent(exception, message, EventType.Error);
+        }
+    }
+}

BHoM_Engine/Compute/RecordEvent.cs

@@ -46,6 +46,35 @@ public static bool RecordEvent(string message, EventType type = EventType.Unknow
 
         /***************************************************/
 
+        [Description("Record an event with details of a C# exception within the BHoM logging system.")]
+        [Input("exception", "The C# exception being caught to provide the event and stack information for.")]
+        [Input("message", "An optional additional message which will be displayed first in the event log.")]
+        [Output("success", "True if the event has been successfully recorded as a BHoM Event.")]
+        public static bool RecordEvent(Exception exception, string message = "", EventType type = EventType.Unknown)
+        {
+            string exceptionMessage = "";
+
+            Exception e = exception;
+            while(e != null)
+            {
+                if (!string.IsNullOrEmpty(exceptionMessage))
+                    exceptionMessage += $"{Environment.NewLine}{Environment.NewLine}";
+
+                exceptionMessage += $"{e.Message}";
+
+                e = e.InnerException;
+            }
+
+            if (!string.IsNullOrEmpty(message))
+                message = $"{message}\n\n{exceptionMessage}";
+            else
+                message = exceptionMessage;
+
+            return RecordEvent(new Event { Message = message, StackTrace = exception.StackTrace, Type = type });
+        }
+
+        /***************************************************/
+
         [Description("Records an event in the BHoM event log.")]
         [Input("newEvent", "Event to be logged.")]
         [Output("success", "True if the event is logged successfully.")]
@@ -57,8 +86,11 @@ public static bool RecordEvent(Event newEvent)
                 return false;
             }
 
-            string trace = System.Environment.StackTrace;
-            newEvent.StackTrace = string.Join("\n", trace.Split('\n').Skip(4).ToArray());
+            if (string.IsNullOrEmpty(newEvent.StackTrace))
+            {
+                string trace = System.Environment.StackTrace;
+                newEvent.StackTrace = string.Join("\n", trace.Split('\n').Skip(4).ToArray());
+            }
 
             lock (Global.DebugLogLock)
             {

BHoM_Engine/Compute/RecordNote.cs

@@ -23,6 +23,8 @@
 using BH.oM.Base.Debugging;
 using BH.oM.Base.Attributes;
 using System.Linq;
+using System.ComponentModel;
+using System;
 
 namespace BH.Engine.Base
 {
@@ -32,13 +34,23 @@ public static partial class Compute
         /**** Public Methods                            ****/
         /***************************************************/
 
+        [Description("Record a note within the BHoM logging system.")]
+        [Input("message", "The message to be recorded for this note.")]
+        [Output("success", "True if the note has been successfully recorded as a BHoM Event.")]
         public static bool RecordNote(string message)
         {
             return RecordEvent(new Event { Message = message, Type = EventType.Note });
         }
-    }
-}
-
-
 
+        /***************************************************/
 
+        [Description("Record a note with details of a C# exception within the BHoM logging system.")]
+        [Input("exception", "The C# exception being caught to provide the note and stack information for.")]
+        [Input("message", "An optional additional message which will be displayed first in the event log.")]
+        [Output("success", "True if the note has been successfully recorded as a BHoM Event.")]
+        public static bool RecordNote(Exception exception, string message = "")
+        {
+            return RecordEvent(exception, message, EventType.Note);
+        }
+    }
+}

BHoM_Engine/Compute/RecordWarning.cs

@@ -23,6 +23,8 @@
 using BH.oM.Base.Debugging;
 using BH.oM.Base.Attributes;
 using System.Linq;
+using System.ComponentModel;
+using System;
 
 namespace BH.Engine.Base
 {
@@ -32,13 +34,23 @@ public static partial class Compute
         /**** Public Methods                            ****/
         /***************************************************/
 
+        [Description("Record a warning within the BHoM logging system.")]
+        [Input("message", "The message to be recorded for this warning.")]
+        [Output("success", "True if the warning has been successfully recorded as a BHoM Event.")]
         public static bool RecordWarning(string message)
         {
             return RecordEvent(new Event { Message = message, Type = EventType.Warning });
         }
-    }
-}
-
-
 
+        /***************************************************/
 
+        [Description("Record a warning with details of a C# exception within the BHoM logging system.")]
+        [Input("exception", "The C# exception being caught to provide the warning and stack information for.")]
+        [Input("message", "An optional additional message which will be displayed first in the event log.")]
+        [Output("success", "True if the warning has been successfully recorded as a BHoM Event.")]
+        public static bool RecordWarning(Exception exception, string message = "")
+        {
+            return RecordEvent(exception, message, EventType.Warning);
+        }
+    }
+}