diff --git a/CHANGELOG.md b/CHANGELOG.md index 570b9084dbc..0393361d358 100644 --- 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)) +- `opentelemetry-sdk` The JaegerPropagator has been moved into its own package: `opentelemetry-propagator-jaeger` + ([#1525](https://github.com/open-telemetry/opentelemetry-python/pull/1525)) - Move opentelemetry-opentracing-shim out of instrumentation folder ([#1533](https://github.com/open-telemetry/opentelemetry-python/pull/1533)) diff --git a/propagator/opentelemetry-propagator-jaeger/LICENSE b/propagator/opentelemetry-propagator-jaeger/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/propagator/opentelemetry-propagator-jaeger/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 [yyyy] [name of copyright owner] + + 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/propagator/opentelemetry-propagator-jaeger/MANIFEST.in b/propagator/opentelemetry-propagator-jaeger/MANIFEST.in new file mode 100644 index 00000000000..aed3e33273b --- /dev/null +++ b/propagator/opentelemetry-propagator-jaeger/MANIFEST.in @@ -0,0 +1,9 @@ +graft src +graft tests +global-exclude *.pyc +global-exclude *.pyo +global-exclude __pycache__/* +include CHANGELOG.md +include MANIFEST.in +include README.rst +include LICENSE diff --git a/propagator/opentelemetry-propagator-jaeger/README.rst b/propagator/opentelemetry-propagator-jaeger/README.rst new file mode 100644 index 00000000000..970cb189f38 --- /dev/null +++ b/propagator/opentelemetry-propagator-jaeger/README.rst @@ -0,0 +1,23 @@ +OpenTelemetry Jaeger Propagator +=============================== + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-propagator-jaeger.svg + :target: https://pypi.org/project/opentelemetry-propagator-jaeger/ + +This library provides a propagator for the Jaeger format + +Installation +------------ + +:: + + pip install opentelemetry-propagator-jaeger + + +References +---------- + +* `OpenTelemetry `_ +* `Jaeger format `_ diff --git a/propagator/opentelemetry-propagator-jaeger/setup.cfg b/propagator/opentelemetry-propagator-jaeger/setup.cfg new file mode 100644 index 00000000000..a429ef5529f --- /dev/null +++ b/propagator/opentelemetry-propagator-jaeger/setup.cfg @@ -0,0 +1,53 @@ +# 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. +# +[metadata] +name = opentelemetry-propagator-jaeger +description = OpenTelemetry Jaeger Propagator +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/tree/master/propagator/opentelemetry-propagator-jaeger +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.5 + Programming Language :: Python :: 3.6 + Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 + +[options] +python_requires = >=3.5 +package_dir= + =src +packages=find_namespace: +install_requires = + opentelemetry-api == 0.17.dev0 + +[options.extras_require] +test = + +[options.packages.find] +where = src + +[options.entry_points] +opentelemetry_propagator = + jaeger = opentelemetry.propagators.jaeger:JaegerPropagator \ No newline at end of file diff --git a/propagator/opentelemetry-propagator-jaeger/setup.py b/propagator/opentelemetry-propagator-jaeger/setup.py new file mode 100644 index 00000000000..4fda43e5165 --- /dev/null +++ b/propagator/opentelemetry-propagator-jaeger/setup.py @@ -0,0 +1,26 @@ +# 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", "propagators", "jaeger", "version.py" +) +PACKAGE_INFO = {} +with open(VERSION_FILENAME) as f: + exec(f.read(), PACKAGE_INFO) + +setuptools.setup(version=PACKAGE_INFO["__version__"]) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/trace/propagation/jaeger_propagator.py b/propagator/opentelemetry-propagator-jaeger/src/opentelemetry/propagators/jaeger/__init__.py similarity index 93% rename from opentelemetry-sdk/src/opentelemetry/sdk/trace/propagation/jaeger_propagator.py rename to propagator/opentelemetry-propagator-jaeger/src/opentelemetry/propagators/jaeger/__init__.py index e4d2b1cb2cc..f9ad768291d 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/trace/propagation/jaeger_propagator.py +++ b/propagator/opentelemetry-propagator-jaeger/src/opentelemetry/propagators/jaeger/__init__.py @@ -18,7 +18,6 @@ import opentelemetry.trace as trace from opentelemetry import baggage from opentelemetry.context import Context, get_current -from opentelemetry.sdk.trace.propagation import extract_first_element from opentelemetry.trace.propagation.textmap import ( Getter, Setter, @@ -46,7 +45,7 @@ def extract( if context is None: context = get_current() - fields = extract_first_element( + fields = _extract_first_element( getter.get(carrier, self.TRACE_ID_KEY) ).split(":") @@ -122,7 +121,7 @@ def _extract_baggage(self, getter, carrier, context): if key.startswith(self.BAGGAGE_PREFIX) ] for key in baggage_keys: - value = extract_first_element(getter.get(carrier, key)) + value = _extract_first_element(getter.get(carrier, key)) context = baggage.set_baggage( key.replace(self.BAGGAGE_PREFIX, ""), urllib.parse.unquote(value).strip(), @@ -135,3 +134,11 @@ def _format_uber_trace_id(trace_id, span_id, parent_span_id, flags): return "{:032x}:{:016x}:{:016x}:{:02x}".format( trace_id, span_id, parent_span_id, flags ) + + +def _extract_first_element( + items: typing.Iterable[TextMapPropagatorT], +) -> typing.Optional[TextMapPropagatorT]: + if items is None: + return None + return next(iter(items), None) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/trace/propagation/__init__.py b/propagator/opentelemetry-propagator-jaeger/src/opentelemetry/propagators/jaeger/version.py similarity index 67% rename from opentelemetry-sdk/src/opentelemetry/sdk/trace/propagation/__init__.py rename to propagator/opentelemetry-propagator-jaeger/src/opentelemetry/propagators/jaeger/version.py index a02a07ea2af..86e1dbb17ab 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/trace/propagation/__init__.py +++ b/propagator/opentelemetry-propagator-jaeger/src/opentelemetry/propagators/jaeger/version.py @@ -12,15 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. - -import typing - -from opentelemetry.trace.propagation.textmap import TextMapPropagatorT - - -def extract_first_element( - items: typing.Iterable[TextMapPropagatorT], -) -> typing.Optional[TextMapPropagatorT]: - if items is None: - return None - return next(iter(items), None) +__version__ = "0.17.dev0" diff --git a/propagator/opentelemetry-propagator-jaeger/tests/__init__.py b/propagator/opentelemetry-propagator-jaeger/tests/__init__.py new file mode 100644 index 00000000000..b0a6f428417 --- /dev/null +++ b/propagator/opentelemetry-propagator-jaeger/tests/__init__.py @@ -0,0 +1,13 @@ +# 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/opentelemetry-sdk/tests/trace/propagation/test_jaeger_propagator.py b/propagator/opentelemetry-propagator-jaeger/tests/test_jaeger_propagator.py similarity index 98% rename from opentelemetry-sdk/tests/trace/propagation/test_jaeger_propagator.py rename to propagator/opentelemetry-propagator-jaeger/tests/test_jaeger_propagator.py index aff6062bbf4..6e6f548d093 100644 --- a/opentelemetry-sdk/tests/trace/propagation/test_jaeger_propagator.py +++ b/propagator/opentelemetry-propagator-jaeger/tests/test_jaeger_propagator.py @@ -17,9 +17,11 @@ import opentelemetry.sdk.trace as trace import opentelemetry.sdk.trace.ids_generator as ids_generator -import opentelemetry.sdk.trace.propagation.jaeger_propagator as jaeger import opentelemetry.trace as trace_api from opentelemetry import baggage +from opentelemetry.propagators import ( # pylint: disable=no-name-in-module + jaeger, +) from opentelemetry.trace.propagation.textmap import DictGetter FORMAT = jaeger.JaegerPropagator() diff --git a/tox.ini b/tox.ini index 7c510b69498..3ef615bb7e0 100644 --- a/tox.ini +++ b/tox.ini @@ -51,6 +51,10 @@ envlist = py3{5,6,7,8,9}-test-propagator-b3 pypy3-test-propagator-b3 + ; opentelemetry-propagator-jaeger + py3{5,6,7,8,9}-test-propagator-jaeger + pypy3-test-propagator-jaeger + lint tracecontext mypy,mypyinstalled @@ -83,6 +87,7 @@ changedir = test-exporter-zipkin: exporter/opentelemetry-exporter-zipkin/tests test-propagator-b3: propagator/opentelemetry-propagator-b3/tests + test-propagator-jaeger: propagator/opentelemetry-propagator-jaeger/tests commands_pre = ; Install without -e to test the actual installation @@ -103,7 +108,7 @@ commands_pre = prometheus: pip install {toxinidir}/exporter/opentelemetry-exporter-prometheus - jaeger: pip install {toxinidir}/exporter/opentelemetry-exporter-jaeger + exporter-jaeger: pip install {toxinidir}/exporter/opentelemetry-exporter-jaeger opentracing-shim: pip install {toxinidir}/opentelemetry-sdk opentracing-shim: pip install {toxinidir}/shim/opentelemetry-opentracing-shim @@ -112,6 +117,8 @@ commands_pre = b3: pip install {toxinidir}/propagator/opentelemetry-propagator-b3 + propagator-jaeger: pip install {toxinidir}/propagator/opentelemetry-propagator-jaeger + ; In order to get a healthy coverage report, ; we have to install packages in editable mode. coverage: python {toxinidir}/scripts/eachdist.py install --editable @@ -159,6 +166,7 @@ commands_pre = python -m pip install -e {toxinidir}/exporter/opentelemetry-exporter-prometheus[test] python -m pip install -e {toxinidir}/exporter/opentelemetry-exporter-zipkin[test] python -m pip install -e {toxinidir}/propagator/opentelemetry-propagator-b3[test] + python -m pip install -e {toxinidir}/propagator/opentelemetry-propagator-jaeger[test] commands = python scripts/eachdist.py lint --check-only