libname -> module name

Author: Oberon00

README.md

@@ -60,7 +60,7 @@ trace.set_preferred_tracer_source_implementation(lambda T: TracerSource())
 trace.tracer_source().add_span_processor(
     SimpleExportSpanProcessor(ConsoleSpanExporter())
 )
-tracer = trace.tracer_source().get_tracer("myapp")
+tracer = trace.tracer_source().get_tracer(__name__)
 with tracer.start_as_current_span('foo'):
     with tracer.start_as_current_span('bar'):
         with tracer.start_as_current_span('baz'):

examples/basic_tracer/tracer.py

@@ -42,9 +42,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(
-    "opentelemetry-examples-basic-tracer"
-)
+tracer = trace.tracer_source().get_tracer(__name__)
 
 # SpanExporter receives the spans and send them to the target location.
 span_processor = BatchExportSpanProcessor(exporter)

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("opentelemetry-example-http")
+tracer = trace.tracer_source().get_tracer(__name__)
 
 # SpanExporter receives the spans and send them to the target location.
 span_processor = BatchExportSpanProcessor(exporter)

examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py

@@ -71,9 +71,7 @@ def hello():
     version = pkg_resources.get_distribution(
         "opentelemetry-example-app"
     ).version
-    tracer = trace.tracer_source().get_tracer(
-        "opentelemetry-example-app", version
-    )
+    tracer = trace.tracer_source().get_tracer(__name__, version)
     with tracer.start_as_current_span("example-request"):
         requests.get("http://www.example.com")
     return "hello"

ext/opentelemetry-ext-flask/src/opentelemetry/ext/flask/__init__.py

@@ -61,9 +61,7 @@ def _before_flask_request():
         otel_wsgi.get_header_from_environ, environ
     )
 
-    tracer = trace.tracer_source().get_tracer(
-        "opentelemetry-ext-flask", __version__
-    )
+    tracer = trace.tracer_source().get_tracer(__name__, __version__)
 
     attributes = otel_wsgi.collect_request_attributes(environ)
     if flask_request.url_rule:

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py

@@ -48,9 +48,7 @@ def enable(tracer_source):
     # Guard against double instrumentation
     disable()
 
-    tracer = tracer_source.get_tracer(
-        "opentelemetry-ext-http-requests", __version__
-    )
+    tracer = tracer_source.get_tracer(__name__, __version__)
 
     wrapped = Session.request
 

ext/opentelemetry-ext-http-requests/tests/test_requests_integration.py

@@ -55,7 +55,6 @@ def setspanattr(key, value):
             spec_set=True,
             return_value=self.span_context_manager,
         )
-        self.start_as_current_span = self.start_span_patcher.start()
 
         mocked_response = requests.models.Response()
         mocked_response.status_code = 200
@@ -67,15 +66,16 @@ def setspanattr(key, value):
             spec_set=True,
             return_value=mocked_response,
         )
+
+        self.start_as_current_span = self.start_span_patcher.start()
         self.send = self.send_patcher.start()
 
         opentelemetry.ext.http_requests.enable(self.tracer_source)
         distver = pkg_resources.get_distribution(
             "opentelemetry-ext-http-requests"
         ).version
         self.get_tracer.assert_called_with(
-            "opentelemetry-ext-http-requests", distver
-        )
+            opentelemetry.ext.http_requests.__name__, distver)
 
     def tearDown(self):
         opentelemetry.ext.http_requests.disable()

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("myapp")
+    tracer = trace.tracer_source().get_tracer(__name__)
 
     # create a JaegerSpanExporter
     jaeger_exporter = jaeger.JaegerSpanExporter(

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("myapp")
+tracer = trace.tracer_source().get_tracer(__name__)
 
 # create a JaegerSpanExporter
 jaeger_exporter = jaeger.JaegerSpanExporter(

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("myapp")
+    otel_tracer = trace.tracer_source().get_tracer(__name__)
 
     # Create an OpenTracing shim.
     shim = create_tracer(otel_tracer)
@@ -110,11 +110,7 @@ def create_tracer(otel_tracer_source):
         The created :class:`TracerShim`.
     """
 
-    return TracerShim(
-        otel_tracer_source.get_tracer(
-            "opentelemetry-ext-opentracing-shim", __version__
-        )
-    )
+    return TracerShim(otel_tracer_source.get_tracer(__name__, __version__))
 
 
 class SpanContextShim(opentracing.SpanContext):

ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py

@@ -164,9 +164,7 @@ class OpenTelemetryMiddleware:
 
     def __init__(self, wsgi):
         self.wsgi = wsgi
-        self.tracer = trace.tracer_source().get_tracer(
-            "opentelemetry-ext-wsgi", __version__
-        )
+        self.tracer = trace.tracer_source().get_tracer(__name__, __version__)
 
     @staticmethod
     def _create_start_response(span, start_response):

opentelemetry-api/src/opentelemetry/trace/__init__.py

@@ -27,7 +27,7 @@
 
 To get a tracer, you need to provide the package name from which you are
 calling the tracer APIs to OpenTelemetry by calling `TracerSource.get_tracer`
-with the name and version of your package.
+with the calling module name and the version of your package.
 
 The tracer supports creating spans that are "attached" or "detached" from the
 context. New spans are "attached" to the context in that they are
@@ -36,7 +36,7 @@
 
     from opentelemetry import trace
 
-    tracer = trace.tracer_source().get_tracer("my-instrumentation-library")
+    tracer = trace.tracer_source().get_tracer(__name__)
 
     # Create a new root span, set it as the current span in context
     with tracer.start_as_current_span("parent"):
@@ -378,7 +378,7 @@ class TracerSource:
     # pylint:disable=no-self-use,unused-argument
     def get_tracer(
         self,
-        instrumenting_library_name: str,
+        instrumenting_module_name: str,
         instrumenting_library_version: str = "",
     ) -> "Tracer":
         """Returns a `Tracer` for use by the given instrumentation library.
@@ -390,14 +390,13 @@ def get_tracer(
         vs.  a functional tracer).
 
         Args:
-            instrumenting_library_name: The name of the instrumenting library.
-                This should *not* be the name of the library that is
-                instrumented but the name of the instrumentation library.
-                E.g., instead of ``"requests"``,
-                ``"opentelemetry-ext-http-requests"``.
-
-                This should be the ``pip install``-able name of the library
-                rather than the module name (see also the next argument).
+            instrumenting_module_name: The name of the instrumenting module
+                (usually just ``__name__``).
+
+                This should *not* be the name of the module that is
+                instrumented but the name of the module doing the instrumentation.
+                E.g., instead of ``"requests"``, use
+                ``"opentelemetry.ext.http_requests"``.
 
             instrumenting_library_version: Optional. The version string of the
                 instrumenting library.  Usually this should be the same as

opentelemetry-api/tests/test_implementation.py

@@ -27,7 +27,7 @@ class TestAPIOnlyImplementation(unittest.TestCase):
 
     def test_tracer(self):
         tracer_source = trace.TracerSource()
-        tracer = tracer_source.get_tracer("opentelemetry-api")
+        tracer = tracer_source.get_tracer(__name__)
         with tracer.start_span("test") as span:
             self.assertEqual(span.get_context(), trace.INVALID_SPAN_CONTEXT)
             self.assertEqual(span, trace.INVALID_SPAN)

opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py

@@ -329,7 +329,7 @@ def generate_trace_id() -> int:
 
 
 class InstrumentationInfo:
-    """Immutable information about an instrumentation library.
+    """Immutable information about an instrumentation library module.
 
     See `TracerSource.get_tracer` for the meaning of the properties.
     """
@@ -516,16 +516,16 @@ def __init__(
 
     def get_tracer(
         self,
-        instrumenting_library_name: str,
+        instrumenting_module_name: str,
         instrumenting_library_version: str = "",
     ) -> "trace_api.Tracer":
-        if not instrumenting_library_name:  # Reject empty strings too.
-            instrumenting_library_name = "ERROR:MISSING LIB NAME"
-            logger.error("get_tracer called with missing library name.")
+        if not instrumenting_module_name:  # Reject empty strings too.
+            instrumenting_module_name = "ERROR:MISSING MODULE NAME"
+            logger.error("get_tracer called with missing module name.")
         return Tracer(
             self,
             InstrumentationInfo(
-                instrumenting_library_name, instrumenting_library_version
+                instrumenting_module_name, instrumenting_library_version
             ),
         )
 

opentelemetry-sdk/tests/test_implementation.py

@@ -28,7 +28,7 @@ class TestSDKImplementation(unittest.TestCase):
     """
 
     def test_tracer(self):
-        tracer = trace.TracerSource().get_tracer("opentelemetery-sdk")
+        tracer = trace.TracerSource().get_tracer(__name__)
         with tracer.start_span("test") as span:
             self.assertNotEqual(span.get_context(), INVALID_SPAN_CONTEXT)
             self.assertNotEqual(span, INVALID_SPAN)

opentelemetry-sdk/tests/trace/export/test_export.py

@@ -45,7 +45,7 @@ def shutdown(self):
 class TestSimpleExportSpanProcessor(unittest.TestCase):
     def test_simple_span_processor(self):
         tracer_source = trace.TracerSource()
-        tracer = tracer_source.get_tracer("opentelemetry-sdk")
+        tracer = tracer_source.get_tracer(__name__)
 
         spans_names_list = []
 
@@ -70,7 +70,7 @@ def test_simple_span_processor_no_context(self):
         not it is ever the active span.
         """
         tracer_source = trace.TracerSource()
-        tracer = tracer_source.get_tracer("opentelemetry-sdk")
+        tracer = tracer_source.get_tracer(__name__)
 
         spans_names_list = []
 

opentelemetry-sdk/tests/trace/export/test_in_memory_span_exporter.py

@@ -26,7 +26,7 @@
 class TestInMemorySpanExporter(unittest.TestCase):
     def setUp(self):
         self.tracer_source = trace.TracerSource()
-        self.tracer = self.tracer_source.get_tracer("opentelemetry-sdk")
+        self.tracer = self.tracer_source.get_tracer(__name__)
         self.memory_exporter = InMemorySpanExporter()
         span_processor = export.SimpleExportSpanProcessor(self.memory_exporter)
         self.tracer_source.add_span_processor(span_processor)

opentelemetry-sdk/tests/trace/test_trace.py

@@ -25,7 +25,7 @@
 
 
 def new_tracer() -> trace_api.Tracer:
-    return trace.TracerSource().get_tracer("opentelemetry-sdk")
+    return trace.TracerSource().get_tracer(__name__)
 
 
 class TestTracer(unittest.TestCase):
@@ -119,7 +119,7 @@ def test_default_sampler(self):
 
     def test_sampler_no_sampling(self):
         tracer_source = trace.TracerSource(sampling.ALWAYS_OFF)
-        tracer = tracer_source.get_tracer("opentelemetry-sdk")
+        tracer = tracer_source.get_tracer(__name__)
 
         # Check that the default tracer creates no-op spans if the sampler
         # decides not to sampler
@@ -179,7 +179,7 @@ def test_invalid_instrumentation_info(self):
         self.assertTrue(span1.is_recording_events())
         self.assertEqual(tracer1.instrumentation_info.version, "")
         self.assertEqual(
-            tracer1.instrumentation_info.name, "ERROR:MISSING LIB NAME"
+            tracer1.instrumentation_info.name, "ERROR:MISSING MODULE NAME"
         )
 
     def test_span_processor_for_source(self):
@@ -404,7 +404,7 @@ def test_sampling_attributes(self):
             )
         )
 
-        self.tracer = tracer_source.get_tracer("opentelemetry-sdk")
+        self.tracer = tracer_source.get_tracer(__name__)
 
         with self.tracer.start_as_current_span("root2") as root:
             self.assertEqual(len(root.attributes), 2)
@@ -578,9 +578,9 @@ def test_ended_span(self):
 
     def test_error_status(self):
         try:
-            with trace.TracerSource().get_tracer(
-                "opentelemetry-sdk"
-            ).start_span("root") as root:
+            with trace.TracerSource().get_tracer(__name__).start_span(
+                "root"
+            ) as root:
                 raise Exception("unknown")
         except Exception:  # pylint: disable=broad-except
             pass
@@ -612,7 +612,7 @@ def on_end(self, span: "trace.Span") -> None:
 class TestSpanProcessor(unittest.TestCase):
     def test_span_processor(self):
         tracer_source = trace.TracerSource()
-        tracer = tracer_source.get_tracer("opentelemetry-sdk")
+        tracer = tracer_source.get_tracer(__name__)
 
         spans_calls_list = []  # filled by MySpanProcessor
         expected_list = []  # filled by hand
@@ -681,7 +681,7 @@ def test_span_processor(self):
 
     def test_add_span_processor_after_span_creation(self):
         tracer_source = trace.TracerSource()
-        tracer = tracer_source.get_tracer("opentelemetry-sdk")
+        tracer = tracer_source.get_tracer(__name__)
 
         spans_calls_list = []  # filled by MySpanProcessor
         expected_list = []  # filled by hand