Adding trace.get_tracer (#430)

toumorokoshi · c24t · web-flow · commit 972e2abf0638 · 2020-02-19T14:15:27.000-08:00
It's fairly common to need to retrieve tracers, and as such adding the
additional tracer_source() call to every retrieval of a tracer can add to
a lot of extra boilerplate at minimal semantic value. It would be uncommon
for one to use multiple tracer_source objects, as typically one would want
all tracers to be created and behave in a similar way (e.g. passed to the
same span processor).

Co-Authored-By: Chris Kleinknecht &lt;libc@google.com&gt;
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ trace.set_preferred_tracer_source_implementation(lambda T: TracerSource())
 trace.tracer_source().add_span_processor(
     SimpleExportSpanProcessor(ConsoleSpanExporter())
 )
-tracer = trace.tracer_source().get_tracer(__name__)
+tracer = trace.get_tracer(__name__)
 with tracer.start_as_current_span('foo'):
     with tracer.start_as_current_span('bar'):
         with tracer.start_as_current_span('baz'):
diff --git a/examples/basic_tracer/tracer.py b/examples/basic_tracer/tracer.py
@@ -41,7 +41,7 @@
 # We tell OpenTelemetry who it is that is creating spans. In this case, we have
 # no real name (no setup.py), so we make one up. If we had a version, we would
 # also specify it here.
-tracer = trace.tracer_source().get_tracer(__name__)
+tracer = trace.get_tracer(__name__)
 
 # SpanExporter receives the spans and send them to the target location.
 span_processor = BatchExportSpanProcessor(exporter)
diff --git a/examples/http/server.py b/examples/http/server.py
@@ -42,7 +42,7 @@
 # The preferred tracer implementation must be set, as the opentelemetry-api
 # defines the interface with a no-op implementation.
 trace.set_preferred_tracer_source_implementation(lambda T: TracerSource())
-tracer = trace.tracer_source().get_tracer(__name__)
+tracer = trace.get_tracer(__name__)
 
 # SpanExporter receives the spans and send them to the target location.
 span_processor = BatchExportSpanProcessor(exporter)
diff --git a/examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py b/examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py
@@ -67,7 +67,7 @@ def hello():
     version = pkg_resources.get_distribution(
         "opentelemetry-example-app"
     ).version
-    tracer = trace.tracer_source().get_tracer(__name__, version)
+    tracer = trace.get_tracer(__name__, version)
     with tracer.start_as_current_span("example-request"):
         requests.get("http://www.example.com")
     return "hello"
diff --git a/examples/opentracing/main.py b/examples/opentracing/main.py
@@ -28,7 +28,7 @@
 redis_cache = RedisCache(opentracing_tracer)
 
 # Appication code uses an OpenTelemetry Tracer as usual.
-tracer = trace.tracer_source().get_tracer(__name__)
+tracer = trace.get_tracer(__name__)
 
 
 @redis_cache
diff --git a/ext/opentelemetry-ext-dbapi/README.rst b/ext/opentelemetry-ext-dbapi/README.rst
@@ -15,7 +15,7 @@ Usage
     from opentelemetry.ext.dbapi import trace_integration
 
     trace.set_preferred_tracer_source_implementation(lambda T: TracerSource())
-    tracer = trace.tracer_source().get_tracer(__name__)
+    tracer = trace.get_tracer(__name__)
     # Ex: mysql.connector
     trace_integration(tracer_source(), mysql.connector, "connect", "mysql")
 
diff --git a/ext/opentelemetry-ext-flask/src/opentelemetry/ext/flask/__init__.py b/ext/opentelemetry-ext-flask/src/opentelemetry/ext/flask/__init__.py
@@ -61,7 +61,7 @@ def _before_flask_request():
         otel_wsgi.get_header_from_environ, environ
     )
 
-    tracer = trace.tracer_source().get_tracer(__name__, __version__)
+    tracer = trace.get_tracer(__name__, __version__)
 
     attributes = otel_wsgi.collect_request_attributes(environ)
     if flask_request.url_rule:
diff --git a/ext/opentelemetry-ext-jaeger/README.rst b/ext/opentelemetry-ext-jaeger/README.rst
@@ -36,7 +36,7 @@ gRPC is still not supported by this implementation.
     from opentelemetry.sdk.trace.export import BatchExportSpanProcessor
 
     trace.set_preferred_tracer_source_implementation(lambda T: TracerSource())
-    tracer = trace.tracer_source().get_tracer(__name__)
+    tracer = trace.get_tracer(__name__)
 
     # create a JaegerSpanExporter
     jaeger_exporter = jaeger.JaegerSpanExporter(
diff --git a/ext/opentelemetry-ext-jaeger/examples/jaeger_exporter_example.py b/ext/opentelemetry-ext-jaeger/examples/jaeger_exporter_example.py
@@ -6,7 +6,7 @@
 from opentelemetry.sdk.trace.export import BatchExportSpanProcessor
 
 trace.set_preferred_tracer_source_implementation(lambda T: TracerSource())
-tracer = trace.tracer_source().get_tracer(__name__)
+tracer = trace.get_tracer(__name__)
 
 # create a JaegerSpanExporter
 jaeger_exporter = jaeger.JaegerSpanExporter(
diff --git a/ext/opentelemetry-ext-opentracing-shim/src/opentelemetry/ext/opentracing_shim/__init__.py b/ext/opentelemetry-ext-opentracing-shim/src/opentelemetry/ext/opentracing_shim/__init__.py
@@ -36,7 +36,7 @@
     trace.set_preferred_tracer_source_implementation(lambda T: TracerSource())
 
     # Create an OpenTelemetry Tracer.
-    otel_tracer = trace.tracer_source().get_tracer(__name__)
+    otel_tracer = trace.get_tracer(__name__)
 
     # Create an OpenTracing shim.
     shim = create_tracer(otel_tracer)
diff --git a/ext/opentelemetry-ext-psycopg2/README.rst b/ext/opentelemetry-ext-psycopg2/README.rst
@@ -16,7 +16,7 @@ Usage
     from opentelemetry.trace.ext.psycopg2 import trace_integration
 
     trace.set_preferred_tracer_source_implementation(lambda T: TracerSource())
-    tracer = trace.tracer_source().get_tracer(__name__)
+    tracer = trace.get_tracer(__name__)
     trace_integration(tracer)
     cnx = psycopg2.connect(database='Database')
     cursor = cnx.cursor()
diff --git a/ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py b/ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py
@@ -162,7 +162,7 @@ class OpenTelemetryMiddleware:
 
     def __init__(self, wsgi):
         self.wsgi = wsgi
-        self.tracer = trace.tracer_source().get_tracer(__name__, __version__)
+        self.tracer = trace.get_tracer(__name__, __version__)
 
     @staticmethod
     def _create_start_response(span, start_response):
diff --git a/ext/opentelemetry-ext-zipkin/README.rst b/ext/opentelemetry-ext-zipkin/README.rst
@@ -34,7 +34,7 @@ This exporter always send traces to the configured Zipkin collector using HTTP.
     from opentelemetry.sdk.trace.export import BatchExportSpanProcessor
 
     trace.set_preferred_tracer_source_implementation(lambda T: TracerSource())
-    tracer = trace.tracer_source().get_tracer(__name__)
+    tracer = trace.get_tracer(__name__)
 
     # create a ZipkinSpanExporter
     zipkin_exporter = zipkin.ZipkinSpanExporter(
diff --git a/opentelemetry-api/src/opentelemetry/trace/__init__.py b/opentelemetry-api/src/opentelemetry/trace/__init__.py
@@ -36,7 +36,7 @@
 
     from opentelemetry import trace
 
-    tracer = trace.tracer_source().get_tracer(__name__)
+    tracer = trace.get_tracer(__name__)
 
     # Create a new root span, set it as the current span in context
     with tracer.start_as_current_span("parent"):
@@ -68,13 +68,16 @@
 
 import abc
 import enum
+import logging
 import types as python_types
 import typing
 from contextlib import contextmanager
 
 from opentelemetry.trace.status import Status
 from opentelemetry.util import loader, types
 
+logger = logging.getLogger(__name__)
+
 # TODO: quarantine
 ParentSpan = typing.Optional[typing.Union["Span", "SpanContext"]]
 
@@ -647,6 +650,19 @@ def use_span(
 _TRACER_SOURCE_FACTORY = None  # type: typing.Optional[ImplementationFactory]
 
 
+def get_tracer(
+    instrumenting_module_name: str, instrumenting_library_version: str = ""
+) -> "Tracer":
+    """Returns a `Tracer` for use by the given instrumentation library.
+
+    This function is a convenience wrapper for
+    opentelemetry.trace.tracer_source().get_tracer
+    """
+    return tracer_source().get_tracer(
+        instrumenting_module_name, instrumenting_library_version
+    )
+
+
 def tracer_source() -> TracerSource:
     """Gets the current global :class:`~.TracerSource` object.
 
@@ -663,6 +679,10 @@ def tracer_source() -> TracerSource:
         except TypeError:
             # if we raised an exception trying to instantiate an
             # abstract class, default to no-op tracer impl
+            logger.warning(
+                "Unable to instantiate TracerSource from tracer source factory.",
+                exc_info=True,
+            )
             _TRACER_SOURCE = DefaultTracerSource()
         del _TRACER_SOURCE_FACTORY
 
diff --git a/opentelemetry-api/tests/trace/test_globals.py b/opentelemetry-api/tests/trace/test_globals.py
@@ -0,0 +1,41 @@
+import importlib
+import unittest
+
+from opentelemetry import trace
+
+
+class TestGlobals(unittest.TestCase):
+    def setUp(self):
+        importlib.reload(trace)
+
+        # this class has to be declared after the importlib
+        # reload, or else it will inherit from an old
+        # TracerSource, rather than the new TraceSource ABC.
+        # created from reload.
+
+        static_tracer = trace.DefaultTracer()
+
+        class DummyTracerSource(trace.TracerSource):
+            """TraceSource used for testing"""
+
+            def get_tracer(
+                self,
+                instrumenting_module_name: str,
+                instrumenting_library_version: str = "",
+            ) -> trace.Tracer:
+                # pylint:disable=no-self-use,unused-argument
+                return static_tracer
+
+        trace.set_preferred_tracer_source_implementation(
+            lambda _: DummyTracerSource()
+        )
+
+    @staticmethod
+    def tearDown() -> None:
+        importlib.reload(trace)
+
+    def test_get_tracer(self):
+        """trace.get_tracer should proxy to the global tracer source."""
+        from_global_api = trace.get_tracer("foo")
+        from_tracer_api = trace.tracer_source().get_tracer("foo")
+        self.assertIs(from_global_api, from_tracer_api)

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ trace.set_preferred_tracer_source_implementation(lambda T: TracerSource())`
`59`	`59`	`trace.tracer_source().add_span_processor(`
`60`	`60`	`SimpleExportSpanProcessor(ConsoleSpanExporter())`
`61`	`61`	`)`
`62`		`-tracer = trace.tracer_source().get_tracer(__name__)`
	`62`	`+tracer = trace.get_tracer(__name__)`
`63`	`63`	`with tracer.start_as_current_span('foo'):`
`64`	`64`	`with tracer.start_as_current_span('bar'):`
`65`	`65`	`with tracer.start_as_current_span('baz'):`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ def _before_flask_request():`
`61`	`61`	`otel_wsgi.get_header_from_environ, environ`
`62`	`62`	`)`
`63`	`63`
`64`		`- tracer = trace.tracer_source().get_tracer(__name__, __version__)`
	`64`	`+ tracer = trace.get_tracer(__name__, __version__)`
`65`	`65`
`66`	`66`	`attributes = otel_wsgi.collect_request_attributes(environ)`
`67`	`67`	`if flask_request.url_rule:`