Changes from code review feedback

Author: Joshua Lang

ext/opentelemetry-ext-aiohttp-client/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+
+- Initial release

ext/opentelemetry-ext-aiohttp-client/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.

ext/opentelemetry-ext-aiohttp-client/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

ext/opentelemetry-ext-aiohttp-client/src/opentelemetry/ext/aiohttp_client/__init__.py

@@ -16,9 +16,10 @@
 The opentelemetry-ext-aiohttp-client package allows tracing HTTP requests
 made by the aiohttp client library.
 
-Example usage:
+Usage
+-----
 
-    .. code-block:: python
+    .. code:: python
 
         import aiohttp
         from opentelemetry.ext.aiohttp_client import (
@@ -27,8 +28,7 @@
         )
         import yarl
 
-
-         def strip_query_params(url: yarl.URL) -> str:
+        def strip_query_params(url: yarl.URL) -> str:
             return str(url.with_query(None))
 
         async with aiohttp.ClientSession(trace_configs=[create_trace_config(
@@ -49,6 +49,7 @@ def strip_query_params(url: yarl.URL) -> str:
 
 import aiohttp
 
+from opentelemetry import context as context_api
 from opentelemetry import propagators, trace
 from opentelemetry.ext.aiohttp_client.version import __version__
 from opentelemetry.trace import SpanKind
@@ -108,7 +109,7 @@ def create_trace_config(
 ) -> aiohttp.TraceConfig:
     """Create an aiohttp-compatible trace configuration.
 
-    One span is created for the entire HTTP request, including intial
+    One span is created for the entire HTTP request, including initial
     TCP/TLS setup if the connection doesn't exist.
 
     By default the span name is set to the HTTP request method.
@@ -141,6 +142,10 @@ def create_trace_config(
 
     tracer = trace.get_tracer_provider().get_tracer(__name__, __version__)
 
+    def _end_trace(trace_config_ctx: types.SimpleNamespace):
+        context_api.detach(trace_config_ctx.token)
+        trace_config_ctx.span.end()
+
     async def on_request_start(
         unused_session: aiohttp.ClientSession,
         trace_config_ctx: types.SimpleNamespace,
@@ -166,15 +171,9 @@ async def on_request_start(
             },
         )
 
-        # Set the span as active via the `Tracer.use_span` context.
-        # TODO: would be nice to have an explicit API to set a context as active.
-        span_manager = contextlib.ExitStack()
-        span_manager.enter_context(
-            trace_config_ctx.tracer.use_span(
-                trace_config_ctx.span, end_on_exit=True
-            )
+        trace_config_ctx.token = context_api.attach(
+            trace.propagation.set_span_in_context(trace_config_ctx.span)
         )
-        trace_config_ctx.span_manager = span_manager
 
         propagators.inject(
             tracer, type(params.headers).__setitem__, params.headers
@@ -194,7 +193,7 @@ async def on_request_end(
         trace_config_ctx.span.set_attribute(
             "http.status_text", params.response.reason
         )
-        trace_config_ctx.span_manager.close()
+        _end_trace(trace_config_ctx)
 
     async def on_request_exception(
         unused_session: aiohttp.ClientSession,
@@ -216,7 +215,7 @@ async def on_request_exception(
             status = StatusCanonicalCode.UNAVAILABLE
 
         trace_config_ctx.span.set_status(Status(status))
-        trace_config_ctx.span_manager.close()
+        _end_trace(trace_config_ctx)
 
     def _trace_config_ctx_factory(**kwargs):
         if kwargs.get("trace_request_ctx", None) is None:

ext/opentelemetry-ext-aiohttp-client/src/opentelemetry/ext/aiohttp_client/version.py

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

ext/opentelemetry-ext-aiohttp-client/tests/test_aiohttp_client_integration.py

@@ -26,37 +26,23 @@
 
 import opentelemetry.ext.aiohttp_client
 from opentelemetry import trace
-from opentelemetry.sdk.trace import TracerProvider, export
-from opentelemetry.sdk.trace.export.in_memory_span_exporter import (
-    InMemorySpanExporter,
-)
+from opentelemetry.sdk.trace import export
+from opentelemetry.test.test_base import TestBase
 from opentelemetry.trace.status import StatusCanonicalCode
 
 
-class TestAioHttpIntegration(unittest.TestCase):
+class TestAioHttpIntegration(TestBase):
     maxDiff = None
 
-    InMemoryExporter = None
-
-    @classmethod
-    def setUpClass(cls):
-        trace.set_tracer_provider(TracerProvider())
-        cls.InMemoryExporter = InMemorySpanExporter()
-        span_processor = export.SimpleExportSpanProcessor(cls.InMemoryExporter)
-        trace.get_tracer_provider().add_span_processor(span_processor)
-
-    def tearDown(self):
-        self.InMemoryExporter.clear()
-
     def assert_spans(self, spans):
         self.assertEqual(
             [
                 (
                     span.name,
                     (span.status.canonical_code, span.status.description),
-                    dict(span.attributes),
+                    dict(span.attributes)
                 )
-                for span in self.InMemoryExporter.get_finished_spans()
+                for span in self.memory_exporter.get_finished_spans()
             ],
             spans,
         )
@@ -186,7 +172,7 @@ def test_status_codes(self):
                     ]
                 )
 
-                self.InMemoryExporter.clear()
+                self.memory_exporter.clear()
 
     def test_span_name_option(self):
         for span_name, method, path, expected in (
@@ -227,7 +213,7 @@ def test_span_name_option(self):
                         )
                     ]
                 )
-                self.InMemoryExporter.clear()
+                self.memory_exporter.clear()
 
     def test_url_filter_option(self):
         # Strips all query params from URL before adding as a span attribute.
@@ -295,7 +281,7 @@ async def do_request(url):
                     )
                 ]
             )
-            self.InMemoryExporter.clear()
+            self.memory_exporter.clear()
 
     def test_timeout(self):
         async def request_handler(unused_request):