Merge branch 'main' into issue_1968

Author: ocelotl

.github/workflows/test.yml

@@ -10,7 +10,7 @@ env:
   # Otherwise, set variable to the commit of your branch on
   # opentelemetry-python-contrib which is compatible with these Core repo
   # changes.
-  CONTRIB_REPO_SHA: 3ad534cbba41c2b92618f5f03c4c92cee4a72df6
+  CONTRIB_REPO_SHA: dde62cebffe519c35875af6d06fae053b3be65ec
 
 jobs:
   build:
@@ -20,15 +20,15 @@ jobs:
       py37: 3.7
       py38: 3.8
       py39: 3.9
-      pypy3: pypy3
+      pypy3: pypy-3.7
       RUN_MATRIX_COMBINATION: ${{ matrix.python-version }}-${{ matrix.package }}-${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false  # ensures the entire test matrix is run, even if one permutation fails
       matrix:
         python-version: [ py36, py37, py38, py39, pypy3 ]
         package: ["instrumentation", "core", "exporter", "propagator"]
-        os: [ ubuntu-latest ]
+        os: [ ubuntu-20.04, windows-2019 ]
     steps:
       - name: Checkout Core Repo @ SHA - ${{ github.sha }}
         uses: actions/checkout@v2
@@ -42,14 +42,22 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: ${{ env[matrix.python-version] }}
+          architecture: 'x64'
       - name: Install tox
         run: pip install -U tox-factor
       - name: Cache tox environment
         # Preserves .tox directory between runs for faster installs
         uses: actions/cache@v2
         with:
-          path: .tox
-          key: tox-cache-${{ env.RUN_MATRIX_COMBINATION }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}-core
+          path: |
+            .tox
+            ~/.cache/pip
+          key: v2-tox-cache-${{ env.RUN_MATRIX_COMBINATION }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}-core
+      # tox fails on windows and Python3.6 when tox dir is reused between builds so we remove it
+      - name: fix for windows + py3.6
+        if: ${{ matrix.os == 'windows-2019' && matrix.python-version == 'py36' }} 
+        shell: pwsh
+        run: Remove-Item .\.tox\ -Force -Recurse -ErrorAction Ignore
       - name: run tox
         run: tox -f ${{ matrix.python-version }}-${{ matrix.package }} -- --benchmark-json=${{ env.RUN_MATRIX_COMBINATION }}-benchmark.json
       - name: Find and merge benchmarks
@@ -81,7 +89,7 @@ jobs:
       matrix:
         tox-environment: [ "docker-tests", "lint", "docs", "mypy", "mypyinstalled", "tracecontext" ]
     name: ${{ matrix.tox-environment }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout Core Repo @ SHA - ${{ github.sha }}
         uses: actions/checkout@v2
@@ -95,14 +103,17 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.9
+          architecture: 'x64'
       - name: Install tox
         run: pip install -U tox
       - name: Cache tox environment
         # Preserves .tox directory between runs for faster installs
         uses: actions/cache@v2
         with:
-          path: .tox
-          key: tox-cache-${{ matrix.tox-environment }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}-core
+          path: |
+            .tox
+            ~/.cache/pip
+          key: v2-tox-cache-${{ matrix.tox-environment }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}-core
       - name: run tox
         run: tox -e ${{ matrix.tox-environment }}
   contrib-build:
@@ -119,7 +130,7 @@ jobs:
       matrix:
         python-version: [ py36, py37, py38, py39, pypy3 ]
         package: ["instrumentation", "exporter"]
-        os: [ ubuntu-latest ]
+        os: [ ubuntu-20.04]
     steps:
       - name: Checkout Contrib Repo @ SHA - ${{ env.CONTRIB_REPO_SHA }}
         uses: actions/checkout@v2
@@ -135,14 +146,17 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: ${{ env[matrix.python-version] }}
+          architecture: 'x64'
       - name: Install tox
         run: pip install -U tox-factor
       - name: Cache tox environment
         # Preserves .tox directory between runs for faster installs
         uses: actions/cache@v2
         with:
-          path: .tox
-          key: tox-cache-${{ matrix.python-version }}-${{ matrix.package }}-${{ matrix.os }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}-contrib
+          path: |
+            .tox
+            ~/.cache/pip
+          key: v2-tox-cache-${{ matrix.python-version }}-${{ matrix.package }}-${{ matrix.os }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}-contrib
       - name: run tox
         run: tox -f ${{ matrix.python-version }}-${{ matrix.package }}
   contrib-misc:
@@ -151,7 +165,7 @@ jobs:
       matrix:
         tox-environment: [ "docker-tests"]
     name: ${{ matrix.tox-environment }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout Contrib Repo @ SHA - ${{ env.CONTRIB_REPO_SHA }}
         uses: actions/checkout@v2
@@ -167,13 +181,16 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.9
+          architecture: 'x64'
       - name: Install tox
         run: pip install -U tox
       - name: Cache tox environment
         # Preserves .tox directory between runs for faster installs
         uses: actions/cache@v2
         with:
-          path: .tox
-          key: tox-cache-${{ matrix.tox-environment }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}-contrib
+          path: |
+            .tox
+            ~/.cache/pip
+          key: v2-tox-cache-${{ matrix.tox-environment }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}-contrib
       - name: run tox
         run: tox -e ${{ matrix.tox-environment }}

.gitignore

@@ -12,6 +12,7 @@ build
 eggs
 parts
 bin
+include
 var
 sdist
 develop-eggs

CHANGELOG.md

@@ -8,6 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Automatically load OTEL environment variables as options for `opentelemetry-instrument`
   ([#1969](https://github.com/open-telemetry/opentelemetry-python/pull/1969))
 
+- `opentelemetry-semantic-conventions` Update to semantic conventions v1.6.1
+  ([#2077](https://github.com/open-telemetry/opentelemetry-python/pull/2077))
+- Fix propagation bug caused by counting skipped entries
+  ([#2071](https://github.com/open-telemetry/opentelemetry-python/pull/2071))
+
 ## [1.5.0-0.24b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.5.0-0.24b0) - 2021-08-26
 
 - Fix documentation on well known exporters and variable OTEL_TRACES_EXPORTER which were misnamed

dev-requirements.txt

@@ -1,7 +1,7 @@
 pylint==2.7.1
 flake8~=3.7
 isort~=5.8
-black~=20.8b1
+black~=21.7b0
 httpretty~=1.0
 mypy==0.812
 sphinx~=3.5.4

docs/getting-started.rst

@@ -1,5 +1,5 @@
-Getting Started with OpenTelemetry Python
-=========================================
+Getting Started 
+===============
 
 This guide walks you through instrumenting a Python application with ``opentelemetry-python``.
 

docs/getting_started/flask_example.py

@@ -44,4 +44,4 @@ def hello():
     return "hello"
 
 
-app.run(debug=True, port=5000)
+app.run(port=5000)

docs/index.rst

@@ -11,8 +11,9 @@ The Python `OpenTelemetry <https://opentelemetry.io/>`_ client.
 This documentation describes the :doc:`opentelemetry-api <api/api>`,
 :doc:`opentelemetry-sdk <sdk/sdk>`, and several `integration packages <#integrations>`_.
 
-**Please note** that this library is currently in _beta_, and shouldn't
-generally be used in production environments.
+The library is currently stable for tracing. Support for `metrics <https://github.com/open-telemetry/opentelemetry-python/tree/metrics>`_
+and `logging <https://github.com/open-telemetry/opentelemetry-python/tree/logs>`_ is currently under development and is considered
+experimental.
 
 Requirement
 -----------

exporter/opentelemetry-exporter-jaeger/tests/test_jaeger.py

@@ -23,7 +23,7 @@
 # pylint:disable=no-member
 class TestJaegerExporter(unittest.TestCase):
     def test_constructors(self):
-        """ Test ensures both exporters can co-exist"""
+        """Test ensures both exporters can co-exist"""
         try:
             grpc.JaegerExporter()
             thrift.JaegerExporter()

opentelemetry-api/src/opentelemetry/baggage/propagation/__init__.py

@@ -13,9 +13,9 @@
 # limitations under the License.
 #
 import typing
-import urllib.parse
+from urllib.parse import quote_plus, unquote_plus
 
-from opentelemetry import baggage
+from opentelemetry.baggage import get_all, set_baggage
 from opentelemetry.context import get_current
 from opentelemetry.context.context import Context
 from opentelemetry.propagators import textmap
@@ -54,20 +54,20 @@ def extract(
         baggage_entries = header.split(",")
         total_baggage_entries = self._MAX_PAIRS
         for entry in baggage_entries:
-            if total_baggage_entries <= 0:
-                return context
-            total_baggage_entries -= 1
             if len(entry) > self._MAX_PAIR_LENGTH:
                 continue
             try:
                 name, value = entry.split("=", 1)
             except Exception:  # pylint: disable=broad-except
                 continue
-            context = baggage.set_baggage(
-                urllib.parse.unquote(name).strip(),
-                urllib.parse.unquote(value).strip(),
+            context = set_baggage(
+                unquote_plus(name).strip(),
+                unquote_plus(value).strip(),
                 context=context,
             )
+            total_baggage_entries -= 1
+            if total_baggage_entries == 0:
+                break
 
         return context
 
@@ -82,7 +82,7 @@ def inject(
         See
         `opentelemetry.propagators.textmap.TextMapPropagator.inject`
         """
-        baggage_entries = baggage.get_all(context=context)
+        baggage_entries = get_all(context=context)
         if not baggage_entries:
             return
 
@@ -97,7 +97,7 @@ def fields(self) -> typing.Set[str]:
 
 def _format_baggage(baggage_entries: typing.Mapping[str, object]) -> str:
     return ",".join(
-        key + "=" + urllib.parse.quote_plus(str(value))
+        quote_plus(str(key)) + "=" + quote_plus(str(value))
         for key, value in baggage_entries.items()
     )
 

opentelemetry-api/src/opentelemetry/context/context.py

@@ -39,7 +39,7 @@ def attach(self, context: Context) -> object:
 
     @abstractmethod
     def get_current(self) -> Context:
-        """Returns the current `Context` object. """
+        """Returns the current `Context` object."""
 
     @abstractmethod
     def detach(self, token: object) -> None:

opentelemetry-api/src/opentelemetry/context/contextvars_context.py

@@ -44,7 +44,7 @@ def attach(self, context: Context) -> object:
         return self._current_context.set(context)
 
     def get_current(self) -> Context:
-        """Returns the current `Context` object. """
+        """Returns the current `Context` object."""
         return self._current_context.get()
 
     def detach(self, token: object) -> None:

opentelemetry-api/tests/baggage/test_baggage_propagation.py

@@ -18,7 +18,10 @@
 from unittest.mock import Mock, patch
 
 from opentelemetry import baggage
-from opentelemetry.baggage.propagation import W3CBaggagePropagator
+from opentelemetry.baggage.propagation import (
+    W3CBaggagePropagator,
+    _format_baggage,
+)
 from opentelemetry.context import get_current
 
 
@@ -106,6 +109,55 @@ def test_header_contains_pair_too_long(self):
         expected = {"key1": "value1", "key3": "value3"}
         self.assertEqual(self._extract(header), expected)
 
+    def test_extract_unquote_plus(self):
+        self.assertEqual(
+            self._extract("key+key=value+value"), {"key key": "value value"}
+        )
+        self.assertEqual(
+            self._extract("key%2Fkey=value%2Fvalue"),
+            {"key/key": "value/value"},
+        )
+
+    def test_header_max_entries_skip_invalid_entry(self):
+
+        self.assertEqual(
+            self._extract(
+                ",".join(
+                    [
+                        f"key{index}=value{index}"
+                        if index != 2
+                        else (
+                            f"key{index}="
+                            f"value{'s' * (W3CBaggagePropagator._MAX_PAIR_LENGTH + 1)}"
+                        )
+                        for index in range(W3CBaggagePropagator._MAX_PAIRS + 1)
+                    ]
+                )
+            ),
+            {
+                f"key{index}": f"value{index}"
+                for index in range(W3CBaggagePropagator._MAX_PAIRS + 1)
+                if index != 2
+            },
+        )
+        self.assertEqual(
+            self._extract(
+                ",".join(
+                    [
+                        f"key{index}=value{index}"
+                        if index != 2
+                        else f"key{index}xvalue{index}"
+                        for index in range(W3CBaggagePropagator._MAX_PAIRS + 1)
+                    ]
+                )
+            ),
+            {
+                f"key{index}": f"value{index}"
+                for index in range(W3CBaggagePropagator._MAX_PAIRS + 1)
+                if index != 2
+            },
+        )
+
     def test_inject_no_baggage_entries(self):
         values = {}
         output = self._inject(values)
@@ -140,7 +192,7 @@ def test_inject_non_string_values(self):
         self.assertIn("key2=123", output)
         self.assertIn("key3=123.567", output)
 
-    @patch("opentelemetry.baggage.propagation.baggage")
+    @patch("opentelemetry.baggage.propagation.get_all")
     @patch("opentelemetry.baggage.propagation._format_baggage")
     def test_fields(self, mock_format_baggage, mock_baggage):
 
@@ -154,3 +206,12 @@ def test_fields(self, mock_format_baggage, mock_baggage):
             inject_fields.add(mock_call[1][1])
 
         self.assertEqual(inject_fields, self.propagator.fields)
+
+    def test__format_baggage(self):
+        self.assertEqual(
+            _format_baggage({"key key": "value value"}), "key+key=value+value"
+        )
+        self.assertEqual(
+            _format_baggage({"key/key": "value/value"}),
+            "key%2Fkey=value%2Fvalue",
+        )

opentelemetry-semantic-conventions/README.rst

@@ -18,14 +18,15 @@ Installation
 Code Generation
 ---------------
 
-These files were generated automatically from code in opentelemetry-semantic-conventions_.
+These files were generated automatically from code in semconv_.
 To regenerate the code, run ``../scripts/semconv/generate.sh``.
 
-To build against a new release or specific commit of opentelemetry-semantic-conventions_,
+To build against a new release or specific commit of opentelemetry-specification_,
 update the ``SPEC_VERSION`` variable in
 ``../scripts/semconv/generate.sh``. Then run the script and commit the changes.
 
-.. _opentelemetry-semantic-conventions: https://github.com/open-telemetry/opentelemetry-semantic-conventions
+.. _opentelemetry-specification: https://github.com/open-telemetry/opentelemetry-specification
+.. _semconv: https://github.com/open-telemetry/opentelemetry-python/tree/main/scripts/semconv
 
 
 References