diff --git a/metapackages/opentelemetry-instrumentation-all/LICENSE b/metapackages/opentelemetry-instrumentation-all/LICENSE new file mode 100644 index 0000000000..1ef7dad2c5 --- /dev/null +++ b/metapackages/opentelemetry-instrumentation-all/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + 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. diff --git a/metapackages/opentelemetry-instrumentation-all/MANIFEST.in b/metapackages/opentelemetry-instrumentation-all/MANIFEST.in new file mode 100644 index 0000000000..faee277146 --- /dev/null +++ b/metapackages/opentelemetry-instrumentation-all/MANIFEST.in @@ -0,0 +1,8 @@ +graft src +graft tests +global-exclude *.pyc +global-exclude *.pyo +global-exclude __pycache__/* +include MANIFEST.in +include README.rst +include LICENSE diff --git a/metapackages/opentelemetry-instrumentation-all/README.rst b/metapackages/opentelemetry-instrumentation-all/README.rst new file mode 100644 index 0000000000..63fbcdf841 --- /dev/null +++ b/metapackages/opentelemetry-instrumentation-all/README.rst @@ -0,0 +1,25 @@ +OpenTelemetry Instrumentation All +================================== + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-all.svg + :target: https://pypi.org/project/opentelemetry-instrumentation-all/ + +Installation +------------ + +:: + + pip install opentelemetry-instrumentation-all + + +This package depends on every instrumentation package hosted by OpenTelemetry Python Contrib. +It does not provide any functionality of its own. It just provides a convenient way to install +all supported instrumentation packages. + + +References +---------- + +* `OpenTelemetry Project `_ diff --git a/metapackages/opentelemetry-instrumentation-all/setup.cfg b/metapackages/opentelemetry-instrumentation-all/setup.cfg new file mode 100644 index 0000000000..3ae98991d0 --- /dev/null +++ b/metapackages/opentelemetry-instrumentation-all/setup.cfg @@ -0,0 +1,69 @@ +[metadata] +name = opentelemetry-instrumentation-all +description = Meta package that install all available OpenTelemetry instrumentation packages from the same release. +long_description = file: README.rst +long_description_content_type = text/x-rst +author = OpenTelemetry Authors +author_email = cncf-opentelemetry-contributors@lists.cncf.io +url = https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/metapackages/opentelemetry-instrumentation-all +platforms = any +license = Apache-2.0 +classifiers = + Development Status :: 4 - Beta + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Programming Language :: Python + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.6 + Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 + +[options] +python_requires = >=3.6 +package_dir = + =src +packages = find_namespace: +zip_safe = False +include_package_data = True +install_requires = + opentelemetry-instrumentation-aiohttp-client == 0.24b0 + opentelemetry-instrumentation-aiopg == 0.24b0 + opentelemetry-instrumentation-asgi == 0.24b0 + opentelemetry-instrumentation-asyncpg == 0.24b0 + opentelemetry-instrumentation-boto == 0.24b0 + opentelemetry-instrumentation-botocore == 0.24b0 + opentelemetry-instrumentation-celery == 0.24b0 + opentelemetry-instrumentation-dbapi == 0.24b0 + opentelemetry-instrumentation-django == 0.24b0 + opentelemetry-instrumentation-elasticsearch == 0.24b0 + opentelemetry-instrumentation-falcon == 0.24b0 + opentelemetry-instrumentation-fastapi == 0.24b0 + opentelemetry-instrumentation-flask == 0.24b0 + opentelemetry-instrumentation-grpc == 0.24b0 + opentelemetry-instrumentation-httpx == 0.24b0 + opentelemetry-instrumentation-jinja2 == 0.24b0 + opentelemetry-instrumentation-logging == 0.24b0 + opentelemetry-instrumentation-mysql == 0.24b0 + opentelemetry-instrumentation-psycopg2 == 0.24b0 + opentelemetry-instrumentation-pymemcache == 0.24b0 + opentelemetry-instrumentation-pymongo == 0.24b0 + opentelemetry-instrumentation-pymysql == 0.24b0 + opentelemetry-instrumentation-pyramid == 0.24b0 + opentelemetry-instrumentation-redis == 0.24b0 + opentelemetry-instrumentation-requests == 0.24b0 + opentelemetry-instrumentation-sklearn == 0.24b0 + opentelemetry-instrumentation-sqlalchemy == 0.24b0 + opentelemetry-instrumentation-sqlite3 == 0.24b0 + opentelemetry-instrumentation-starlette == 0.24b0 + opentelemetry-instrumentation-tornado == 0.24b0 + opentelemetry-instrumentation-urllib == 0.24b0 + opentelemetry-instrumentation-urllib3 == 0.24b0 + opentelemetry-instrumentation-wsgi == 0.24b0 + +[options.packages.find] +where = src + +[options.extras_require] +test = + diff --git a/metapackages/opentelemetry-instrumentation-all/setup.py b/metapackages/opentelemetry-instrumentation-all/setup.py new file mode 100644 index 0000000000..37fdcb0748 --- /dev/null +++ b/metapackages/opentelemetry-instrumentation-all/setup.py @@ -0,0 +1,27 @@ +# 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. + +import os + +import setuptools + +BASE_DIR = os.path.dirname(__file__) +VERSION_FILENAME = os.path.join( + BASE_DIR, "src", "opentelemetry", "instrumentation-all", "version.py" +) +PACKAGE_INFO = {} +with open(VERSION_FILENAME) as f: + exec(f.read(), PACKAGE_INFO) + +setuptools.setup(version=PACKAGE_INFO["__version__"],) diff --git a/metapackages/opentelemetry-instrumentation-all/src/opentelemetry/instrumentation-all/__init__.py b/metapackages/opentelemetry-instrumentation-all/src/opentelemetry/instrumentation-all/__init__.py new file mode 100644 index 0000000000..c92c14f253 --- /dev/null +++ b/metapackages/opentelemetry-instrumentation-all/src/opentelemetry/instrumentation-all/__init__.py @@ -0,0 +1,158 @@ +# 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. + +# DO NOT EDIT. THIS FILE WAS AUTOGENERATED FROM INSTRUMENTATION PACKAGES. +# RUN `python scripts/generate_instrumentation_bootstrap.py` TO REGENERATE. + +libraries = { + "aiohttp": { + "library": "aiohttp ~= 3.0", + "instrumentation": "opentelemetry-instrumentation-aiohttp-client == 0.24b0", + }, + "aiopg": { + "library": "aiopg >= 0.13.0, < 1.3.0", + "instrumentation": "opentelemetry-instrumentation-aiopg == 0.24b0", + }, + "asgiref": { + "library": "asgiref ~= 3.0", + "instrumentation": "opentelemetry-instrumentation-asgi == 0.24b0", + }, + "asyncpg": { + "library": "asyncpg >= 0.12.0", + "instrumentation": "opentelemetry-instrumentation-asyncpg == 0.24b0", + }, + "boto": { + "library": "boto~=2.0", + "instrumentation": "opentelemetry-instrumentation-boto == 0.24b0", + }, + "botocore": { + "library": "botocore ~= 1.0", + "instrumentation": "opentelemetry-instrumentation-botocore == 0.24b0", + }, + "celery": { + "library": "celery >= 4.0, < 6.0", + "instrumentation": "opentelemetry-instrumentation-celery == 0.24b0", + }, + "dbapi": { + "library": "dbapi", + "instrumentation": "opentelemetry-instrumentation-dbapi == 0.24b0", + }, + "django": { + "library": "django >= 1.10", + "instrumentation": "opentelemetry-instrumentation-django == 0.24b0", + }, + "elasticsearch": { + "library": "elasticsearch >= 2.0", + "instrumentation": "opentelemetry-instrumentation-elasticsearch == 0.24b0", + }, + "falcon": { + "library": "falcon ~= 2.0", + "instrumentation": "opentelemetry-instrumentation-falcon == 0.24b0", + }, + "fastapi": { + "library": "fastapi ~= 0.58", + "instrumentation": "opentelemetry-instrumentation-fastapi == 0.24b0", + }, + "flask": { + "library": "flask >= 1.0, < 3.0", + "instrumentation": "opentelemetry-instrumentation-flask == 0.24b0", + }, + "grpcio": { + "library": "grpcio ~= 1.27", + "instrumentation": "opentelemetry-instrumentation-grpc == 0.24b0", + }, + "httpx": { + "library": "httpx >= 0.18.0, < 0.19.0", + "instrumentation": "opentelemetry-instrumentation-httpx == 0.24b0", + }, + "jinja2": { + "library": "jinja2~=2.7", + "instrumentation": "opentelemetry-instrumentation-jinja2 == 0.24b0", + }, + "logging": { + "library": "logging", + "instrumentation": "opentelemetry-instrumentation-logging == 0.24b0", + }, + "mysql-connector-python": { + "library": "mysql-connector-python ~= 8.0", + "instrumentation": "opentelemetry-instrumentation-mysql == 0.24b0", + }, + "psycopg2": { + "library": "psycopg2 >= 2.7.3.1", + "instrumentation": "opentelemetry-instrumentation-psycopg2 == 0.24b0", + }, + "pymemcache": { + "library": "pymemcache ~= 1.3", + "instrumentation": "opentelemetry-instrumentation-pymemcache == 0.24b0", + }, + "pymongo": { + "library": "pymongo ~= 3.1", + "instrumentation": "opentelemetry-instrumentation-pymongo == 0.24b0", + }, + "PyMySQL": { + "library": "PyMySQL ~= 0.10.1", + "instrumentation": "opentelemetry-instrumentation-pymysql == 0.24b0", + }, + "pyramid": { + "library": "pyramid >= 1.7", + "instrumentation": "opentelemetry-instrumentation-pyramid == 0.24b0", + }, + "redis": { + "library": "redis >= 2.6", + "instrumentation": "opentelemetry-instrumentation-redis == 0.24b0", + }, + "requests": { + "library": "requests ~= 2.0", + "instrumentation": "opentelemetry-instrumentation-requests == 0.24b0", + }, + "scikit-learn": { + "library": "scikit-learn ~= 0.24.0", + "instrumentation": "opentelemetry-instrumentation-sklearn == 0.24b0", + }, + "sqlalchemy": { + "library": "sqlalchemy", + "instrumentation": "opentelemetry-instrumentation-sqlalchemy == 0.24b0", + }, + "sqlite3": { + "library": "sqlite3", + "instrumentation": "opentelemetry-instrumentation-sqlite3 == 0.24b0", + }, + "starlette": { + "library": "starlette ~= 0.13.0", + "instrumentation": "opentelemetry-instrumentation-starlette == 0.24b0", + }, + "tornado": { + "library": "tornado >= 6.0", + "instrumentation": "opentelemetry-instrumentation-tornado == 0.24b0", + }, + "urllib": { + "library": "urllib", + "instrumentation": "opentelemetry-instrumentation-urllib == 0.24b0", + }, + "urllib3": { + "library": "urllib3 >= 1.0.0, < 2.0.0", + "instrumentation": "opentelemetry-instrumentation-urllib3 == 0.24b0", + }, + "wsgi": { + "library": "wsgi", + "instrumentation": "opentelemetry-instrumentation-wsgi == 0.24b0", + }, +} +default_instrumentations = [ + "opentelemetry-instrumentation-dbapi == 0.24b0", + "opentelemetry-instrumentation-logging == 0.24b0", + "opentelemetry-instrumentation-sqlite3 == 0.24b0", + "opentelemetry-instrumentation-urllib == 0.24b0", + "opentelemetry-instrumentation-wsgi == 0.24b0", +] diff --git a/metapackages/opentelemetry-instrumentation-all/src/opentelemetry/instrumentation-all/py.typed b/metapackages/opentelemetry-instrumentation-all/src/opentelemetry/instrumentation-all/py.typed new file mode 100644 index 0000000000..e69de29bb2 diff --git a/metapackages/opentelemetry-instrumentation-all/src/opentelemetry/instrumentation-all/version.py b/metapackages/opentelemetry-instrumentation-all/src/opentelemetry/instrumentation-all/version.py new file mode 100644 index 0000000000..d33bd87ce4 --- /dev/null +++ b/metapackages/opentelemetry-instrumentation-all/src/opentelemetry/instrumentation-all/version.py @@ -0,0 +1,15 @@ +# 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. + +__version__ = "0.24b0" diff --git a/scripts/generate_instrumentation_bootstrap.py b/scripts/generate_instrumentation_meta_package.py similarity index 65% rename from scripts/generate_instrumentation_bootstrap.py rename to scripts/generate_instrumentation_meta_package.py index 31dc0331b9..844516332d 100755 --- a/scripts/generate_instrumentation_bootstrap.py +++ b/scripts/generate_instrumentation_meta_package.py @@ -15,6 +15,7 @@ # limitations under the License. import ast +import configparser import logging import os import subprocess @@ -29,7 +30,15 @@ ) logging.basicConfig(level=logging.INFO) -logger = logging.getLogger("instrumentation_list_generator") +logger = logging.getLogger("instrumentation_readme_generator") + +meta_pkg_path = os.path.join( + root_path, "metapackages", "opentelemetry-instrumentation-all" +) +setup_cfg_path = os.path.join(meta_pkg_path, "setup.cfg") +init_py_path = os.path.join( + meta_pkg_path, "src", "opentelemetry", "instrumentation-all", "__init__.py" +) _auto_generation_msg = """ # DO NOT EDIT. THIS FILE WAS AUTOGENERATED FROM templates/{source}. @@ -51,31 +60,35 @@ """ -gen_path = os.path.join( - root_path, - "opentelemetry-python-core", - "opentelemetry-instrumentation", - "src", - "opentelemetry", - "instrumentation", - "bootstrap_gen.py", -) +def generate_setup_cfg(): + packages = get_instrumentation_packages() + dependencies = "".join( + ["\n{0} == {1}".format(pkg.name, pkg.version) for pkg in packages] + ) + config = configparser.ConfigParser() + config.read(os.path.join(setup_cfg_path)) + config["options"]["install_requires"] = dependencies + with open(setup_cfg_path, "w", encoding="utf-8") as setup_cfg_file: + config.write(setup_cfg_file) -def main(): + logger.info("generated %s", setup_cfg_path) + + +def generate_init_py(): # pylint: disable=no-member default_instrumentations = ast.List(elts=[]) libraries = ast.Dict(keys=[], values=[]) for pkg in get_instrumentation_packages(): - if not pkg["instruments"]: - default_instrumentations.elts.append(ast.Str(pkg["requirement"])) - for target_pkg in pkg["instruments"]: + if pkg.stdlib: + default_instrumentations.elts.append(ast.Str(pkg.as_req)) + for target_pkg in pkg.instruments: parsed = pkg_resources.Requirement.parse(target_pkg) libraries.keys.append(ast.Str(parsed.name)) libraries.values.append( ast.Dict( keys=[ast.Str("library"), ast.Str("instrumentation")], - values=[ast.Str(target_pkg), ast.Str(pkg["requirement"])], + values=[ast.Str(target_pkg), ast.Str(pkg.as_req)], ) ) @@ -90,22 +103,27 @@ def main(): header = header_file.read() source = _template.format(header=header, source=source) - with open(gen_path, "w") as gen_file: + with open(init_py_path, "w") as gen_file: gen_file.write(source) + logger.info("generated %s", init_py_path) + + +def main(): + generate_setup_cfg() + generate_init_py() + subprocess.run( [ sys.executable, "scripts/eachdist.py", "format", "--path", - "opentelemetry-python-core/opentelemetry-instrumentation", + "metapackages", ], check=True, ) - logger.info("generated %s", gen_path) - if __name__ == "__main__": main() diff --git a/scripts/generate_instrumentation_readme.py b/scripts/generate_instrumentation_readme.py index 4eaa8c907d..1879cd0460 100755 --- a/scripts/generate_instrumentation_readme.py +++ b/scripts/generate_instrumentation_readme.py @@ -20,7 +20,10 @@ logging.basicConfig(level=logging.INFO) logger = logging.getLogger("instrumentation_readme_generator") -_prefix = "opentelemetry-instrumentation-" +from generate_utils import ( + base_instrumentation_path, + get_instrumentation_packages, +) header = """ | Instrumentation | Supported Packages | @@ -28,42 +31,11 @@ def main(): - root_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) - base_instrumentation_path = os.path.join(root_path, "instrumentation") - table = [header] - for instrumentation in sorted(os.listdir(base_instrumentation_path)): - instrumentation_path = os.path.join( - base_instrumentation_path, instrumentation - ) - if not os.path.isdir( - instrumentation_path - ) or not instrumentation.startswith(_prefix): - continue - - src_dir = os.path.join( - instrumentation_path, "src", "opentelemetry", "instrumentation" - ) - src_pkgs = [ - f - for f in os.listdir(src_dir) - if os.path.isdir(os.path.join(src_dir, f)) - ] - assert len(src_pkgs) == 1 - name = src_pkgs[0] - - pkg_info = {} - version_filename = os.path.join(src_dir, name, "package.py",) - with open(version_filename, encoding="utf-8") as fh: - exec(fh.read(), pkg_info) - - instruments = pkg_info["_instruments"] - if not instruments: - instruments = (name,) - + for pkg in get_instrumentation_packages(): table.append( "| [{0}](./{0}) | {1} |".format( - instrumentation, ",".join(instruments) + pkg.name, ",".join(pkg.instruments) ) ) diff --git a/scripts/otel_packaging.py b/scripts/otel_packaging.py index f6f43fd689..634ad41f45 100644 --- a/scripts/otel_packaging.py +++ b/scripts/otel_packaging.py @@ -15,29 +15,71 @@ import json import os import subprocess +from typing import Collection, NamedTuple +instrumentation_pkg_prefix = "opentelemetry-instrumentation-" scripts_path = os.path.dirname(os.path.abspath(__file__)) root_path = os.path.dirname(scripts_path) -instrumentations_path = os.path.join(root_path, "instrumentation") +base_instrumentation_path = os.path.join(root_path, "instrumentation") -def get_instrumentation_packages(): - for pkg in sorted(os.listdir(instrumentations_path)): - pkg_path = os.path.join(instrumentations_path, pkg) - if not os.path.isdir(pkg_path): +class InstrumentationPackage(NamedTuple): + name: str + version: str + instruments: Collection[str] + as_req: str + stdlib: bool + + +def get_instrumentation_packages() -> Collection[InstrumentationPackage]: + + packages = [] + for instrumentation in sorted(os.listdir(base_instrumentation_path)): + instrumentation_path = os.path.join( + base_instrumentation_path, instrumentation + ) + if not os.path.isdir( + instrumentation_path + ) or not instrumentation.startswith(instrumentation_pkg_prefix): continue - out = subprocess.check_output( - "python setup.py meta", - shell=True, - cwd=pkg_path, - universal_newlines=True, + src_dir = os.path.join( + instrumentation_path, "src", "opentelemetry", "instrumentation" ) - instrumentation = json.loads(out.splitlines()[1]) - instrumentation["requirement"] = "==".join( - (instrumentation["name"], instrumentation["version"],) + src_pkgs = [ + f + for f in os.listdir(src_dir) + if os.path.isdir(os.path.join(src_dir, f)) + ] + assert len(src_pkgs) == 1 + name = src_pkgs[0] + + pkg_info = {} + version_filename = os.path.join(src_dir, name, "version.py",) + with open(version_filename, encoding="utf-8") as fh: + exec(fh.read(), pkg_info) + version = pkg_info["__version__"] + + pkg_filename = os.path.join(src_dir, name, "package.py",) + with open(pkg_filename, encoding="utf-8") as fh: + exec(fh.read(), pkg_info) + + instruments = pkg_info["_instruments"] + instruments_stdlib = False + if not instruments: + instruments_stdlib = True + instruments = (name,) + + packages.append( + InstrumentationPackage( + name=instrumentation, + version=version, + instruments=instruments, + as_req="{0} == {1}".format(instrumentation, version), + stdlib=instruments_stdlib, + ) ) - yield instrumentation + return packages if __name__ == "__main__": diff --git a/tox.ini b/tox.ini index 0fab90b217..32c844d583 100644 --- a/tox.ini +++ b/tox.ini @@ -448,3 +448,4 @@ commands = {toxinidir}/scripts/generate_setup.py {toxinidir}/scripts/generate_instrumentation_bootstrap.py {toxinidir}/scripts/generate_instrumentation_readme.py + {toxinidir}/scripts/generate_instrumentation_meta_package.py