feat(event.py): add exception frames (#291)

Author: ranrib

epsagon/event.py

@@ -3,7 +3,9 @@
 """
 
 from __future__ import absolute_import
+import sys
 import time
+import inspect
 import uuid
 from .common import ErrorCode
 
@@ -111,12 +113,24 @@ def set_exception(
             function
         :param from_logs: True if the exception was captured from logging
         """
-
         self.error_code = ErrorCode.EXCEPTION
         self.exception['type'] = type(exception).__name__
         self.exception['message'] = str(exception)
         self.exception['traceback'] = traceback_data
         self.exception['time'] = time.time()
+
+        # Adding python frames (input data of functions in stack) in python 3.
+        # Ignoring filenames with /epsagon since they are ours.
+        if sys.version_info.major == 3:
+            self.exception['frames'] = {
+                '/'.join([
+                    frame.filename,
+                    frame.function,
+                    str(frame.lineno)
+                ]): frame.frame.f_locals
+                for frame in inspect.trace()
+                if '/epsagon' not in frame.filename and frame.frame.f_locals
+            }
         self.exception.setdefault('additional_data', {})['handled'] = handled
         if from_logs:
             self.exception['additional_data']['from_logs'] = True

tests/wrappers/test_python_function.py

@@ -1,10 +1,17 @@
+import sys
 import mock
 import pytest
+from collections import namedtuple
 from epsagon import trace_factory
 import epsagon.constants
 
 trace_mock = mock.MagicMock()
 
+Frame = namedtuple('Frame', 'f_locals')
+FrameInfo = namedtuple(
+    'FrameInfo',
+    'frame, filename, lineno, function, code_context, index'
+)
 
 def setup_function(func):
     trace_factory.use_single_trace = True
@@ -62,3 +69,31 @@ def wrapped_function(event, context):
     trace_mock.prepare.assert_called_once()
     trace_mock.send_traces.assert_not_called()
     trace_mock.set_runner.assert_not_called()
+
+
+@mock.patch(
+    'inspect.trace',
+    return_value=[FrameInfo(
+        frame=Frame(f_locals={'param': 'value'}),
+        filename='filename',
+        lineno=1,
+        function='function',
+        code_context=['code_context'],
+        index=0,
+    )]
+)
+def test_function_wrapper_function_exception_frames(_, trace_transport):
+    @epsagon.python_wrapper()
+    def wrapped_function():
+        raise TypeError('test')
+
+    with pytest.raises(TypeError):
+        wrapped_function()
+
+    assert len(trace_transport.last_trace.events) == 1
+    event = trace_transport.last_trace.events[0]
+    if sys.version_info.major == 3:
+        assert event.exception['frames'] ==  {
+            'filename/function/1': {'param': 'value'}
+        }
+