Merge branch 'main' of https://github.com/open-telemetry/opentelemetry-python-contrib

Author: lzchen

.github/CODEOWNERS

@@ -1,5 +1,26 @@
 # Code owners file.
 # This file controls who is tagged for review for any given pull request.
+#
+# What is a "CODEOWNER"?
+#
+# A CODEOWNER lends their expertise to a specific package hosted by an OpenTelemetry repository.
+#
+# A CODEOWNER MUST:
+# - introduce themselves on the CNCF OTel Python channel: https://cloud-native.slack.com/archives/C01PD4HUVBL
+# - have enough knowledge of the corresponding instrumented library
+# - respond to issues
+# - fix failing unit tests or any other blockers to the CI/CD workflow
+# - update usage of `opentelemetry-python-core` APIs upon the introduction of breaking changes
+# - be a member of the OpenTelemetry community so that the `component-owners.yml` action to automatically assign CODEOWNERS to PRs works correctly.
+#
+
 
 # For anything not explicitly taken by someone else:
 * @open-telemetry/opentelemetry-python-contrib-approvers
+
+# Learn about CODEOWNERS file format:
+# https://help.github.com/en/articles/about-code-owners
+#
+# Learn about membership in OpenTelemetry community:
+# https://github.com/open-telemetry/community/blob/main/community-membership.md
+#

.github/component_owners.yml

@@ -0,0 +1,4 @@
+components:
+
+  sdk-extension/opentelemetry-sdk-extension-aws:
+    - NathanielRN

.github/workflows/component-owners.yml

@@ -0,0 +1,17 @@
+# This action assigns and requires approval from owners of components for
+# PRs that are open against those components. Components are defined as
+# individual paths within this repository.
+name: 'Component Owners'
+
+on:
+  pull_request_target:
+
+jobs:
+  run_self:
+    runs-on: ubuntu-latest
+    name: Auto Assign Owners
+    # Don't fail tests if this workflow fails. Some pending issues:
+    # - https://github.com/dyladan/component-owners/issues/8
+    continue-on-error: true
+    steps:
+      - uses: dyladan/component-owners@main

CHANGELOG.md

@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v1.5.0-0.24b0...HEAD)
+- `opentelemetry-sdk-extension-aws` Release AWS Python SDK Extension as 1.0.0
+  ([#667](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/667))
+
+### Changed
+- `opentelemetry-instrumentation-botocore` Unpatch botocore Endpoint.prepare_request on uninstrument
+  ([#664](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/664))
+- `opentelemetry-instrumentation-botocore` Fix span injection for lambda invoke
+  ([#663](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/663))
 
 ## [1.5.0-0.24b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.5.0-0.24b0) - 2021-08-26
 
@@ -20,8 +28,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `opentelemetry-instrumentation-fastapi` Allow instrumentation of newer FastAPI versions.
   ([#602](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/602))
-
-### Changed
 - Enable explicit `excluded_urls` argument in `opentelemetry-instrumentation-flask`
   ([#604](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/604))
 

CODEOWNERS

@@ -66,6 +66,24 @@ install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)
 pip install -e ./instrumentation/opentelemetry-instrumentation-{integration}
 ```
 
+## Releasing
+
+Maintainers aim to periodically release new versions of the packages in `opentelemetry-python-contrib`.
+
+Contributions that enhance OTel for Python are welcome to be hosted upstream for the benefit of group collaboration. Maintainers will look for things like good documentation, good unit tests, and in general their own confidence when deciding to release a package with the stability guarantees that are implied with a `1.0` release.
+
+To resolve this, members of the community are encouraged to commit to becoming a CODEOWNER for packages in `-contrib` that they feel experienced enough to maintain. CODEOWNERS can then follow the checklist below to release `-contrib` packages as 1.0 stable:
+
+### Releasing a package as `1.0` stable
+
+To release a package as `1.0` stable, the package:
+- SHOULD have a CODEOWNER. To become one, submit an issue and explain why you meet the responsibilities found in [CODEOWNERS](.github/CODEOWNERS).
+- MUST have unit tests that cover all supported versions of the instrumented library.
+  - e.g. Instrumentation packages might use different techniques to instrument different major versions of python packages
+- MUST have clear documentation for non-obvious usages of the package
+  - e.g. If an instrumentation package uses flags, a token as context, or parameters that are not typical of the `BaseInstrumentor` class, these are documented
+- After the release of `1.0`, a CODEOWNER may no longer feel like they have the bandwidth to meet the responsibilities of maintaining the package. That's not a problem at all, life happens! However, if that is the case, we ask that the CODEOWNER please raise an issue indicating that they would like to be removed as a CODEOWNER so that they don't get pinged on future PRs. Ultimately, we hope to use that issue to find a new CODEOWNER.
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md)

README.md

@@ -39,14 +39,14 @@ package_dir=
 packages=find_namespace:
 install_requires =
     opentelemetry-api ~= 1.3
-    opentelemetry-semantic-conventions == 0.24b0
     opentelemetry-instrumentation-dbapi == 0.24b0
     opentelemetry-instrumentation == 0.24b0
     wrapt >= 1.0.0, < 2.0.0
 
 [options.extras_require]
 test =
     opentelemetry-test == 0.24b0
+    opentelemetry-semantic-conventions == 0.24b0
 
 [options.packages.find]
 where = src

instrumentation/opentelemetry-instrumentation-aiopg/setup.cfg

@@ -41,7 +41,6 @@ install_requires =
     opentelemetry-api ~= 1.3
     opentelemetry-semantic-conventions == 0.24b0
     opentelemetry-instrumentation == 0.24b0
-    opentelemetry-instrumentation-botocore == 0.24b0
 
 [options.extras_require]
 test =

instrumentation/opentelemetry-instrumentation-boto/setup.cfg

@@ -51,6 +51,7 @@
 from typing import Collection
 
 from botocore.client import BaseClient
+from botocore.endpoint import Endpoint
 from botocore.exceptions import ClientError
 from wrapt import wrap_function_wrapper
 
@@ -114,6 +115,7 @@ def _instrument(self, **kwargs):
 
     def _uninstrument(self, **kwargs):
         unwrap(BaseClient, "_make_api_call")
+        unwrap(Endpoint, "prepare_request")
 
     @staticmethod
     def _is_lambda_invoke(service_name, operation_name, api_params):
@@ -148,15 +150,15 @@ def _patched_api_call(self, original_func, instance, args, kwargs):
         error = None
         result = None
 
-        # inject trace context into payload headers for lambda Invoke
-        if BotocoreInstrumentor._is_lambda_invoke(
-            service_name, operation_name, api_params
-        ):
-            BotocoreInstrumentor._patch_lambda_invoke(api_params)
-
         with self._tracer.start_as_current_span(
             "{}".format(service_name), kind=SpanKind.CLIENT,
         ) as span:
+            # inject trace context into payload headers for lambda Invoke
+            if BotocoreInstrumentor._is_lambda_invoke(
+                service_name, operation_name, api_params
+            ):
+                BotocoreInstrumentor._patch_lambda_invoke(api_params)
+
             if span.is_recording():
                 span.set_attribute("aws.operation", operation_name)
                 span.set_attribute("aws.region", instance.meta.region_name)

instrumentation/opentelemetry-instrumentation-botocore/src/opentelemetry/instrumentation/botocore/__init__.py

@@ -61,6 +61,7 @@ def lambda_handler(event, context):
     return pfunc
 
 
+# pylint:disable=too-many-public-methods
 class TestBotocoreInstrumentor(TestBase):
     """Botocore integration testsuite"""
 
@@ -322,6 +323,31 @@ def test_unpatch(self):
         spans = self.memory_exporter.get_finished_spans()
         assert not spans, spans
 
+    @mock_ec2
+    def test_uninstrument_does_not_inject_headers(self):
+        headers = {}
+        previous_propagator = get_global_textmap()
+        try:
+            set_global_textmap(MockTextMapPropagator())
+
+            def intercept_headers(**kwargs):
+                headers.update(kwargs["request"].headers)
+
+            ec2 = self.session.create_client("ec2", region_name="us-west-2")
+
+            BotocoreInstrumentor().uninstrument()
+
+            ec2.meta.events.register_first(
+                "before-send.ec2.DescribeInstances", intercept_headers
+            )
+            with self.tracer_provider.get_tracer("test").start_span("parent"):
+                ec2.describe_instances()
+
+            self.assertNotIn(MockTextMapPropagator.TRACE_ID_KEY, headers)
+            self.assertNotIn(MockTextMapPropagator.SPAN_ID_KEY, headers)
+        finally:
+            set_global_textmap(previous_propagator)
+
     @mock_sqs
     def test_double_patch(self):
         sqs = self.session.create_client("sqs", region_name="us-east-1")
@@ -409,11 +435,13 @@ def test_lambda_invoke_propagation(self):
 
             self.assertIn(MockTextMapPropagator.TRACE_ID_KEY, headers)
             self.assertEqual(
-                "0", headers[MockTextMapPropagator.TRACE_ID_KEY],
+                str(spans[2].get_span_context().trace_id),
+                headers[MockTextMapPropagator.TRACE_ID_KEY],
             )
             self.assertIn(MockTextMapPropagator.SPAN_ID_KEY, headers)
             self.assertEqual(
-                "0", headers[MockTextMapPropagator.SPAN_ID_KEY],
+                str(spans[2].get_span_context().span_id),
+                headers[MockTextMapPropagator.SPAN_ID_KEY],
             )
         finally:
             set_global_textmap(previous_propagator)

instrumentation/opentelemetry-instrumentation-botocore/tests/test_botocore_instrumentation.py

@@ -42,7 +42,6 @@ install_requires =
     opentelemetry-api ~= 1.3
     opentelemetry-instrumentation == 0.24b0
     opentelemetry-semantic-conventions == 0.24b0
-    wrapt >= 1.0.0, < 2.0.0
 
 [options.extras_require]
 test =

instrumentation/opentelemetry-instrumentation-httpx/setup.cfg

@@ -41,7 +41,6 @@ install_requires =
     opentelemetry-api ~= 1.3
     opentelemetry-instrumentation-dbapi == 0.24b0
     opentelemetry-instrumentation == 0.24b0
-    wrapt >= 1.0.0, < 2.0.0
 
 [options.extras_require]
 test =

instrumentation/opentelemetry-instrumentation-mysql/setup.cfg

@@ -30,7 +30,7 @@
 
     cnx = mysql.connector.connect(database="MySQL_Database")
     cursor = cnx.cursor()
-    cursor.execute("INSERT INTO test (testField) VALUES (123)"
+    cursor.execute("INSERT INTO test (testField) VALUES (123)")
     cursor.close()
     cnx.close()
 

instrumentation/opentelemetry-instrumentation-mysql/src/opentelemetry/instrumentation/mysql/__init__.py

@@ -41,7 +41,6 @@ install_requires =
     opentelemetry-api ~= 1.3
     opentelemetry-instrumentation-dbapi == 0.24b0
     opentelemetry-instrumentation == 0.24b0
-    wrapt >= 1.0.0, < 2.0.0
 
 [options.extras_require]
 test =

instrumentation/opentelemetry-instrumentation-psycopg2/setup.cfg

@@ -41,7 +41,6 @@ install_requires =
     opentelemetry-api ~= 1.3
     opentelemetry-instrumentation-dbapi == 0.24b0
     opentelemetry-instrumentation == 0.24b0
-    wrapt >= 1.0.0, < 2.0.0
 
 [options.extras_require]
 test =

instrumentation/opentelemetry-instrumentation-sqlite3/setup.cfg

@@ -46,6 +46,11 @@ 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.
 

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

@@ -18,9 +18,17 @@
 
 The **AWS X-Ray Propagator** provides a propagator that when used, adds a `trace
 header`_ to outgoing traces that is compatible with the AWS X-Ray backend service.
-This allows the trace context to be propagated when a trace span multiple AWS
+This allows the trace context to be propagated when a trace spans multiple AWS
 services.
 
+The same propagator setup is used to extract a context sent by external systems
+so that child span have the correct parent context.
+
+**NOTE**: Because the parent context parsed 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.
+
 Usage
 -----
 

sdk-extension/opentelemetry-sdk-extension-aws/src/opentelemetry/sdk/extension/aws/trace/propagation/aws_xray_format.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.24b0"
+__version__ = "1.0.0"

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

@@ -37,14 +37,6 @@ python_requires = >=3.6
 package_dir=
     =src
 packages=find_namespace:
-install_requires =
-    opentelemetry-api ~= 1.3
-    opentelemetry-instrumentation == 0.24b0
-    asgiref ~= 3.0
-
-[options.extras_require]
-test =
-    opentelemetry-test == 0.24b0
 
 [options.packages.find]
 where = src