Instrumentation runtime checks (#475)

Author: owais

.github/workflows/test.yml

@@ -45,7 +45,7 @@ jobs:
         uses: actions/cache@v2
         with:
           path: .tox
-          key: tox-cache-${{ env.RUN_MATRIX_COMBINATION }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}
+          key: v2-build-tox-cache-${{ env.RUN_MATRIX_COMBINATION }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}
       - name: run tox
         run: tox -f ${{ matrix.python-version }}-${{ matrix.package }} -- --benchmark-json=${{ env.RUN_MATRIX_COMBINATION }}-benchmark.json
       - name: Find and merge benchmarks
@@ -99,6 +99,6 @@ jobs:
         uses: actions/cache@v2
         with:
           path: .tox
-          key: v2-tox-cache-${{ matrix.tox-environment }}-${{ hashFiles('tox.ini', 'dev-requirements.txt', 'docs-requirements.txt') }}
+          key: v2-misc-tox-cache-${{ matrix.tox-environment }}-${{ hashFiles('tox.ini', 'dev-requirements.txt', 'docs-requirements.txt') }}
       - name: run tox
         run: tox -e ${{ matrix.tox-environment }}

CHANGELOG.md

@@ -21,6 +21,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.21b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.2.0-0.21b0) - 2021-05-11
 
 ### Changed
+- Instrumentation packages don't specify the libraries they instrument as dependencies
+  anymore. Instead, they verify the correct version of libraries are installed at runtime.
+  ([#475](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/475))
 - `opentelemetry-propagator-ot-trace` Use `TraceFlags` object in `extract`
   ([#472](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/472))
 - Set the `traced_request_attrs` of FalconInstrumentor by an argument correctly.

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/spanprocessor.py

@@ -186,7 +186,7 @@ def export(self) -> None:
                 self.flush_condition.notify()
 
     def _drain_queue(self):
-        """"Export all elements until queue is empty.
+        """Export all elements until queue is empty.
 
         Can only be called from the worker thread context because it invokes
         `export` that is not thread safe.

instrumentation/opentelemetry-instrumentation-aiohttp-client/setup.cfg

@@ -41,7 +41,6 @@ install_requires =
     opentelemetry-api == 1.3.0.dev0
     opentelemetry-semantic-conventions == 0.22.dev0
     opentelemetry-instrumentation == 0.22.dev0
-    aiohttp ~= 3.0
     wrapt >= 1.0.0, < 2.0.0
 
 [options.packages.find]

instrumentation/opentelemetry-instrumentation-aiohttp-client/setup.py

@@ -18,10 +18,24 @@
 
 
 import os
+from configparser import ConfigParser
 
 import setuptools
 
+config = ConfigParser()
+config.read("setup.cfg")
+
+# We provide extras_require parameter to setuptools.setup later which
+# overwrites the extra_require section from setup.cfg. To support extra_require
+# secion in setup.cfg, we load it here and merge it with the extra_require param.
+extras_require = {}
+if "options.extras_require" in config:
+    for key, value in config["options.extras_require"].items():
+        extras_require[key] = [v for v in value.split("\n") if v.strip()]
+
 BASE_DIR = os.path.dirname(__file__)
+PACKAGE_INFO = {}
+
 VERSION_FILENAME = os.path.join(
     BASE_DIR,
     "src",
@@ -30,8 +44,28 @@
     "aiohttp_client",
     "version.py",
 )
-PACKAGE_INFO = {}
 with open(VERSION_FILENAME) as f:
     exec(f.read(), PACKAGE_INFO)
 
-setuptools.setup(version=PACKAGE_INFO["__version__"])
+PACKAGE_FILENAME = os.path.join(
+    BASE_DIR,
+    "src",
+    "opentelemetry",
+    "instrumentation",
+    "aiohttp_client",
+    "package.py",
+)
+with open(PACKAGE_FILENAME) as f:
+    exec(f.read(), PACKAGE_INFO)
+
+# Mark any instruments/runtime dependencies as test dependencies as well.
+extras_require["instruments"] = PACKAGE_INFO["_instruments"]
+test_deps = extras_require.get("test", [])
+for dep in extras_require["instruments"]:
+    test_deps.append(dep)
+
+extras_require["test"] = test_deps
+
+setuptools.setup(
+    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+)

instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py

@@ -64,12 +64,14 @@ def strip_query_params(url: yarl.URL) -> str:
 
 import types
 import typing
+from typing import Collection
 
 import aiohttp
 import wrapt
 
 from opentelemetry import context as context_api
 from opentelemetry import trace
+from opentelemetry.instrumentation.aiohttp_client.package import _instruments
 from opentelemetry.instrumentation.aiohttp_client.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from opentelemetry.instrumentation.utils import (
@@ -288,6 +290,9 @@ class AioHttpClientInstrumentor(BaseInstrumentor):
     See `BaseInstrumentor`
     """
 
+    def instrumentation_dependencies(self) -> Collection[str]:
+        return _instruments
+
     def _instrument(self, **kwargs):
         """Instruments aiohttp ClientSession
 

instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/package.py

@@ -0,0 +1,16 @@
+# Copyright 2020, OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+_instruments = ("aiohttp ~= 3.0",)

instrumentation/opentelemetry-instrumentation-aiopg/setup.cfg

@@ -42,7 +42,6 @@ install_requires =
     opentelemetry-semantic-conventions == 0.22.dev0
     opentelemetry-instrumentation-dbapi == 0.22.dev0
     opentelemetry-instrumentation == 0.22.dev0
-    aiopg >= 0.13.0
     wrapt >= 1.0.0, < 2.0.0
 
 [options.extras_require]

instrumentation/opentelemetry-instrumentation-aiopg/setup.py

@@ -18,15 +18,44 @@
 
 
 import os
+from configparser import ConfigParser
 
 import setuptools
 
+config = ConfigParser()
+config.read("setup.cfg")
+
+# We provide extras_require parameter to setuptools.setup later which
+# overwrites the extra_require section from setup.cfg. To support extra_require
+# secion in setup.cfg, we load it here and merge it with the extra_require param.
+extras_require = {}
+if "options.extras_require" in config:
+    for key, value in config["options.extras_require"].items():
+        extras_require[key] = [v for v in value.split("\n") if v.strip()]
+
 BASE_DIR = os.path.dirname(__file__)
+PACKAGE_INFO = {}
+
 VERSION_FILENAME = os.path.join(
     BASE_DIR, "src", "opentelemetry", "instrumentation", "aiopg", "version.py"
 )
-PACKAGE_INFO = {}
 with open(VERSION_FILENAME) as f:
     exec(f.read(), PACKAGE_INFO)
 
-setuptools.setup(version=PACKAGE_INFO["__version__"])
+PACKAGE_FILENAME = os.path.join(
+    BASE_DIR, "src", "opentelemetry", "instrumentation", "aiopg", "package.py"
+)
+with open(PACKAGE_FILENAME) as f:
+    exec(f.read(), PACKAGE_INFO)
+
+# Mark any instruments/runtime dependencies as test dependencies as well.
+extras_require["instruments"] = PACKAGE_INFO["_instruments"]
+test_deps = extras_require.get("test", [])
+for dep in extras_require["instruments"]:
+    test_deps.append(dep)
+
+extras_require["test"] = test_deps
+
+setuptools.setup(
+    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+)

instrumentation/opentelemetry-instrumentation-aiopg/src/opentelemetry/instrumentation/aiopg/__init__.py

@@ -45,7 +45,10 @@
 ---
 """
 
+from typing import Collection
+
 from opentelemetry.instrumentation.aiopg import wrappers
+from opentelemetry.instrumentation.aiopg.package import _instruments
 from opentelemetry.instrumentation.aiopg.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 
@@ -60,6 +63,9 @@ class AiopgInstrumentor(BaseInstrumentor):
 
     _DATABASE_SYSTEM = "postgresql"
 
+    def instrumentation_dependencies(self) -> Collection[str]:
+        return _instruments
+
     def _instrument(self, **kwargs):
         """Integrate with PostgreSQL aiopg library.
         aiopg: https://github.com/aio-libs/aiopg

instrumentation/opentelemetry-instrumentation-aiopg/src/opentelemetry/instrumentation/aiopg/package.py

@@ -0,0 +1,16 @@
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+_instruments = ("aiopg >= 0.13.0",)

instrumentation/opentelemetry-instrumentation-asgi/setup.cfg

@@ -41,7 +41,6 @@ install_requires =
     opentelemetry-api == 1.3.0.dev0
     opentelemetry-semantic-conventions == 0.22.dev0
     opentelemetry-instrumentation == 0.22.dev0
-    asgiref ~= 3.0
 
 [options.extras_require]
 test =

instrumentation/opentelemetry-instrumentation-asgi/setup.py

@@ -18,15 +18,44 @@
 
 
 import os
+from configparser import ConfigParser
 
 import setuptools
 
+config = ConfigParser()
+config.read("setup.cfg")
+
+# We provide extras_require parameter to setuptools.setup later which
+# overwrites the extra_require section from setup.cfg. To support extra_require
+# secion in setup.cfg, we load it here and merge it with the extra_require param.
+extras_require = {}
+if "options.extras_require" in config:
+    for key, value in config["options.extras_require"].items():
+        extras_require[key] = [v for v in value.split("\n") if v.strip()]
+
 BASE_DIR = os.path.dirname(__file__)
+PACKAGE_INFO = {}
+
 VERSION_FILENAME = os.path.join(
     BASE_DIR, "src", "opentelemetry", "instrumentation", "asgi", "version.py"
 )
-PACKAGE_INFO = {}
 with open(VERSION_FILENAME) as f:
     exec(f.read(), PACKAGE_INFO)
 
-setuptools.setup(version=PACKAGE_INFO["__version__"])
+PACKAGE_FILENAME = os.path.join(
+    BASE_DIR, "src", "opentelemetry", "instrumentation", "asgi", "package.py"
+)
+with open(PACKAGE_FILENAME) as f:
+    exec(f.read(), PACKAGE_INFO)
+
+# Mark any instruments/runtime dependencies as test dependencies as well.
+extras_require["instruments"] = PACKAGE_INFO["_instruments"]
+test_deps = extras_require.get("test", [])
+for dep in extras_require["instruments"]:
+    test_deps.append(dep)
+
+extras_require["test"] = test_deps
+
+setuptools.setup(
+    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+)

instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py

@@ -112,8 +112,7 @@ def collect_request_attributes(scope):
 
 
 def get_host_port_url_tuple(scope):
-    """Returns (host, port, full_url) tuple.
-    """
+    """Returns (host, port, full_url) tuple."""
     server = scope.get("server") or ["0.0.0.0", 80]
     port = server[1]
     server_host = server[0] + (":" + str(port) if port != 80 else "")

instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/package.py

@@ -0,0 +1,16 @@
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+_instruments = ("asgiref ~= 3.0",)

instrumentation/opentelemetry-instrumentation-asyncpg/setup.cfg

@@ -41,7 +41,6 @@ install_requires =
     opentelemetry-api == 1.3.0.dev0
     opentelemetry-semantic-conventions == 0.22.dev0
     opentelemetry-instrumentation == 0.22.dev0
-    asyncpg >= 0.12.0
 
 [options.extras_require]
 test =

instrumentation/opentelemetry-instrumentation-asyncpg/setup.py

@@ -18,10 +18,24 @@
 
 
 import os
+from configparser import ConfigParser
 
 import setuptools
 
+config = ConfigParser()
+config.read("setup.cfg")
+
+# We provide extras_require parameter to setuptools.setup later which
+# overwrites the extra_require section from setup.cfg. To support extra_require
+# secion in setup.cfg, we load it here and merge it with the extra_require param.
+extras_require = {}
+if "options.extras_require" in config:
+    for key, value in config["options.extras_require"].items():
+        extras_require[key] = [v for v in value.split("\n") if v.strip()]
+
 BASE_DIR = os.path.dirname(__file__)
+PACKAGE_INFO = {}
+
 VERSION_FILENAME = os.path.join(
     BASE_DIR,
     "src",
@@ -30,8 +44,28 @@
     "asyncpg",
     "version.py",
 )
-PACKAGE_INFO = {}
 with open(VERSION_FILENAME) as f:
     exec(f.read(), PACKAGE_INFO)
 
-setuptools.setup(version=PACKAGE_INFO["__version__"])
+PACKAGE_FILENAME = os.path.join(
+    BASE_DIR,
+    "src",
+    "opentelemetry",
+    "instrumentation",
+    "asyncpg",
+    "package.py",
+)
+with open(PACKAGE_FILENAME) as f:
+    exec(f.read(), PACKAGE_INFO)
+
+# Mark any instruments/runtime dependencies as test dependencies as well.
+extras_require["instruments"] = PACKAGE_INFO["_instruments"]
+test_deps = extras_require.get("test", [])
+for dep in extras_require["instruments"]:
+    test_deps.append(dep)
+
+extras_require["test"] = test_deps
+
+setuptools.setup(
+    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+)