Merge pull request #47 from honeycombio/tredman.context-manager

2.4.2 - fixes issue in tracing context manager and some minor issues

Author: tredman

beeline/__init__.py

@@ -189,10 +189,7 @@ def _run_hooks_and_send(self, ev):
             self.log("executing presend hook on event ev = %s", ev.fields())
             self.presend_hook(ev.fields())
 
-        if hasattr(ev, 'traced_event'):
-            self.log("enqueuing traced event ev = %s", ev.fields())
-            self.tracer_impl.send_traced_event(ev, presampled=presampled)
-        elif presampled:
+        if presampled:
             self.log("enqueuing presampled event ev = %s", ev.fields())
             ev.send_presampled()
         else:

beeline/internal.py

@@ -2,12 +2,6 @@
 
 # these are mostly convenience methods for safely calling beeline methods
 # even if the beeline hasn't been initialized
-def new_event(data=None, trace_name='', top_level=False):
-    bl = beeline.get_beeline()
-    if bl:
-        bl.log("creating new event with data = %s", data)
-        return bl.new_event(data, trace_name, top_level)
-
 def send_event():
     bl = beeline.get_beeline()
     if bl:

beeline/test_beeline.py

@@ -51,21 +51,13 @@ def test_send_all(self):
     def test_run_hooks_and_send_no_hooks(self):
         ''' ensure send works when no hooks defined '''
         ev = Mock()
-        delattr(ev, 'traced_event')
         _beeline = beeline.Beeline()
         _beeline.tracer_impl = Mock()
         _beeline._run_hooks_and_send(ev)
 
         # no hooks, not a traced event - call send
         ev.send.assert_called_once_with()
         ev.send_presampled.assert_not_called()
-        _beeline.tracer_impl.send_traced_event.assert_not_called()
-
-        # traced_event is an implicit attribute on Mock, so send_traced_event
-        # should be called
-        traced_ev = Mock()
-        _beeline._run_hooks_and_send(traced_ev)
-        _beeline.tracer_impl.send_traced_event.assert_called_once_with(traced_ev, presampled=False)
 
     def test_run_hooks_and_send_sampler(self):
         ''' ensure send works with a sampler hook defined '''
@@ -76,8 +68,6 @@ def _sampler_drop_all(fields):
         _beeline = beeline.Beeline(sampler_hook=m_sampler_hook)
         _beeline.tracer_impl = Mock()
         ev = Mock()
-        # non-traced event
-        delattr(ev, 'traced_event')
 
         _beeline._run_hooks_and_send(ev)
         m_sampler_hook.assert_called_once_with(ev.fields())
@@ -88,8 +78,6 @@ def _sampler_drop_none(fields):
             return True, 100
 
         ev = Mock()
-        # non-traced event
-        delattr(ev, 'traced_event')
         m_sampler_hook.reset_mock()
 
         m_sampler_hook.side_effect = _sampler_drop_none
@@ -100,17 +88,6 @@ def _sampler_drop_none(fields):
         ev.send_presampled.assert_called_once_with()
         ev.send.assert_not_called()
 
-        # traced event
-        ev = Mock()
-        m_sampler_hook.reset_mock()
-
-        _beeline._run_hooks_and_send(ev)
-        m_sampler_hook.assert_called_once_with(ev.fields())
-        self.assertEqual(ev.sample_rate, 100)
-        _beeline.tracer_impl.send_traced_event.assert_called_once_with(ev, presampled=True)
-        ev.send_presampled.assert_not_called()
-        ev.send.assert_not_called()
-
     def test_run_hooks_and_send_presend_hook(self):
         ''' ensure send works when presend hook is defined '''
         def _presend_hook(fields):
@@ -122,14 +99,12 @@ def _presend_hook(fields):
         _beeline.tracer_impl = Mock()
 
         ev = Mock()
-        delattr(ev, 'traced_event')
         ev.fields.return_value = {
             "thing i don't want": "get it out of here",
             "happy data": "so happy",
         }
 
         _beeline._run_hooks_and_send(ev)
-        _beeline.tracer_impl.send_traced_event.assert_not_called()
         ev.send_presampled.assert_not_called()
         ev.send.assert_called_once_with()
         self.assertDictEqual(

beeline/test_trace.py

@@ -44,7 +44,7 @@ def test_probability(self):
 
 class TestSynchronousTracer(unittest.TestCase):
     def test_trace_context_manager_exception(self):
-        ''' ensure that send_traced_event is called even if an exception is
+        ''' ensure that span is sent even if an exception is
         raised inside the context manager '''
         m_client = Mock()
         tracer = SynchronousTracer(m_client)
@@ -63,6 +63,8 @@ def test_trace_context_manager_starts_span_if_trace_active(self):
         m_client = Mock()
         tracer = SynchronousTracer(m_client)
         tracer.start_span = Mock()
+        tracer.start_trace = Mock()
+        tracer.get_active_trace_id = Mock(return_value='asdf')
         mock_span = Mock()
         tracer.start_span.return_value = mock_span
         tracer.finish_span = Mock()
@@ -71,6 +73,37 @@ def test_trace_context_manager_starts_span_if_trace_active(self):
             pass
 
         tracer.start_span.assert_called_once_with(context={'name': 'foo'}, parent_id=None)
+        tracer.start_trace.assert_not_called()
+        tracer.finish_span.assert_called_once_with(mock_span)
+
+    def test_trace_context_manager_passes_parent_id_if_supplied(self):
+        ''' ensure parent_id gets passed to start_span if supplied '''
+        m_client = Mock()
+        tracer = SynchronousTracer(m_client)
+        tracer.start_span = Mock()
+        mock_span = Mock()
+        tracer.start_span.return_value = mock_span
+        tracer.finish_span = Mock()
+
+        with tracer('foo', parent_id='zyxw'):
+            pass
+
+        tracer.start_span.assert_called_once_with(context={'name': 'foo'}, parent_id='zyxw')
+        tracer.finish_span.assert_called_once_with(mock_span)
+
+    def test_trace_context_manager_starts_trace_if_trace_id_supplied(self):
+        ''' ensure trace_id and parent_id get passed to start_trace if supplied '''
+        m_client = Mock()
+        tracer = SynchronousTracer(m_client)
+        tracer.start_trace = Mock()
+        mock_span = Mock()
+        tracer.start_trace.return_value = mock_span
+        tracer.finish_span = Mock()
+
+        with tracer('foo', trace_id='asdf', parent_id='zyxw'):
+            pass
+
+        tracer.start_trace.assert_called_once_with(context={'name': 'foo'}, trace_id='asdf', parent_span_id='zyxw')
         tracer.finish_span.assert_called_once_with(mock_span)
 
     def test_start_trace(self):

beeline/trace.py

@@ -41,13 +41,13 @@ def __init__(self, client):
     def __call__(self, name, trace_id=None, parent_id=None):
         try:
             span = None
-            if self.get_active_trace_id():
-                span = self.start_span(context={'name': name})
+            if self.get_active_trace_id() and trace_id is None:
+                span = self.start_span(context={'name': name}, parent_id=parent_id)
                 if span:
                     log('tracer context manager started new span, id = %s',
                         span.id)
             else:
-                span = self.start_trace(context={'name': name})
+                span = self.start_trace(context={'name': name}, trace_id=trace_id, parent_span_id=parent_id)
                 if span:
                     log('tracer context manager started new trace, id = %s',
                         span.trace_id)

beeline/version.py

@@ -1 +1 @@
-VERSION = '2.4.1'
+VERSION = '2.4.2'

setup.py

@@ -4,7 +4,7 @@
 setup(
     python_requires='>=2.7',
     name='honeycomb-beeline',
-    version='2.4.1',
+    version='2.4.2',
     description='Honeycomb library for easy instrumentation',
     url='https://github.com/honeycombio/beeline-python',
     author='Honeycomb.io',