v4.0.0 (lightstep#49)

Adds support for OpenTracing 2.0 Python APIs!

This supports ScopeManager to make in-process context propagation simpler.

Author: carlosalberto

CHANGELOG.md

@@ -0,0 +1,4 @@
+<a name="4.0.0"></a>
+## [4.0.0](https://github.com/lightstep/lightstep-tracer-python/compare/4.0.0...3.0.11)
+### BREAKING CHANGES
+* Integrate the OpenTracing 2.0.0 updates which implements the ScopeManager for in-process propagation (OT changelog can be found [here](https://medium.com/opentracing/announcing-python-opentracing-2-0-0-fa4e4c9395a))

README.md

@@ -77,8 +77,8 @@ if __name__ == "__main__":
     component_name='your_microservice_name',
     access_token='{your_access_token}')
 
-  with opentracing.tracer.start_span('TestSpan') as span:
-    span.log_event('test message', payload={'life': 42})
+  with opentracing.tracer.start_active_span('TestSpan') as scope:
+    scope.span.log_event('test message', payload={'life': 42})
 
   opentracing.tracer.flush()
 ```

examples/http/context_in_headers.py

@@ -36,7 +36,8 @@ class RemoteHandler(BaseHTTPRequestHandler):
     """
 
     def do_GET(self):
-        with before_answering_request(self, opentracing.tracer) as server_span:
+        server_span = before_answering_request(self, opentracing.tracer)
+        with opentracing.tracer.scope_manager.activate(server_span, True):
             server_span.log_event('request received', self.path)
 
             self.send_response(200)
@@ -160,7 +161,8 @@ def lightstep_tracer_from_args():
             # Prepare request in the client
             url = 'http://localhost:{}'.format(port_number)
             request = Request(url)
-            with before_sending_request(request) as client_span:
+            client_span = before_sending_request(request)
+            with opentracing.tracer.scope_manager.activate(client_span, True):
                 client_span.log_event('sending request', url)
 
                 # Send request to server

examples/nontrivial/main.py

@@ -27,11 +27,11 @@ def sleep_dot():
 def add_spans():
     """Calls the opentracing API, doesn't use any LightStep-specific code.
     """
-    with opentracing.tracer.start_span(operation_name='trivial/initial_request') as parent_span:
-        parent_span.set_tag('url', 'localhost')
-        parent_span.log_event('All good here!', payload={'N': 42, 'pi': 3.14, 'abc': 'xyz'})
-        parent_span.set_tag('span_type', 'parent')
-        parent_span.set_baggage_item('checked', 'baggage')
+    with opentracing.tracer.start_active_span('trivial/initial_request') as parent_scope:
+        parent_scope.span.set_tag('url', 'localhost')
+        parent_scope.span.log_event('All good here!', payload={'N': 42, 'pi': 3.14, 'abc': 'xyz'})
+        parent_scope.span.set_tag('span_type', 'parent')
+        parent_scope.span.set_baggage_item('checked', 'baggage')
 
         rng = random.SystemRandom()
         for i in range(50):
@@ -40,21 +40,21 @@ def add_spans():
             sys.stdout.flush()
 
             # This is how you would represent starting work locally.
-            with opentracing.start_child_span(parent_span, operation_name='trivial/child_request') as child_span:
-                child_span.log_event('Uh Oh!', payload={'error': True})
-                child_span.set_tag('span_type', 'child')
+            with opentracing.tracer.start_active_span('trivial/child_request') as child_scope:
+                child_scope.span.log_event('Uh Oh!', payload={'error': True})
+                child_scope.span.set_tag('span_type', 'child')
 
                 # Play with the propagation APIs... this is not IPC and thus not
                 # where they're intended to be used.
                 text_carrier = {}
-                opentracing.tracer.inject(child_span.context, opentracing.Format.TEXT_MAP, text_carrier)
+                opentracing.tracer.inject(child_scope.span.context, opentracing.Format.TEXT_MAP, text_carrier)
 
                 span_context = opentracing.tracer.extract(opentracing.Format.TEXT_MAP, text_carrier)
-                with opentracing.tracer.start_span(
+                with opentracing.tracer.start_active_span(
                     'nontrivial/remote_span',
-                    child_of=span_context) as remote_span:
-                        remote_span.log_event('Remote!')
-                        remote_span.set_tag('span_type', 'remote')
+                    child_of=span_context) as remote_scope:
+                        remote_scope.span.log_event('Remote!')
+                        remote_scope.span.set_tag('span_type', 'remote')
                         time.sleep(rng.random() * 0.1)
 
                 opentracing.tracer.flush()

examples/trivial/main.py

@@ -20,37 +20,37 @@ def sleep_dot():
 def add_spans():
     """Calls the opentracing API, doesn't use any LightStep-specific code.
     """
-    with opentracing.tracer.start_span(operation_name='trivial/initial_request') as parent_span:
-        parent_span.set_tag('url', 'localhost')
+    with opentracing.tracer.start_active_span('trivial/initial_request') as parent_scope:
+        parent_scope.span.set_tag('url', 'localhost')
         sleep_dot()
-        parent_span.log_event('All good here!', payload={'N': 42, 'pi': 3.14, 'abc': 'xyz'})
-        parent_span.log_kv({'foo': 'bar', 'int': 42, 'float': 4.2, 'bool': True, 'obj': {'blargh': 'hmm', 'whee': 4324}})
-        parent_span.set_tag('span_type', 'parent')
-        parent_span.set_tag('int_tag', 5)
-        parent_span.set_tag('unicode_val', u'non-ascii: \u200b')
-        parent_span.set_tag('bool_tag', True)
-        parent_span.set_baggage_item('checked', 'baggage')
+        parent_scope.span.log_event('All good here!', payload={'N': 42, 'pi': 3.14, 'abc': 'xyz'})
+        parent_scope.span.log_kv({'foo': 'bar', 'int': 42, 'float': 4.2, 'bool': True, 'obj': {'blargh': 'hmm', 'whee': 4324}})
+        parent_scope.span.set_tag('span_type', 'parent')
+        parent_scope.span.set_tag('int_tag', 5)
+        parent_scope.span.set_tag('unicode_val', u'non-ascii: \u200b')
+        parent_scope.span.set_tag('bool_tag', True)
+        parent_scope.span.set_baggage_item('checked', 'baggage')
         sleep_dot()
 
         # This is how you would represent starting work locally.
-        with opentracing.start_child_span(parent_span, operation_name='trivial/child_request') as child_span:
-            child_span.set_tag('span_type', 'child')
+        with opentracing.tracer.start_active_span('trivial/child_request') as child_scope:
+            child_scope.span.set_tag('span_type', 'child')
             # Pretend there was an error
-            child_span.set_tag('error', True)
-            child_span.log_event('Uh Oh!', payload={'stacktrace': traceback.extract_stack()})
+            child_scope.span.set_tag('error', True)
+            child_scope.span.log_event('Uh Oh!', payload={'stacktrace': traceback.extract_stack()})
             sleep_dot()
 
             # Play with the propagation APIs... this is not IPC and thus not
             # where they're intended to be used.
             text_carrier = {}
-            opentracing.tracer.inject(child_span.context, opentracing.Format.TEXT_MAP, text_carrier)
+            opentracing.tracer.inject(child_scope.span.context, opentracing.Format.TEXT_MAP, text_carrier)
 
             span_context = opentracing.tracer.extract(opentracing.Format.TEXT_MAP, text_carrier)
-            with opentracing.tracer.start_span(
+            with opentracing.tracer.start_active_span(
                 'trivial/remote_span',
-                child_of=span_context) as remote_span:
-                    remote_span.log_event('Remote!')
-                    remote_span.set_tag('span_type', 'remote')
+                child_of=span_context) as remote_scope:
+                    remote_scope.span.log_event('Remote!')
+                    remote_scope.span.set_tag('span_type', 'remote')
                     sleep_dot()
 
 def lightstep_tracer_from_args():

lightstep/tracer.py

@@ -47,6 +47,9 @@ def Tracer(**kwargs):
         inject/extract format (which relies on protobufs and may cause problems
         if other versions of protobufs are active in the same packaging
         configuration). Defaults to False (i.e., binary format is enabled).
+    :param ScopeManager scope_manager: the ScopeManager responsible for
+        Span activation. Defaults to the implementation provided by the
+        basictracer package, which uses thread-local storage.
     :param bool use_thrift: Forces the use of Thrift as the transport protocol.
     :param bool use_http: Forces the use of Proto over http.
     :param float timeout_seconds: Number of seconds allowed for the HTTP report transaction (fractions are permitted)
@@ -55,13 +58,21 @@ def Tracer(**kwargs):
     if 'disable_binary_format' in kwargs:
         enable_binary_format = not kwargs['disable_binary_format']
         del kwargs['disable_binary_format']
-    return _LightstepTracer(enable_binary_format, Recorder(**kwargs))
+
+    scope_manager = None
+    if 'scope_manager' in kwargs:
+        scope_manager = kwargs['scope_manager']
+        del kwargs['scope_manager']
+
+    return _LightstepTracer(enable_binary_format,
+                            Recorder(**kwargs),
+                            scope_manager)
 
 
 class _LightstepTracer(BasicTracer):
-    def __init__(self, enable_binary_format, recorder):
+    def __init__(self, enable_binary_format, recorder, scope_manager):
         """Initialize the LightStep Tracer, deferring to BasicTracer."""
-        super(_LightstepTracer, self).__init__(recorder)
+        super(_LightstepTracer, self).__init__(recorder, scope_manager=scope_manager)
         self.register_propagator(Format.TEXT_MAP, TextPropagator())
         self.register_propagator(Format.HTTP_HEADERS, TextPropagator())
         if enable_binary_format:

setup.py

@@ -2,15 +2,15 @@
 
 setup(
     name='lightstep',
-    version='3.0.11',
+    version='4.0.0',
     description='LightStep Python OpenTracing Implementation',
     long_description='',
     author='LightStep',
     license='',
     install_requires=['thrift==0.10.0',
                       'jsonpickle',
                       'six',
-                      'basictracer>=2.2,<2.3',
+                      'basictracer>=3.0,<3.1',
                       'googleapis-common-protos==1.5.3',
                       'requests>=2.19,<3.0'],
     tests_require=['pytest',

tests/opentracing_compatibility_test.py

@@ -18,6 +18,15 @@ def setUp(self):
     def tracer(self):
         return self._tracer
 
+    def is_parent(self, parent, span):
+        if span is None:
+            return False
+
+        if parent is None:
+            return span.parent_id is None
+
+        return parent.context.span_id == span.parent_id
+
     def tearDown(self):
         self._tracer.flush()