Merge branch 'main' into flask_hooks

.github/workflows/test.yml

@@ -45,7 +45,7 @@ jobs:
         uses: actions/cache@v2
         with:
           path: .tox
-          key: tox-cache-${{ env.RUN_MATRIX_COMBINATION }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}
+          key: v2-build-tox-cache-${{ env.RUN_MATRIX_COMBINATION }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}
       - name: run tox
         run: tox -f ${{ matrix.python-version }}-${{ matrix.package }} -- --benchmark-json=${{ env.RUN_MATRIX_COMBINATION }}-benchmark.json
       - name: Find and merge benchmarks
@@ -99,6 +99,6 @@ jobs:
         uses: actions/cache@v2
         with:
           path: .tox
-          key: v2-tox-cache-${{ matrix.tox-environment }}-${{ hashFiles('tox.ini', 'dev-requirements.txt', 'docs-requirements.txt') }}
+          key: v2-misc-tox-cache-${{ matrix.tox-environment }}-${{ hashFiles('tox.ini', 'dev-requirements.txt', 'docs-requirements.txt') }}
       - name: run tox
         run: tox -e ${{ matrix.tox-environment }}

CHANGELOG.md

@@ -12,15 +12,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `opentelemetry-instrumentation-tornado` Fixed cases where description was used with non-
   error status code when creating Status objects.
   ([#504](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/504))
+- `opentelemetry-instrumentation-asgi` Fix instrumentation default span name.
+  ([#418](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/418))
+- Propagators use the root context as default for `extract` and do not modify
+  the context if extracting from carrier does not work.
+  ([#488](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/488))
 
 ### Added
 - `opentelemetry-instrumentation-botocore` now supports
-  context propagation for lambda invoke via Payload embedded headers. 
+  context propagation for lambda invoke via Payload embedded headers.
   ([#458](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/458))
-  
+
 ## [0.21b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.2.0-0.21b0) - 2021-05-11
 
 ### Changed
+- Instrumentation packages don't specify the libraries they instrument as dependencies
+  anymore. Instead, they verify the correct version of libraries are installed at runtime.
+  ([#475](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/475))
 - `opentelemetry-propagator-ot-trace` Use `TraceFlags` object in `extract`
   ([#472](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/472))
 - Set the `traced_request_attrs` of FalconInstrumentor by an argument correctly.
@@ -85,7 +93,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#436](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/436))
 - `opentelemetry-instrumentation-grpc` Keep client interceptor in sync with grpc client interceptors.
   ([#442](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/442))
-  
+
 ### Removed
 - Remove `http.status_text` from span attributes
   ([#406](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/406))

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   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.

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/propagator.py

@@ -42,6 +42,9 @@ def extract(
         context: typing.Optional[Context] = None,
         getter: Getter = default_getter,
     ) -> Context:
+        if context is None:
+            context = Context()
+
         trace_id = extract_first_element(
             getter.get(carrier, self.TRACE_ID_KEY)
         )
@@ -64,7 +67,7 @@ def extract(
             trace_flags = trace.TraceFlags(trace.TraceFlags.SAMPLED)
 
         if trace_id is None or span_id is None:
-            return set_span_in_context(trace.INVALID_SPAN, context)
+            return context
 
         trace_state = []
         if origin is not None:

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/spanprocessor.py

@@ -186,7 +186,7 @@ def export(self) -> None:
                 self.flush_condition.notify()
 
     def _drain_queue(self):
-        """"Export all elements until queue is empty.
+        """Export all elements until queue is empty.
 
         Can only be called from the worker thread context because it invokes
         `export` that is not thread safe.

exporter/opentelemetry-exporter-datadog/tests/test_datadog_format.py

@@ -16,6 +16,7 @@
 from unittest.mock import Mock, patch
 
 from opentelemetry import trace as trace_api
+from opentelemetry.context import Context
 from opentelemetry.exporter.datadog import constants, propagator
 from opentelemetry.sdk import trace
 from opentelemetry.sdk.trace.id_generator import RandomIdGenerator
@@ -36,42 +37,58 @@ def setUpClass(cls):
         )
         cls.serialized_origin = "origin-service"
 
-    def test_malformed_headers(self):
+    def test_extract_malformed_headers_to_explicit_ctx(self):
         """Test with no Datadog headers"""
+        orig_ctx = Context({"k1": "v1"})
         malformed_trace_id_key = FORMAT.TRACE_ID_KEY + "-x"
         malformed_parent_id_key = FORMAT.PARENT_ID_KEY + "-x"
-        context = get_current_span(
-            FORMAT.extract(
-                {
-                    malformed_trace_id_key: self.serialized_trace_id,
-                    malformed_parent_id_key: self.serialized_parent_id,
-                },
-            )
-        ).get_span_context()
+        context = FORMAT.extract(
+            {
+                malformed_trace_id_key: self.serialized_trace_id,
+                malformed_parent_id_key: self.serialized_parent_id,
+            },
+            orig_ctx,
+        )
+        self.assertDictEqual(orig_ctx, context)
 
-        self.assertNotEqual(context.trace_id, int(self.serialized_trace_id))
-        self.assertNotEqual(context.span_id, int(self.serialized_parent_id))
-        self.assertFalse(context.is_remote)
+    def test_extract_malformed_headers_to_implicit_ctx(self):
+        malformed_trace_id_key = FORMAT.TRACE_ID_KEY + "-x"
+        malformed_parent_id_key = FORMAT.PARENT_ID_KEY + "-x"
+        context = FORMAT.extract(
+            {
+                malformed_trace_id_key: self.serialized_trace_id,
+                malformed_parent_id_key: self.serialized_parent_id,
+            }
+        )
+        self.assertDictEqual(Context(), context)
 
-    def test_missing_trace_id(self):
+    def test_extract_missing_trace_id_to_explicit_ctx(self):
         """If a trace id is missing, populate an invalid trace id."""
-        carrier = {
-            FORMAT.PARENT_ID_KEY: self.serialized_parent_id,
-        }
+        orig_ctx = Context({"k1": "v1"})
+        carrier = {FORMAT.PARENT_ID_KEY: self.serialized_parent_id}
+
+        ctx = FORMAT.extract(carrier, orig_ctx)
+        self.assertDictEqual(orig_ctx, ctx)
+
+    def test_extract_missing_trace_id_to_implicit_ctx(self):
+        carrier = {FORMAT.PARENT_ID_KEY: self.serialized_parent_id}
 
         ctx = FORMAT.extract(carrier)
-        span_context = get_current_span(ctx).get_span_context()
-        self.assertEqual(span_context.trace_id, trace_api.INVALID_TRACE_ID)
+        self.assertDictEqual(Context(), ctx)
 
-    def test_missing_parent_id(self):
+    def test_extract_missing_parent_id_to_explicit_ctx(self):
         """If a parent id is missing, populate an invalid trace id."""
-        carrier = {
-            FORMAT.TRACE_ID_KEY: self.serialized_trace_id,
-        }
+        orig_ctx = Context({"k1": "v1"})
+        carrier = {FORMAT.TRACE_ID_KEY: self.serialized_trace_id}
+
+        ctx = FORMAT.extract(carrier, orig_ctx)
+        self.assertDictEqual(orig_ctx, ctx)
+
+    def test_extract_missing_parent_id_to_implicit_ctx(self):
+        carrier = {FORMAT.TRACE_ID_KEY: self.serialized_trace_id}
 
         ctx = FORMAT.extract(carrier)
-        span_context = get_current_span(ctx).get_span_context()
-        self.assertEqual(span_context.span_id, trace_api.INVALID_SPAN_ID)
+        self.assertDictEqual(Context(), ctx)
 
     def test_context_propagation(self):
         """Test the propagation of Datadog headers."""

instrumentation/opentelemetry-instrumentation-aiohttp-client/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   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.

instrumentation/opentelemetry-instrumentation-aiohttp-client/setup.cfg

@@ -41,7 +41,6 @@ install_requires =
     opentelemetry-api == 1.3.0.dev0
     opentelemetry-semantic-conventions == 0.22.dev0
     opentelemetry-instrumentation == 0.22.dev0
-    aiohttp ~= 3.0
     wrapt >= 1.0.0, < 2.0.0
 
 [options.packages.find]

instrumentation/opentelemetry-instrumentation-aiohttp-client/setup.py

@@ -18,10 +18,24 @@
 
 
 import os
+from configparser import ConfigParser
 
 import setuptools
 
+config = ConfigParser()
+config.read("setup.cfg")
+
+# We provide extras_require parameter to setuptools.setup later which
+# overwrites the extra_require section from setup.cfg. To support extra_require
+# secion in setup.cfg, we load it here and merge it with the extra_require param.
+extras_require = {}
+if "options.extras_require" in config:
+    for key, value in config["options.extras_require"].items():
+        extras_require[key] = [v for v in value.split("\n") if v.strip()]
+
 BASE_DIR = os.path.dirname(__file__)
+PACKAGE_INFO = {}
+
 VERSION_FILENAME = os.path.join(
     BASE_DIR,
     "src",
@@ -30,8 +44,28 @@
     "aiohttp_client",
     "version.py",
 )
-PACKAGE_INFO = {}
 with open(VERSION_FILENAME) as f:
     exec(f.read(), PACKAGE_INFO)
 
-setuptools.setup(version=PACKAGE_INFO["__version__"])
+PACKAGE_FILENAME = os.path.join(
+    BASE_DIR,
+    "src",
+    "opentelemetry",
+    "instrumentation",
+    "aiohttp_client",
+    "package.py",
+)
+with open(PACKAGE_FILENAME) as f:
+    exec(f.read(), PACKAGE_INFO)
+
+# Mark any instruments/runtime dependencies as test dependencies as well.
+extras_require["instruments"] = PACKAGE_INFO["_instruments"]
+test_deps = extras_require.get("test", [])
+for dep in extras_require["instruments"]:
+    test_deps.append(dep)
+
+extras_require["test"] = test_deps
+
+setuptools.setup(
+    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+)

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

@@ -64,12 +64,14 @@ def strip_query_params(url: yarl.URL) -> str:
 
 import types
 import typing
+from typing import Collection
 
 import aiohttp
 import wrapt
 
 from opentelemetry import context as context_api
 from opentelemetry import trace
+from opentelemetry.instrumentation.aiohttp_client.package import _instruments
 from opentelemetry.instrumentation.aiohttp_client.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from opentelemetry.instrumentation.utils import (
@@ -288,6 +290,9 @@ class AioHttpClientInstrumentor(BaseInstrumentor):
     See `BaseInstrumentor`
     """
 
+    def instrumentation_dependencies(self) -> Collection[str]:
+        return _instruments
+
     def _instrument(self, **kwargs):
         """Instruments aiohttp ClientSession
 

instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/package.py

@@ -0,0 +1,16 @@
+# Copyright 2020, 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.
+
+
+_instruments = ("aiohttp ~= 3.0",)

instrumentation/opentelemetry-instrumentation-aiopg/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   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.

instrumentation/opentelemetry-instrumentation-aiopg/setup.cfg

@@ -42,7 +42,6 @@ install_requires =
     opentelemetry-semantic-conventions == 0.22.dev0
     opentelemetry-instrumentation-dbapi == 0.22.dev0
     opentelemetry-instrumentation == 0.22.dev0
-    aiopg >= 0.13.0
     wrapt >= 1.0.0, < 2.0.0
 
 [options.extras_require]

instrumentation/opentelemetry-instrumentation-aiopg/setup.py

@@ -18,15 +18,44 @@
 
 
 import os
+from configparser import ConfigParser
 
 import setuptools
 
+config = ConfigParser()
+config.read("setup.cfg")
+
+# We provide extras_require parameter to setuptools.setup later which
+# overwrites the extra_require section from setup.cfg. To support extra_require
+# secion in setup.cfg, we load it here and merge it with the extra_require param.
+extras_require = {}
+if "options.extras_require" in config:
+    for key, value in config["options.extras_require"].items():
+        extras_require[key] = [v for v in value.split("\n") if v.strip()]
+
 BASE_DIR = os.path.dirname(__file__)
+PACKAGE_INFO = {}
+
 VERSION_FILENAME = os.path.join(
     BASE_DIR, "src", "opentelemetry", "instrumentation", "aiopg", "version.py"
 )
-PACKAGE_INFO = {}
 with open(VERSION_FILENAME) as f:
     exec(f.read(), PACKAGE_INFO)
 
-setuptools.setup(version=PACKAGE_INFO["__version__"])
+PACKAGE_FILENAME = os.path.join(
+    BASE_DIR, "src", "opentelemetry", "instrumentation", "aiopg", "package.py"
+)
+with open(PACKAGE_FILENAME) as f:
+    exec(f.read(), PACKAGE_INFO)
+
+# Mark any instruments/runtime dependencies as test dependencies as well.
+extras_require["instruments"] = PACKAGE_INFO["_instruments"]
+test_deps = extras_require.get("test", [])
+for dep in extras_require["instruments"]:
+    test_deps.append(dep)
+
+extras_require["test"] = test_deps
+
+setuptools.setup(
+    version=PACKAGE_INFO["__version__"], extras_require=extras_require
+)

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

@@ -45,7 +45,10 @@
 ---
 """
 
+from typing import Collection
+
 from opentelemetry.instrumentation.aiopg import wrappers
+from opentelemetry.instrumentation.aiopg.package import _instruments
 from opentelemetry.instrumentation.aiopg.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 
@@ -60,6 +63,9 @@ class AiopgInstrumentor(BaseInstrumentor):
 
     _DATABASE_SYSTEM = "postgresql"
 
+    def instrumentation_dependencies(self) -> Collection[str]:
+        return _instruments
+
     def _instrument(self, **kwargs):
         """Integrate with PostgreSQL aiopg library.
         aiopg: https://github.com/aio-libs/aiopg

instrumentation/opentelemetry-instrumentation-aiopg/src/opentelemetry/instrumentation/aiopg/package.py

@@ -0,0 +1,16 @@
+# 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.
+
+
+_instruments = ("aiopg >= 0.13.0",)