Move opentracing-shim folder out of instrumentation folder (#1533)

open-telemetry · Jan 19, 2021 · 2fb7dba · 2fb7dba
1 parent 89fb4e5
commit 2fb7dba
Show file tree

Hide file tree

Showing 60 changed files with 31 additions and 35 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -53,6 +53,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#1516](https://github.com/open-telemetry/opentelemetry-python/pull/1516))
 - `opentelemetry-exporter-zipkin` Update boolean attribute value transformation
   ([#1509](https://github.com/open-telemetry/opentelemetry-python/pull/1509))
+- Move opentelemetry-opentracing-shim out of instrumentation folder
+  ([#1533](https://github.com/open-telemetry/opentelemetry-python/pull/1533))
 - `opentelemetry-sdk` The JaegerPropagator has been moved into its own package: `opentelemetry-propagator-jaeger`
   ([#1525](https://github.com/open-telemetry/opentelemetry-python/pull/1525))
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -35,14 +35,14 @@
     if isdir(join(exp, f))
 ]
 
-instr = "../instrumentation"
-instr_dirs = [
-    os.path.abspath("/".join(["../instrumentation", f, "src"]))
-    for f in listdir(instr)
-    if isdir(join(instr, f))
+shim = "../shim"
+shim_dirs = [
+    os.path.abspath("/".join(["../shim", f, "src"]))
+    for f in listdir(shim)
+    if isdir(join(shim, f))
 ]
 
-sys.path[:0] = source_dirs + exp_dirs + instr_dirs
+sys.path[:0] = source_dirs + exp_dirs + shim_dirs
 
 # -- Project information -----------------------------------------------------
 

diff --git a/docs/examples/opentracing/README.rst b/docs/examples/opentracing/README.rst
@@ -1,8 +1,8 @@
 OpenTracing Shim Example
 ==========================
 
-This example shows how to use the :doc:`opentelemetry-instrumentation-opentracing-shim
-package <../../instrumentation/opentracing_shim/opentracing_shim>`
+This example shows how to use the :doc:`opentelemetry-opentracing-shim
+package <../../shim/opentracing_shim/opentracing_shim>`
 to interact with libraries instrumented with
 `opentracing-python <https://github.com/opentracing/opentracing-python>`_.
 
@@ -100,6 +100,6 @@ Useful links
 ------------
 
 - OpenTelemetry_
-- :doc:`../../instrumentation/opentracing_shim/opentracing_shim`
+- :doc:`../../shim/opentracing_shim/opentracing_shim`
 
 .. _OpenTelemetry: https://github.com/open-telemetry/opentelemetry-python/
diff --git a/docs/examples/opentracing/main.py b/docs/examples/opentracing/main.py
@@ -4,9 +4,9 @@
 
 from opentelemetry import trace
 from opentelemetry.exporter.jaeger import JaegerSpanExporter
-from opentelemetry.instrumentation import opentracing_shim
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor
+from opentelemetry.shim import opentracing_shim
 
 # Configure the tracer using the default implementation
 trace.set_tracer_provider(TracerProvider())

diff --git a/docs/index.rst b/docs/index.rst
@@ -73,7 +73,6 @@ install <https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs>
 
     api/api
     sdk/sdk
-    instrumentation/instrumentation
 
 .. toctree::
     :maxdepth: 2
@@ -85,11 +84,11 @@ install <https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs>
 
 .. toctree::
     :maxdepth: 2
-    :caption: OpenTelemetry Instrumentations
-    :name: Instrumentations
+    :caption: OpenTelemetry Shims
+    :name: Shims
     :glob:
 
-    instrumentation/**
+    shim/**
 
 .. toctree::
     :maxdepth: 1

diff --git a/docs/instrumentation/instrumentation.rst → docs/shim/instrumentation.rst b/docs/instrumentation/instrumentation.rst → docs/shim/instrumentation.rst
diff --git a/docs/instrumentation/instrumentor.rst → docs/shim/instrumentor.rst b/docs/instrumentation/instrumentor.rst → docs/shim/instrumentor.rst
diff --git a/docs/instrumentation/metric.rst → docs/shim/metric.rst b/docs/instrumentation/metric.rst → docs/shim/metric.rst
diff --git a/...ion/opentracing_shim/opentracing_shim.rst → ...him/opentracing_shim/opentracing_shim.rst b/...ion/opentracing_shim/opentracing_shim.rst → ...him/opentracing_shim/opentracing_shim.rst
@@ -1,5 +1,5 @@
 OpenTracing Shim for OpenTelemetry
 ==================================
 
-.. automodule:: opentelemetry.instrumentation.opentracing_shim
+.. automodule:: opentelemetry.shim.opentracing_shim
    :no-show-inheritance:
diff --git a/...-instrumentation-opentracing-shim/LICENSE → shim/opentelemetry-opentracing-shim/LICENSE b/...-instrumentation-opentracing-shim/LICENSE → shim/opentelemetry-opentracing-shim/LICENSE
diff --git a/...trumentation-opentracing-shim/MANIFEST.in → ...pentelemetry-opentracing-shim/MANIFEST.in b/...trumentation-opentracing-shim/MANIFEST.in → ...pentelemetry-opentracing-shim/MANIFEST.in
diff --git a/...strumentation-opentracing-shim/README.rst → ...opentelemetry-opentracing-shim/README.rst b/...strumentation-opentracing-shim/README.rst → ...opentelemetry-opentracing-shim/README.rst
@@ -16,5 +16,5 @@ Installation
 References
 ----------
 
-* `OpenTracing Shim for OpenTelemetry <https://opentelemetry-python.readthedocs.io/en/latest/instrumentation/opentracing_shim/opentracing_shim.html>`_
+* `OpenTracing Shim for OpenTelemetry <https://opentelemetry-python.readthedocs.io/en/latest/shim/opentracing_shim/opentracing_shim.html>`_
 * `OpenTelemetry Project <https://opentelemetry.io/>`_
diff --git a/...nstrumentation-opentracing-shim/setup.cfg → .../opentelemetry-opentracing-shim/setup.cfg b/...nstrumentation-opentracing-shim/setup.cfg → .../opentelemetry-opentracing-shim/setup.cfg
diff --git a/...instrumentation-opentracing-shim/setup.py → shim/opentelemetry-opentracing-shim/setup.py b/...instrumentation-opentracing-shim/setup.py → shim/opentelemetry-opentracing-shim/setup.py
@@ -17,12 +17,7 @@
 
 BASE_DIR = os.path.dirname(__file__)
 VERSION_FILENAME = os.path.join(
-    BASE_DIR,
-    "src",
-    "opentelemetry",
-    "instrumentation",
-    "opentracing_shim",
-    "version.py",
+    BASE_DIR, "src", "opentelemetry", "shim", "opentracing_shim", "version.py",
 )
 PACKAGE_INFO = {}
 with open(VERSION_FILENAME) as f:

diff --git a/...trumentation/opentracing_shim/__init__.py → ...lemetry/shim/opentracing_shim/__init__.py b/...trumentation/opentracing_shim/__init__.py → ...lemetry/shim/opentracing_shim/__init__.py
@@ -30,7 +30,7 @@
 
     from opentelemetry import trace
     from opentelemetry.sdk.trace import TracerProvider
-    from opentelemetry.instrumentation.opentracing_shim import create_tracer
+    from opentelemetry.shim.opentracing_shim import create_tracer
 
     # Define which OpenTelemetry Tracer provider implementation to use.
     trace.set_tracer_provider(TracerProvider())
@@ -102,8 +102,8 @@
 from opentelemetry import propagators
 from opentelemetry.baggage import get_baggage, set_baggage
 from opentelemetry.context import Context, attach, detach, get_value, set_value
-from opentelemetry.instrumentation.opentracing_shim import util
-from opentelemetry.instrumentation.opentracing_shim.version import __version__
+from opentelemetry.shim.opentracing_shim import util
+from opentelemetry.shim.opentracing_shim.version import __version__
 from opentelemetry.trace import INVALID_SPAN_CONTEXT, DefaultSpan, Link
 from opentelemetry.trace import SpanContext as OtelSpanContext
 from opentelemetry.trace import Tracer as OtelTracer

diff --git a/.../instrumentation/opentracing_shim/util.py → ...entelemetry/shim/opentracing_shim/util.py b/.../instrumentation/opentracing_shim/util.py → ...entelemetry/shim/opentracing_shim/util.py
diff --git a/...strumentation/opentracing_shim/version.py → ...elemetry/shim/opentracing_shim/version.py b/...strumentation/opentracing_shim/version.py → ...elemetry/shim/opentracing_shim/version.py
diff --git a/...tation-opentracing-shim/tests/__init__.py → ...emetry-opentracing-shim/tests/__init__.py b/...tation-opentracing-shim/tests/__init__.py → ...emetry-opentracing-shim/tests/__init__.py
diff --git a/...ation-opentracing-shim/tests/test_shim.py → ...metry-opentracing-shim/tests/test_shim.py b/...ation-opentracing-shim/tests/test_shim.py → ...metry-opentracing-shim/tests/test_shim.py
@@ -22,13 +22,13 @@
 import opentracing
 
 from opentelemetry import propagators, trace
-from opentelemetry.instrumentation.opentracing_shim import (
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.shim.opentracing_shim import (
     SpanContextShim,
     SpanShim,
     create_tracer,
     util,
 )
-from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.test.mock_textmap import (
     MockTextMapPropagator,
     NOOPTextMapPropagator,
@@ -137,7 +137,7 @@ def test_explicit_start_time(self):
         with self.shim.start_active_span("TestSpan4", start_time=now) as scope:
             result = util.time_seconds_from_ns(scope.span.unwrap().start_time)
             # Tolerate inaccuracies of less than a microsecond. See Note:
-            # https://open-telemetry.github.io/opentelemetry-python/opentelemetry.instrumentation.opentracing_shim.html
+            # https://open-telemetry.github.io/opentelemetry-python/opentelemetry.shim.opentracing_shim.html
             # TODO: This seems to work consistently, but we should find out the
             # biggest possible loss of precision.
             self.assertAlmostEqual(result, now, places=6)
@@ -151,7 +151,7 @@ def test_explicit_end_time(self):
 
         end_time = util.time_seconds_from_ns(span.unwrap().end_time)
         # Tolerate inaccuracies of less than a microsecond. See Note:
-        # https://open-telemetry.github.io/opentelemetry-python/opentelemetry.instrumentation.opentracing_shim.html
+        # https://open-telemetry.github.io/opentelemetry-python/opentelemetry.shim.opentracing_shim.html
         # TODO: This seems to work consistently, but we should find out the
         # biggest possible loss of precision.
         self.assertAlmostEqual(end_time, now, places=6)
@@ -431,7 +431,7 @@ def test_log_kv(self):
             )
             self.assertEqual(span.unwrap().events[1].attributes["foo"], "bar")
             # Tolerate inaccuracies of less than a microsecond. See Note:
-            # https://open-telemetry.github.io/opentelemetry-python/instrumentation/opentracing_shim/opentracing_shim.html
+            # https://open-telemetry.github.io/opentelemetry-python/shim/opentracing_shim/opentracing_shim.html
             # TODO: This seems to work consistently, but we should find out the
             # biggest possible loss of precision.
             self.assertAlmostEqual(result, now, places=6)

diff --git a/...ation-opentracing-shim/tests/test_util.py → ...metry-opentracing-shim/tests/test_util.py b/...ation-opentracing-shim/tests/test_util.py → ...metry-opentracing-shim/tests/test_util.py
@@ -15,7 +15,7 @@
 import time
 import unittest
 
-from opentelemetry.instrumentation.opentracing_shim import util
+from opentelemetry.shim.opentracing_shim import util
 from opentelemetry.util import time_ns
 
 

diff --git a/...opentracing-shim/tests/testbed/README.rst → ...opentracing-shim/tests/testbed/README.rst b/...opentracing-shim/tests/testbed/README.rst → ...opentracing-shim/tests/testbed/README.rst
diff --git a/...pentracing-shim/tests/testbed/__init__.py → ...pentracing-shim/tests/testbed/__init__.py b/...pentracing-shim/tests/testbed/__init__.py → ...pentracing-shim/tests/testbed/__init__.py
diff --git a/...shim/tests/testbed/otel_ot_shim_tracer.py → ...shim/tests/testbed/otel_ot_shim_tracer.py b/...shim/tests/testbed/otel_ot_shim_tracer.py → ...shim/tests/testbed/otel_ot_shim_tracer.py
@@ -1,4 +1,4 @@
-import opentelemetry.instrumentation.opentracing_shim as opentracingshim
+import opentelemetry.shim.opentracing_shim as opentracingshim
 from opentelemetry.sdk import trace
 from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor
 from opentelemetry.sdk.trace.export.in_memory_span_exporter import (

diff --git a/...d/test_active_span_replacement/README.rst → ...d/test_active_span_replacement/README.rst b/...d/test_active_span_replacement/README.rst → ...d/test_active_span_replacement/README.rst
diff --git a/.../test_active_span_replacement/__init__.py → .../test_active_span_replacement/__init__.py b/.../test_active_span_replacement/__init__.py → .../test_active_span_replacement/__init__.py
diff --git a/...t_active_span_replacement/test_asyncio.py → ...t_active_span_replacement/test_asyncio.py b/...t_active_span_replacement/test_asyncio.py → ...t_active_span_replacement/test_asyncio.py
diff --git a/...t_active_span_replacement/test_threads.py → ...t_active_span_replacement/test_threads.py b/...t_active_span_replacement/test_threads.py → ...t_active_span_replacement/test_threads.py
diff --git a/...sts/testbed/test_client_server/README.rst → ...sts/testbed/test_client_server/README.rst b/...sts/testbed/test_client_server/README.rst → ...sts/testbed/test_client_server/README.rst
diff --git a/...ts/testbed/test_client_server/__init__.py → ...ts/testbed/test_client_server/__init__.py b/...ts/testbed/test_client_server/__init__.py → ...ts/testbed/test_client_server/__init__.py
diff --git a/...estbed/test_client_server/test_asyncio.py → ...estbed/test_client_server/test_asyncio.py b/...estbed/test_client_server/test_asyncio.py → ...estbed/test_client_server/test_asyncio.py
diff --git a/...estbed/test_client_server/test_threads.py → ...estbed/test_client_server/test_threads.py b/...estbed/test_client_server/test_threads.py → ...estbed/test_client_server/test_threads.py
diff --git a/...ed/test_common_request_handler/README.rst → ...ed/test_common_request_handler/README.rst b/...ed/test_common_request_handler/README.rst → ...ed/test_common_request_handler/README.rst
diff --git a/...d/test_common_request_handler/__init__.py → ...d/test_common_request_handler/__init__.py b/...d/test_common_request_handler/__init__.py → ...d/test_common_request_handler/__init__.py
diff --git a/...common_request_handler/request_handler.py → ...common_request_handler/request_handler.py b/...common_request_handler/request_handler.py → ...common_request_handler/request_handler.py
diff --git a/...st_common_request_handler/test_asyncio.py → ...st_common_request_handler/test_asyncio.py b/...st_common_request_handler/test_asyncio.py → ...st_common_request_handler/test_asyncio.py
diff --git a/...st_common_request_handler/test_threads.py → ...st_common_request_handler/test_threads.py b/...st_common_request_handler/test_threads.py → ...st_common_request_handler/test_threads.py
diff --git a/.../testbed/test_late_span_finish/README.rst → .../testbed/test_late_span_finish/README.rst b/.../testbed/test_late_span_finish/README.rst → .../testbed/test_late_span_finish/README.rst
diff --git a/...testbed/test_late_span_finish/__init__.py → ...testbed/test_late_span_finish/__init__.py b/...testbed/test_late_span_finish/__init__.py → ...testbed/test_late_span_finish/__init__.py
diff --git a/...bed/test_late_span_finish/test_asyncio.py → ...bed/test_late_span_finish/test_asyncio.py b/...bed/test_late_span_finish/test_asyncio.py → ...bed/test_late_span_finish/test_asyncio.py
diff --git a/...bed/test_late_span_finish/test_threads.py → ...bed/test_late_span_finish/test_threads.py b/...bed/test_late_span_finish/test_threads.py → ...bed/test_late_span_finish/test_threads.py
diff --git a/...tbed/test_listener_per_request/README.rst → ...tbed/test_listener_per_request/README.rst b/...tbed/test_listener_per_request/README.rst → ...tbed/test_listener_per_request/README.rst
diff --git a/...bed/test_listener_per_request/__init__.py → ...bed/test_listener_per_request/__init__.py b/...bed/test_listener_per_request/__init__.py → ...bed/test_listener_per_request/__init__.py
diff --git a/...listener_per_request/response_listener.py → ...listener_per_request/response_listener.py b/...listener_per_request/response_listener.py → ...listener_per_request/response_listener.py
diff --git a/...test_listener_per_request/test_asyncio.py → ...test_listener_per_request/test_asyncio.py b/...test_listener_per_request/test_asyncio.py → ...test_listener_per_request/test_asyncio.py
diff --git a/...test_listener_per_request/test_threads.py → ...test_listener_per_request/test_threads.py b/...test_listener_per_request/test_threads.py → ...test_listener_per_request/test_threads.py
diff --git a/...estbed/test_multiple_callbacks/README.rst → ...estbed/test_multiple_callbacks/README.rst b/...estbed/test_multiple_callbacks/README.rst → ...estbed/test_multiple_callbacks/README.rst
diff --git a/...stbed/test_multiple_callbacks/__init__.py → ...stbed/test_multiple_callbacks/__init__.py b/...stbed/test_multiple_callbacks/__init__.py → ...stbed/test_multiple_callbacks/__init__.py
diff --git a/...d/test_multiple_callbacks/test_asyncio.py → ...d/test_multiple_callbacks/test_asyncio.py b/...d/test_multiple_callbacks/test_asyncio.py → ...d/test_multiple_callbacks/test_asyncio.py
diff --git a/...d/test_multiple_callbacks/test_threads.py → ...d/test_multiple_callbacks/test_threads.py b/...d/test_multiple_callbacks/test_threads.py → ...d/test_multiple_callbacks/test_threads.py
diff --git a/.../testbed/test_nested_callbacks/README.rst → .../testbed/test_nested_callbacks/README.rst b/.../testbed/test_nested_callbacks/README.rst → .../testbed/test_nested_callbacks/README.rst
diff --git a/...testbed/test_nested_callbacks/__init__.py → ...testbed/test_nested_callbacks/__init__.py b/...testbed/test_nested_callbacks/__init__.py → ...testbed/test_nested_callbacks/__init__.py
diff --git a/...bed/test_nested_callbacks/test_asyncio.py → ...bed/test_nested_callbacks/test_asyncio.py b/...bed/test_nested_callbacks/test_asyncio.py → ...bed/test_nested_callbacks/test_asyncio.py
diff --git a/...bed/test_nested_callbacks/test_threads.py → ...bed/test_nested_callbacks/test_threads.py b/...bed/test_nested_callbacks/test_threads.py → ...bed/test_nested_callbacks/test_threads.py
diff --git a/.../test_subtask_span_propagation/README.rst → .../test_subtask_span_propagation/README.rst b/.../test_subtask_span_propagation/README.rst → .../test_subtask_span_propagation/README.rst
diff --git a/...test_subtask_span_propagation/__init__.py → ...test_subtask_span_propagation/__init__.py b/...test_subtask_span_propagation/__init__.py → ...test_subtask_span_propagation/__init__.py
diff --git a/..._subtask_span_propagation/test_asyncio.py → ..._subtask_span_propagation/test_asyncio.py b/..._subtask_span_propagation/test_asyncio.py → ..._subtask_span_propagation/test_asyncio.py
diff --git a/..._subtask_span_propagation/test_threads.py → ..._subtask_span_propagation/test_threads.py b/..._subtask_span_propagation/test_threads.py → ..._subtask_span_propagation/test_threads.py
diff --git a/...pentracing-shim/tests/testbed/testcase.py → ...pentracing-shim/tests/testbed/testcase.py b/...pentracing-shim/tests/testbed/testcase.py → ...pentracing-shim/tests/testbed/testcase.py
diff --git a/...n-opentracing-shim/tests/testbed/utils.py → ...y-opentracing-shim/tests/testbed/utils.py b/...n-opentracing-shim/tests/testbed/utils.py → ...y-opentracing-shim/tests/testbed/utils.py
diff --git a/tox.ini b/tox.ini
@@ -78,7 +78,7 @@ changedir =
   test-core-proto: opentelemetry-proto/tests
   test-core-instrumentation: opentelemetry-instrumentation/tests
   test-core-getting-started: docs/getting_started/tests
-  test-core-opentracing-shim: instrumentation/opentelemetry-instrumentation-opentracing-shim/tests
+  test-core-opentracing-shim: shim/opentelemetry-opentracing-shim/tests
 
   test-exporter-jaeger: exporter/opentelemetry-exporter-jaeger/tests
   test-exporter-opencensus: exporter/opentelemetry-exporter-opencensus/tests
@@ -111,7 +111,7 @@ commands_pre =
   exporter-jaeger: pip install {toxinidir}/exporter/opentelemetry-exporter-jaeger
 
   opentracing-shim: pip install {toxinidir}/opentelemetry-sdk
-  opentracing-shim: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-opentracing-shim
+  opentracing-shim: pip install {toxinidir}/shim/opentelemetry-opentracing-shim
 
   zipkin: pip install {toxinidir}/exporter/opentelemetry-exporter-zipkin
 
@@ -159,7 +159,7 @@ commands_pre =
   python -m pip install -e {toxinidir}/opentelemetry-sdk[test]
   python -m pip install -e {toxinidir}/opentelemetry-proto[test]
   python -m pip install -e {toxinidir}/tests/util[test]
-  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-opentracing-shim[test]
+  python -m pip install -e {toxinidir}/shim/opentelemetry-opentracing-shim[test]
   python -m pip install -e {toxinidir}/exporter/opentelemetry-exporter-jaeger[test]
   python -m pip install -e {toxinidir}/exporter/opentelemetry-exporter-opencensus[test]
   python -m pip install -e {toxinidir}/exporter/opentelemetry-exporter-otlp[test]