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.
open-telemetry · May 31, 2021 · e87e5c0 · e87e5c0
1 parent 4a8b32b
commit e87e5c0
Show file tree

Hide file tree

Showing 44 changed files with 1,295 additions and 210 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,7 @@
 *.egg
 *.egg-info
 dist
+dist-info
 build
 eggs
 parts

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@ 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` is not more robust and less likley to leave systems in a
+  broken state.
+  ([#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-

diff --git a/CONTRIBUTING.md b/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

diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -1,3 +1,4 @@
+astor~=0.8.1
 pylint~=2.6
 flake8~=3.7
 isort~=5.6

diff --git a/instrumentation/opentelemetry-instrumentation-aiohttp-client/setup.py b/instrumentation/opentelemetry-instrumentation-aiohttp-client/setup.py
@@ -17,6 +17,8 @@
 # RUN `python scripts/generate_setup.py` TO REGENERATE.
 
 
+import distutils.cmd
+import json
 import os
 from configparser import ConfigParser
 
@@ -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,
 )
diff --git a/instrumentation/opentelemetry-instrumentation-aiopg/setup.py b/instrumentation/opentelemetry-instrumentation-aiopg/setup.py
@@ -17,6 +17,8 @@
 # RUN `python scripts/generate_setup.py` TO REGENERATE.
 
 
+import distutils.cmd
+import json
 import os
 from configparser import ConfigParser
 
@@ -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,
 )
diff --git a/instrumentation/opentelemetry-instrumentation-asgi/setup.py b/instrumentation/opentelemetry-instrumentation-asgi/setup.py
@@ -17,6 +17,8 @@
 # RUN `python scripts/generate_setup.py` TO REGENERATE.
 
 
+import distutils.cmd
+import json
 import os
 from configparser import ConfigParser
 
@@ -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,
 )
diff --git a/instrumentation/opentelemetry-instrumentation-asyncpg/setup.py b/instrumentation/opentelemetry-instrumentation-asyncpg/setup.py
@@ -17,6 +17,8 @@
 # RUN `python scripts/generate_setup.py` TO REGENERATE.
 
 
+import distutils.cmd
+import json
 import os
 from configparser import ConfigParser
 
@@ -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,
 )
diff --git a/instrumentation/opentelemetry-instrumentation-boto/setup.py b/instrumentation/opentelemetry-instrumentation-boto/setup.py
@@ -17,6 +17,8 @@
 # RUN `python scripts/generate_setup.py` TO REGENERATE.
 
 
+import distutils.cmd
+import json
 import os
 from configparser import ConfigParser
 
@@ -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,
 )
diff --git a/instrumentation/opentelemetry-instrumentation-botocore/setup.py b/instrumentation/opentelemetry-instrumentation-botocore/setup.py
@@ -17,6 +17,8 @@
 # RUN `python scripts/generate_setup.py` TO REGENERATE.
 
 
+import distutils.cmd
+import json
 import os
 from configparser import ConfigParser
 
@@ -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,
 )
diff --git a/instrumentation/opentelemetry-instrumentation-celery/setup.py b/instrumentation/opentelemetry-instrumentation-celery/setup.py
@@ -17,6 +17,8 @@
 # RUN `python scripts/generate_setup.py` TO REGENERATE.
 
 
+import distutils.cmd
+import json
 import os
 from configparser import ConfigParser
 
@@ -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,
 )
diff --git a/instrumentation/opentelemetry-instrumentation-dbapi/setup.py b/instrumentation/opentelemetry-instrumentation-dbapi/setup.py
@@ -17,6 +17,8 @@
 # RUN `python scripts/generate_setup.py` TO REGENERATE.
 
 
+import distutils.cmd
+import json
 import os
 from configparser import ConfigParser
 
@@ -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,
 )
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,7 @@ @@
     *.egg
     *.egg-info
     dist
+    dist-info
     build
     eggs
     parts
@@ Expand Down @@