Support OpenTracing API v2.0 (#206)

* Use opentracing 2.0

Signed-off-by: Michał Szymański <[email protected]>

* remove redundant assignment

Signed-off-by: Michał Szymański <[email protected]>

* use opentracing in any 2.x version

Signed-off-by: Michał Szymański <[email protected]>

* allow specifying scope manager in config

Signed-off-by: Michał Szymański <[email protected]>

* Apply suggestions from code review: formatting fixes

Co-Authored-By: mihau <[email protected]>
Signed-off-by: Michał Szymański <[email protected]>

* remove unnecessary new line

Signed-off-by: Michał Szymański <[email protected]>

* override test_start_activ_span

Signed-off-by: Michał Szymański <[email protected]>

* fix linter issues

Signed-off-by: Michał Szymański <[email protected]>

* pass an instance of a scope manager instead of a class

Signed-off-by: Michał Szymański <[email protected]>

* add a TODO to remove api tests override

Signed-off-by: Michał Szymański <[email protected]>

* remove trailing whitespace

Signed-off-by: Michał Szymański <[email protected]>

* reference opentracing-python release in TODO message

Signed-off-by: Michał Szymański <[email protected]>

* use named arguments

Signed-off-by: Michał Szymański <[email protected]>

* don't use active span if parent is passed explicitly

Signed-off-by: Michał Szymański <[email protected]>

* Fix lint

Signed-off-by: Yuri Shkuro <[email protected]>

* Bump OT to 2.1 and remove test override

Signed-off-by: Yuri Shkuro <[email protected]>

Author: mihau

jaeger_client/config.py

@@ -84,17 +84,20 @@ class Config(object):
     _initialized_lock = threading.Lock()
 
     def __init__(self, config, metrics=None, service_name=None, metrics_factory=None,
-                 validate=False):
+                 validate=False, scope_manager=None):
         """
         :param metrics: an instance of Metrics class, or None. This parameter
             has been deprecated, please use metrics_factory instead.
         :param service_name: default service name.
             Can be overwritten by config['service_name'].
         :param metrics_factory: an instance of MetricsFactory class, or None.
+        :param scope_manager: an instance of a scope manager, or None for
+            default (ThreadLocalScopeManager).
         """
         if validate:
             self._validate_config(config)
         self.config = config
+        self.scope_manager = scope_manager
         if get_boolean(self.config.get('metrics', True), True):
             self._metrics_factory = metrics_factory or LegacyMetricsFactory(metrics or Metrics())
         else:
@@ -413,6 +416,7 @@ def create_tracer(self, reporter, sampler, throttler=None):
             max_tag_value_length=self.max_tag_value_length,
             extra_codecs=self.propagation,
             throttler=throttler,
+            scope_manager=self.scope_manager,
         )
 
     def _initialize_global_tracer(self, tracer):

jaeger_client/tracer.py

@@ -25,6 +25,7 @@
 import opentracing
 from opentracing import Format, UnsupportedFormatException
 from opentracing.ext import tags as ext_tags
+from opentracing.scope_managers import ThreadLocalScopeManager
 
 from . import constants
 from .codecs import TextCodec, ZipkinCodec, ZipkinSpanFormat, BinaryCodec
@@ -51,6 +52,7 @@ def __init__(
         tags=None,
         max_tag_value_length=constants.MAX_TAG_VALUE_LENGTH,
         throttler=None,
+        scope_manager=None,
     ):
         self.service_name = service_name
         self.reporter = reporter
@@ -109,12 +111,18 @@ def __init__(
             max_length=self.max_tag_value_length,
         )
 
+        super(Tracer, self).__init__(
+            scope_manager=scope_manager or ThreadLocalScopeManager()
+        )
+
     def start_span(self,
                    operation_name=None,
                    child_of=None,
                    references=None,
                    tags=None,
-                   start_time=None):
+                   start_time=None,
+                   ignore_active_span=False,
+                   ):
         """
         Start and return a new Span representing a unit of work.
 
@@ -129,18 +137,22 @@ def start_span(self,
             to avoid extra data copying.
         :param start_time: an explicit Span start time as a unix timestamp per
             time.time()
+        :param ignore_active_span: an explicit flag that ignores the current
+            active :class:`Scope` and creates a root :class:`Span`
 
         :return: Returns an already-started Span instance.
         """
         parent = child_of
 
+        if self.active_span is not None \
+                and not ignore_active_span \
+                and not parent:
+            parent = self.active_span
+
         # allow Span to be passed as reference, not just SpanContext
         if isinstance(parent, Span):
             parent = parent.context
 
-        rpc_server = tags and \
-            tags.get(ext_tags.SPAN_KIND) == ext_tags.SPAN_KIND_RPC_SERVER
-
         valid_references = None
         if references:
             valid_references = list()
@@ -154,6 +166,9 @@ def start_span(self,
         if valid_references and (parent is None or not parent.has_trace):
             parent = valid_references[0].referenced_context
 
+        rpc_server = tags and \
+            tags.get(ext_tags.SPAN_KIND) == ext_tags.SPAN_KIND_RPC_SERVER
+
         if parent is None or not parent.has_trace:
             trace_id = self._random_id(self.max_trace_id_bits)
             span_id = self._random_id(constants._max_id_bits)
@@ -197,6 +212,46 @@ def start_span(self,
 
         return span
 
+    def start_active_span(self,
+                          operation_name=None,
+                          child_of=None,
+                          references=None,
+                          tags=None,
+                          start_time=None,
+                          ignore_active_span=False,
+                          finish_on_close=True,
+                          ):
+        """
+        Returns a newly started and activated :class:`Scope`
+
+        :param operation_name: name of the operation represented by the new
+            span from the perspective of the current service.
+        :param child_of: shortcut for 'child_of' reference
+        :param references: (optional) either a single Reference object or a
+            list of Reference objects that identify one or more parent
+            SpanContexts. (See the Reference documentation for detail)
+        :param tags: optional dictionary of Span Tags. The caller gives up
+            ownership of that dictionary, because the Tracer may use it as-is
+            to avoid extra data copying.
+        :param start_time: an explicit Span start time as a unix timestamp per
+            time.time()
+        :param ignore_active_span: an explicit flag that ignores the current
+            active :class:`Scope` and creates a root :class:`Span`
+        :param finish_on_close: whether :class:`Span` should automatically be
+            finished when :meth:`Scope.close()` is called.
+
+        :return: a :class:`Scope`, already registered via the :class:`ScopeManager`.
+        """
+        span = self.start_span(
+            operation_name=operation_name,
+            child_of=child_of,
+            references=references,
+            tags=tags,
+            start_time=start_time,
+            ignore_active_span=ignore_active_span,
+        )
+        return self.scope_manager.activate(span, finish_on_close)
+
     def inject(self, span_context, format, carrier):
         codec = self.codecs.get(format, None)
         if codec is None:

setup.py

@@ -40,7 +40,7 @@
         'threadloop>=1,<2',
         'thrift',
         'tornado>=4.3,<5',
-        'opentracing>=1.2.2,<2',
+        'opentracing>=2.1,<3.0',
     ],
     # Uncomment below if need to test with unreleased version of opentracing
     # dependency_links=[

tests/test_api.py

@@ -34,3 +34,6 @@ def tracer(self):
     def test_binary_propagation(self):
         # TODO binary codecs are not implemented at the moment
         pass
+
+    def is_parent(self, parent, span):
+        return span.parent_id == getattr(parent, 'span_id', None)