Move AWS X-Ray Propagator into its own package (#720)

Co-authored-by: Owais Lone <owais@users.noreply.github.com>
Co-authored-by: Diego Hurtado <ocelotl@users.noreply.github.com>

.github/workflows/publish-a-package.yml

@@ -3,7 +3,7 @@ name: Publish a Package from Tag
 on:
   push:
     tags:
-      - 'opentelemetry-*==1.*'
+      - 'opentelemetry-*==[1-9]*.*'
 
 jobs:
   publish-a-package:

CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#667](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/667))
 - `opentelemetry-instrumentation-sqlalchemy` Added `packaging` dependency
   ([#713](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/713))
+- `opentelemetry-sdk-extension-aws` Move AWS X-Ray Propagator into its own `opentelemetry-propagators-aws` package
+  ([#720](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/720))
 
 
 ### Added

docs/conf.py

@@ -40,6 +40,13 @@ instr_dirs = [
     if isdir(join(instr, f))
 ]
 
+prop = "../propagator"
+prop_dirs = [
+    os.path.abspath("/".join([prop, f, "src"]))
+    for f in listdir(prop)
+    if isdir(join(prop, f))
+]
+
 sdk_ext = "../sdk-extension"
 sdk_ext_dirs = [
     os.path.abspath("/".join(["../sdk-extension", f, "src"]))
@@ -47,7 +54,7 @@ sdk_ext_dirs = [
     if isdir(join(sdk_ext, f))
 ]
 
-sys.path[:0] = exp_dirs + instr_dirs + sdk_ext_dirs
+sys.path[:0] = exp_dirs + instr_dirs + sdk_ext_dirs + prop_dirs
 
 # -- Project information -----------------------------------------------------
 

docs/index.rst

@@ -69,6 +69,14 @@ install <https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs>
 
     instrumentation/**
 
+.. toctree::
+    :maxdepth: 2
+    :caption: OpenTelemetry Propagators
+    :name: Propagators
+    :glob:
+
+    propagator/**
+
 .. toctree::
     :maxdepth: 2
     :caption: OpenTelemetry Performance

docs/propagator/aws/aws.rst

@@ -0,0 +1,7 @@
+OpenTelemetry Python - AWS X-Ray Propagator
+===========================================
+
+.. automodule:: opentelemetry.propagators.aws
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/sdk-extension/aws/aws.rst

@@ -5,8 +5,3 @@ OpenTelemetry Python - AWS SDK Extension
     :members:
     :undoc-members:
     :show-inheritance:
-
-.. automodule:: opentelemetry.sdk.extension.aws.trace.propagation.aws_xray_format
-    :members:
-    :undoc-members:
-    :show-inheritance:

propagator/opentelemetry-propagator-aws-xray/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.

propagator/opentelemetry-propagator-aws-xray/MANIFEST.rst

@@ -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

propagator/opentelemetry-propagator-aws-xray/README.rst

@@ -0,0 +1,53 @@
+OpenTelemetry Propagator for AWS X-Ray Service
+==============================================
+
+|pypi|
+
+.. |pypi| image:: https://badge.fury.io/py/opentelemetry-propagator-aws-xray.svg
+   :target: https://pypi.org/project/opentelemetry-propagator-aws-xray/
+
+
+This library provides the propagator necessary to inject or extract a tracing
+context across AWS services.
+
+Installation
+------------
+
+::
+
+    pip install opentelemetry-propagator-aws-xray
+
+
+Usage (AWS X-Ray Propagator)
+----------------------------
+
+**NOTE**: Because the parent context extracted from the `X-Amzn-Trace-Id` header
+assumes the context is _not_ sampled by default, users should make sure to add
+`Sampled=1` to their `X-Amzn-Trace-Id` headers so that the child spans are
+sampled.
+
+Use the provided AWS X-Ray Propagator to inject the necessary context into
+traces sent to external systems.
+
+This can be done by either setting this environment variable:
+
+::
+
+    export OTEL_PROPAGATORS = xray
+
+
+Or by setting this propagator in your instrumented application:
+
+.. code-block:: python
+
+    from opentelemetry.propagate import set_global_textmap
+    from opentelemetry.propagators.aws import AwsXRayFormat
+
+    set_global_textmap(AwsXRayFormat())
+
+
+References
+----------
+
+* `OpenTelemetry Project <https://opentelemetry.io/>`_
+* `AWS X-Ray Propagation Trace Header <https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader>`_

propagator/opentelemetry-propagator-aws-xray/setup.cfg

@@ -0,0 +1,52 @@
+# 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-aws-xray
+description = AWS X-Ray Propagator for OpenTelemetry
+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/propagator/opentelemetry-propagator-aws-xray
+platforms = any
+license = Apache-2.0
+classifiers =
+    Development Status :: 5 - Production/Stable
+    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
+
+[options]
+python_requires = >=3.6
+package_dir=
+    =src
+packages=find_namespace:
+install_requires =
+    opentelemetry-api ~= 1.3
+
+[options.entry_points]
+opentelemetry_propagator =
+    xray = opentelemetry.propagators.aws:AwsXRayFormat
+
+[options.extras_require]
+test =
+    opentelemetry-test == 0.24b0
+
+[options.packages.find]
+where = src

propagator/opentelemetry-propagator-aws-xray/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", "aws", "version.py"
+)
+PACKAGE_INFO = {}
+with open(VERSION_FILENAME, encoding="utf-8") as f:
+    exec(f.read(), PACKAGE_INFO)
+
+setuptools.setup(version=PACKAGE_INFO["__version__"])

propagator/opentelemetry-propagator-aws-xray/src/opentelemetry/propagators/aws/__init__.py

@@ -47,7 +47,7 @@ Or by setting this propagator in your instrumented application:
 .. code-block:: python
 
     from opentelemetry.propagate import set_global_textmap
-    from opentelemetry.sdk.extension.aws.trace.propagation.aws_xray_format import AwsXRayFormat
+    from opentelemetry.propagators.aws import AwsXRayFormat
 
     set_global_textmap(AwsXRayFormat())
 

propagator/opentelemetry-propagator-aws-xray/src/opentelemetry/propagators/aws/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__ = "1.0.0"

propagator/opentelemetry-propagator-aws-xray/tests/performance/benchmarks/trace/propagation/test_benchmark_aws_xray_format.py

@@ -14,10 +14,7 @@
 
 from requests.structures import CaseInsensitiveDict
 
-from opentelemetry.sdk.extension.aws.trace.propagation.aws_xray_format import (
-    TRACE_HEADER_KEY,
-    AwsXRayFormat,
-)
+from opentelemetry.propagators.aws import TRACE_HEADER_KEY, AwsXRayFormat
 
 XRAY_PROPAGATOR = AwsXRayFormat()
 

propagator/opentelemetry-propagator-aws-xray/tests/trace/propagation/test_aws_xray_format.py

@@ -19,10 +19,7 @@ from requests.structures import CaseInsensitiveDict
 
 import opentelemetry.trace as trace_api
 from opentelemetry.context import Context
-from opentelemetry.sdk.extension.aws.trace.propagation.aws_xray_format import (
-    TRACE_HEADER_KEY,
-    AwsXRayFormat,
-)
+from opentelemetry.propagators.aws import TRACE_HEADER_KEY, AwsXRayFormat
 from opentelemetry.trace import (
     DEFAULT_TRACE_OPTIONS,
     DEFAULT_TRACE_STATE,
@@ -299,10 +296,7 @@ class AwsXRayPropagatorTest(unittest.TestCase):
 
                 self.assertDictEqual(Context(), ctx)
 
-    @patch(
-        "opentelemetry.sdk.extension.aws.trace."
-        "propagation.aws_xray_format.trace"
-    )
+    @patch("opentelemetry.propagators.aws.trace")
     def test_fields(self, mock_trace):
         """Make sure the fields attribute returns the fields used in inject"""
 

sdk-extension/opentelemetry-sdk-extension-aws/README.rst

@@ -43,33 +43,6 @@ Next, use the provided `AwsXRayIdGenerator` to initialize the `TracerProvider`.
     )
 
 
-Usage (AWS X-Ray Propagator)
-----------------------------
-
-**NOTE**: Because the parent context extracted from the `X-Amzn-Trace-Id` header
-assumes the context is _not_ sampled by default, users should make sure to add
-`Sampled=1` to their `X-Amzn-Trace-Id` headers so that the child spans are
-sampled.
-
-Use the provided AWS X-Ray Propagator to inject the necessary context into
-traces sent to external systems.
-
-This can be done by either setting this environment variable:
-
-::
-
-    export OTEL_PROPAGATORS = xray
-
-
-Or by setting this propagator in your instrumented application:
-
-.. code-block:: python
-
-    from opentelemetry.propagate import set_global_textmap
-    from opentelemetry.sdk.extension.aws.trace.propagation.aws_xray_format import AwsXRayFormat
-
-    set_global_textmap(AwsXRayFormat())
-
 Usage (AWS Resource Detectors)
 ------------------------------
 

sdk-extension/opentelemetry-sdk-extension-aws/setup.cfg

@@ -41,8 +41,6 @@ install_requires =
     opentelemetry-sdk ~= 1.3
 
 [options.entry_points]
-opentelemetry_propagator =
-    xray = opentelemetry.sdk.extension.aws.trace.propagation.aws_xray_format:AwsXRayFormat
 opentelemetry_id_generator =
     xray = opentelemetry.sdk.extension.aws.trace.aws_xray_id_generator:AwsXRayIdGenerator
 

sdk-extension/opentelemetry-sdk-extension-aws/src/opentelemetry/sdk/extension/aws/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "1.1.0dev0"
+__version__ = "2.0.0"

tox.ini

@@ -149,6 +149,10 @@ envlist =
     py3{6,7,8,9}-test-util-http
     pypy3-test-util-http
 
+    ; opentelemetry-propagator-aws-xray
+    py3{6,7,8,9}-test-propagator-aws-xray
+    pypy3-test-propagator-aws-xray
+
     ; opentelemetry-propagator-ot-trace
     py3{6,7,8,9}-test-propagator-ot-trace
     pypy3-test-propagator-ot-trace
@@ -231,6 +235,7 @@ changedir =
   test-instrumentation-httpx: instrumentation/opentelemetry-instrumentation-httpx/tests
   test-util-http: util/opentelemetry-util-http/tests
   test-sdkextension-aws: sdk-extension/opentelemetry-sdk-extension-aws/tests
+  test-propagator-aws: propagator/opentelemetry-propagator-aws-xray/tests
   test-propagator-ot-trace: propagator/opentelemetry-propagator-ot-trace/tests
   test-exporter-datadog: exporter/opentelemetry-exporter-datadog/tests
 
@@ -316,12 +321,14 @@ commands_pre =
 
   httpx: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-httpx[test]
 
-  aws: pip install requests {toxinidir}/sdk-extension/opentelemetry-sdk-extension-aws[test]
+  sdkextension-aws: pip install {toxinidir}/sdk-extension/opentelemetry-sdk-extension-aws[test]
 
   http: pip install {toxinidir}/util/opentelemetry-util-http[test]
 ; In order to get a health coverage report,
   propagator-ot-trace: pip install {toxinidir}/propagator/opentelemetry-propagator-ot-trace[test]
 
+  propagator-aws-xray: pip install requests {toxinidir}/propagator/opentelemetry-propagator-aws-xray[test]
+
 ; we have to install packages in editable mode.
   coverage: python {toxinidir}/scripts/eachdist.py install --editable
 
@@ -403,6 +410,7 @@ commands_pre =
   python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-httpx[test]
   python -m pip install -e {toxinidir}/exporter/opentelemetry-exporter-datadog[test]
   python -m pip install -e {toxinidir}/sdk-extension/opentelemetry-sdk-extension-aws[test]
+  python -m pip install -e {toxinidir}/propagator/opentelemetry-propagator-aws-xray[test]
   python -m pip install -e {toxinidir}/propagator/opentelemetry-propagator-ot-trace[test]
 
 commands =