Simplify bootstrap and generate code

- We now automatically generate bootstrap_gen.py file from the list of instrumentations present in the source tree.
- Bootstrap command now uses consumes this auto-generated list instead of keeping it's own local copy.
- We no longer uninstall packages before installing them as instrumentation package no longer specify libraries as dependencies so the edge cases are no longer there.
- We no longer try to install an incompatible version or force upgrade/downgrade an installed version. This used to leave systems in broken states which should happen no more.

Author: owais

.github/workflows/test.yml

@@ -76,7 +76,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        tox-environment: [ "docker-tests", "lint", "docs" ]
+        tox-environment: [ "docker-tests", "lint", "docs", "generate" ]
     name: ${{ matrix.tox-environment }}
     runs-on: ubuntu-latest
     steps:
@@ -102,3 +102,7 @@ jobs:
           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 }}
+      - name: Ensure generated code is up to date
+        if: matrix.tox-environment == 'generate'
+        run: >-
+          git diff --exit-code || (echo 'Generated code is out of date, please run "tox -e generate" and commit the changes in this PR.' && exit 1)

.gitignore

@@ -8,6 +8,7 @@
 *.egg
 *.egg-info
 dist
+dist-info
 build
 eggs
 parts

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v1.2.0-0.21b0...HEAD)
 
 ### Changed
+- `opentelemetry-bootstrap` not longer forcibly removes and re-installs libraries and their instrumentations.
+  This means running bootstrap will not auto-upgrade existing dependencies and as a result not cause dependency
+  conflicts.
+  ([#514](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/514))
 - `opentelemetry-instrumentation-asgi` Set the response status code on the server span
   ([#478](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/478))
 - `opentelemetry-instrumentation-tornado` Fixed cases where description was used with non-

CONTRIBUTING.md

@@ -170,7 +170,7 @@ Below is a checklist of things to be mindful of when implementing a new instrume
 - Extends from [BaseInstrumentor](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py#L26)
 - Supports auto-instrumentation
   - Add an entry point (ex. https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation/opentelemetry-instrumentation-requests/setup.cfg#L56)
-  - Add instrumentation package to `bootstrap.py` (https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap.py#L37)
+  - Run `python scripts/setup.py` followed by `python scripts/generate_instrumentation_bootstrap.py` after adding a new instrumentation package.
 - Functionality that is common amongst other instrumentation and can be abstracted [here](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation)
 - Request/response [hooks](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/408) for http instrumentations
 - `suppress_instrumentation` functionality

dev-requirements.txt

@@ -1,7 +1,6 @@
+-r gen-requirements.txt
 pylint~=2.6
 flake8~=3.7
-isort~=5.6
-black>=19.3b0,==19.*
 httpretty~=1.0
 mypy==0.790
 sphinx

gen-requirements.txt

@@ -0,0 +1,4 @@
+astor~=0.8.1
+isort~=5.6
+black>=19.3b0,==19.*
+jinja2~=2.7

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

@@ -18,6 +18,8 @@
 
 
 import os
+import distutils.cmd
+import json
 from configparser import ConfigParser
 
 import setuptools
@@ -66,6 +68,32 @@
 
 extras_require["test"] = test_deps
 
+
+class JSONMetadataCommand(distutils.cmd.Command):
+
+    description = (
+        "print out package metadata as JSON. This is used by OpenTelemetry dev scripts to ",
+        "auto-generate code in other places",
+    )
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        metadata = {
+            "name": config["metadata"]["name"],
+            "version": PACKAGE_INFO["__version__"],
+            "instruments": PACKAGE_INFO["_instruments"],
+        }
+        print(json.dumps(metadata))
+
+
 setuptools.setup(
-    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+    cmdclass={"meta": JSONMetadataCommand},
+    version=PACKAGE_INFO["__version__"],
+    extras_require=extras_require,
 )

instrumentation/opentelemetry-instrumentation-aiopg/setup.py

@@ -18,6 +18,8 @@
 
 
 import os
+import distutils.cmd
+import json
 from configparser import ConfigParser
 
 import setuptools
@@ -56,6 +58,32 @@
 
 extras_require["test"] = test_deps
 
+
+class JSONMetadataCommand(distutils.cmd.Command):
+
+    description = (
+        "print out package metadata as JSON. This is used by OpenTelemetry dev scripts to ",
+        "auto-generate code in other places",
+    )
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        metadata = {
+            "name": config["metadata"]["name"],
+            "version": PACKAGE_INFO["__version__"],
+            "instruments": PACKAGE_INFO["_instruments"],
+        }
+        print(json.dumps(metadata))
+
+
 setuptools.setup(
-    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+    cmdclass={"meta": JSONMetadataCommand},
+    version=PACKAGE_INFO["__version__"],
+    extras_require=extras_require,
 )

instrumentation/opentelemetry-instrumentation-asgi/setup.py

@@ -18,6 +18,8 @@
 
 
 import os
+import distutils.cmd
+import json
 from configparser import ConfigParser
 
 import setuptools
@@ -56,6 +58,32 @@
 
 extras_require["test"] = test_deps
 
+
+class JSONMetadataCommand(distutils.cmd.Command):
+
+    description = (
+        "print out package metadata as JSON. This is used by OpenTelemetry dev scripts to ",
+        "auto-generate code in other places",
+    )
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        metadata = {
+            "name": config["metadata"]["name"],
+            "version": PACKAGE_INFO["__version__"],
+            "instruments": PACKAGE_INFO["_instruments"],
+        }
+        print(json.dumps(metadata))
+
+
 setuptools.setup(
-    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+    cmdclass={"meta": JSONMetadataCommand},
+    version=PACKAGE_INFO["__version__"],
+    extras_require=extras_require,
 )

instrumentation/opentelemetry-instrumentation-asyncpg/setup.py

@@ -18,6 +18,8 @@
 
 
 import os
+import distutils.cmd
+import json
 from configparser import ConfigParser
 
 import setuptools
@@ -66,6 +68,32 @@
 
 extras_require["test"] = test_deps
 
+
+class JSONMetadataCommand(distutils.cmd.Command):
+
+    description = (
+        "print out package metadata as JSON. This is used by OpenTelemetry dev scripts to ",
+        "auto-generate code in other places",
+    )
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        metadata = {
+            "name": config["metadata"]["name"],
+            "version": PACKAGE_INFO["__version__"],
+            "instruments": PACKAGE_INFO["_instruments"],
+        }
+        print(json.dumps(metadata))
+
+
 setuptools.setup(
-    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+    cmdclass={"meta": JSONMetadataCommand},
+    version=PACKAGE_INFO["__version__"],
+    extras_require=extras_require,
 )

instrumentation/opentelemetry-instrumentation-boto/setup.py

@@ -18,6 +18,8 @@
 
 
 import os
+import distutils.cmd
+import json
 from configparser import ConfigParser
 
 import setuptools
@@ -56,6 +58,32 @@
 
 extras_require["test"] = test_deps
 
+
+class JSONMetadataCommand(distutils.cmd.Command):
+
+    description = (
+        "print out package metadata as JSON. This is used by OpenTelemetry dev scripts to ",
+        "auto-generate code in other places",
+    )
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        metadata = {
+            "name": config["metadata"]["name"],
+            "version": PACKAGE_INFO["__version__"],
+            "instruments": PACKAGE_INFO["_instruments"],
+        }
+        print(json.dumps(metadata))
+
+
 setuptools.setup(
-    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+    cmdclass={"meta": JSONMetadataCommand},
+    version=PACKAGE_INFO["__version__"],
+    extras_require=extras_require,
 )

instrumentation/opentelemetry-instrumentation-botocore/setup.py

@@ -18,6 +18,8 @@
 
 
 import os
+import distutils.cmd
+import json
 from configparser import ConfigParser
 
 import setuptools
@@ -66,6 +68,32 @@
 
 extras_require["test"] = test_deps
 
+
+class JSONMetadataCommand(distutils.cmd.Command):
+
+    description = (
+        "print out package metadata as JSON. This is used by OpenTelemetry dev scripts to ",
+        "auto-generate code in other places",
+    )
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        metadata = {
+            "name": config["metadata"]["name"],
+            "version": PACKAGE_INFO["__version__"],
+            "instruments": PACKAGE_INFO["_instruments"],
+        }
+        print(json.dumps(metadata))
+
+
 setuptools.setup(
-    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+    cmdclass={"meta": JSONMetadataCommand},
+    version=PACKAGE_INFO["__version__"],
+    extras_require=extras_require,
 )

instrumentation/opentelemetry-instrumentation-celery/setup.py

@@ -18,6 +18,8 @@
 
 
 import os
+import distutils.cmd
+import json
 from configparser import ConfigParser
 
 import setuptools
@@ -56,6 +58,32 @@
 
 extras_require["test"] = test_deps
 
+
+class JSONMetadataCommand(distutils.cmd.Command):
+
+    description = (
+        "print out package metadata as JSON. This is used by OpenTelemetry dev scripts to ",
+        "auto-generate code in other places",
+    )
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        metadata = {
+            "name": config["metadata"]["name"],
+            "version": PACKAGE_INFO["__version__"],
+            "instruments": PACKAGE_INFO["_instruments"],
+        }
+        print(json.dumps(metadata))
+
+
 setuptools.setup(
-    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+    cmdclass={"meta": JSONMetadataCommand},
+    version=PACKAGE_INFO["__version__"],
+    extras_require=extras_require,
 )