From 5829d2c9bcdd871d18af0711d039a83bfd6e6f0e Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 2 Mar 2021 13:11:56 -0800 Subject: [PATCH 1/3] rename BaggagePropagator to W3CBaggagePropagator --- CHANGELOG.md | 3 ++- opentelemetry-api/setup.cfg | 2 +- .../opentelemetry/baggage/propagation/__init__.py | 5 ++--- .../src/opentelemetry/propagate/__init__.py | 9 ++++++--- .../tests/baggage/test_baggage_propagation.py | 12 ++++++------ .../tests/propagators/test_propagators.py | 5 +++-- 6 files changed, 20 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c7fcb83e20a..bf633ba0f13 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,7 +22,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#1656])(https://github.com/open-telemetry/opentelemetry-python/pull/1656) - Rename `DefaultSpan` to `NonRecordingSpan` ([#1661])(https://github.com/open-telemetry/opentelemetry-python/pull/1661) - +- Rename `BaggagePropagator` to `W3CBaggagePropagator` + ([#1666])(https://github.com/open-telemetry/opentelemetry-python/pull/1666) ## [0.18b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.18b0) - 2021-02-16 ### Added diff --git a/opentelemetry-api/setup.cfg b/opentelemetry-api/setup.cfg index d3cbe4ddf23..332069041ce 100644 --- a/opentelemetry-api/setup.cfg +++ b/opentelemetry-api/setup.cfg @@ -54,7 +54,7 @@ opentelemetry_tracer_provider = default_tracer_provider = opentelemetry.trace:DefaultTracerProvider opentelemetry_propagator = tracecontext = opentelemetry.trace.propagation.tracecontext:TraceContextTextMapPropagator - baggage = opentelemetry.baggage.propagation:BaggagePropagator + baggage = opentelemetry.baggage.propagation:W3CBaggagePropagator [options.extras_require] test = diff --git a/opentelemetry-api/src/opentelemetry/baggage/propagation/__init__.py b/opentelemetry-api/src/opentelemetry/baggage/propagation/__init__.py index ae5e0c34e1b..e03530f22bf 100644 --- a/opentelemetry-api/src/opentelemetry/baggage/propagation/__init__.py +++ b/opentelemetry-api/src/opentelemetry/baggage/propagation/__init__.py @@ -21,9 +21,8 @@ from opentelemetry.trace.propagation import textmap -class BaggagePropagator(textmap.TextMapPropagator): - """Extracts and injects Baggage which is used to annotate telemetry. - """ +class W3CBaggagePropagator(textmap.TextMapPropagator): + """Extracts and injects Baggage which is used to annotate telemetry.""" MAX_HEADER_LENGTH = 8192 MAX_PAIR_LENGTH = 4096 diff --git a/opentelemetry-api/src/opentelemetry/propagate/__init__.py b/opentelemetry-api/src/opentelemetry/propagate/__init__.py index 6050b5f4ff8..3a01ac87059 100644 --- a/opentelemetry-api/src/opentelemetry/propagate/__init__.py +++ b/opentelemetry-api/src/opentelemetry/propagate/__init__.py @@ -25,7 +25,7 @@ ``opentelemetry.propagators.composite.CompositeHTTPPropagator`` with 2 propagators, one of type ``opentelemetry.trace.propagation.tracecontext.TraceContextTextMapPropagator`` -and other of type ``opentelemetry.baggage.propagation.BaggagePropagator``. +and other of type ``opentelemetry.baggage.propagation.W3CBaggagePropagator``. Notice that these propagator classes are defined as ``opentelemetry_propagator`` entry points in the ``setup.cfg`` file of ``opentelemetry``. @@ -128,7 +128,8 @@ def inject( # Single use variable here to hack black and make lint pass environ_propagators = environ.get( - OTEL_PROPAGATORS, "tracecontext,baggage", + OTEL_PROPAGATORS, + "tracecontext,baggage", ) for propagator in environ_propagators.split(","): @@ -149,6 +150,8 @@ def get_global_textmap() -> textmap.TextMapPropagator: return _HTTP_TEXT_FORMAT -def set_global_textmap(http_text_format: textmap.TextMapPropagator,) -> None: +def set_global_textmap( + http_text_format: textmap.TextMapPropagator, +) -> None: global _HTTP_TEXT_FORMAT # pylint:disable=global-statement _HTTP_TEXT_FORMAT = http_text_format # type: ignore diff --git a/opentelemetry-api/tests/baggage/test_baggage_propagation.py b/opentelemetry-api/tests/baggage/test_baggage_propagation.py index 68723c6a0b3..3ca8233a52e 100644 --- a/opentelemetry-api/tests/baggage/test_baggage_propagation.py +++ b/opentelemetry-api/tests/baggage/test_baggage_propagation.py @@ -16,7 +16,7 @@ from unittest.mock import Mock, patch from opentelemetry import baggage -from opentelemetry.baggage.propagation import BaggagePropagator +from opentelemetry.baggage.propagation import W3CBaggagePropagator from opentelemetry.context import get_current from opentelemetry.trace.propagation.textmap import DictGetter @@ -25,7 +25,7 @@ class TestBaggagePropagation(unittest.TestCase): def setUp(self): - self.propagator = BaggagePropagator() + self.propagator = W3CBaggagePropagator() def _extract(self, header_value): """Test helper""" @@ -87,7 +87,7 @@ def test_invalid_header(self): self.assertEqual(self._extract(header), expected) def test_header_too_long(self): - long_value = "s" * (BaggagePropagator.MAX_HEADER_LENGTH + 1) + long_value = "s" * (W3CBaggagePropagator.MAX_HEADER_LENGTH + 1) header = "key1={}".format(long_value) expected = {} self.assertEqual(self._extract(header), expected) @@ -96,15 +96,15 @@ def test_header_contains_too_many_entries(self): header = ",".join( [ "key{}=val".format(k) - for k in range(BaggagePropagator.MAX_PAIRS + 1) + for k in range(W3CBaggagePropagator.MAX_PAIRS + 1) ] ) self.assertEqual( - len(self._extract(header)), BaggagePropagator.MAX_PAIRS + len(self._extract(header)), W3CBaggagePropagator.MAX_PAIRS ) def test_header_contains_pair_too_long(self): - long_value = "s" * (BaggagePropagator.MAX_PAIR_LENGTH + 1) + long_value = "s" * (W3CBaggagePropagator.MAX_PAIR_LENGTH + 1) header = "key1=value1,key2={},key3=value3".format(long_value) expected = {"key1": "value1", "key3": "value3"} self.assertEqual(self._extract(header), expected) diff --git a/opentelemetry-api/tests/propagators/test_propagators.py b/opentelemetry-api/tests/propagators/test_propagators.py index 5e2abaed1a4..1ea80146ef8 100644 --- a/opentelemetry-api/tests/propagators/test_propagators.py +++ b/opentelemetry-api/tests/propagators/test_propagators.py @@ -17,7 +17,7 @@ from unittest import TestCase from unittest.mock import Mock, patch -from opentelemetry.baggage.propagation import BaggagePropagator +from opentelemetry.baggage.propagation import W3CBaggagePropagator from opentelemetry.environment_variables import OTEL_PROPAGATORS from opentelemetry.trace.propagation.tracecontext import ( TraceContextTextMapPropagator, @@ -33,7 +33,8 @@ def test_propagators(propagators): self.assertEqual(len(propagators), 2) self.assertEqual( - propagators, {TraceContextTextMapPropagator, BaggagePropagator} + propagators, + {TraceContextTextMapPropagator, W3CBaggagePropagator}, ) mock_compositehttppropagator.configure_mock( From 9d86f352a38669eed302d301106bfd28f9dd246a Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 2 Mar 2021 13:16:00 -0800 Subject: [PATCH 2/3] lint --- opentelemetry-api/src/opentelemetry/propagate/__init__.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/opentelemetry-api/src/opentelemetry/propagate/__init__.py b/opentelemetry-api/src/opentelemetry/propagate/__init__.py index 3a01ac87059..0a5988b874e 100644 --- a/opentelemetry-api/src/opentelemetry/propagate/__init__.py +++ b/opentelemetry-api/src/opentelemetry/propagate/__init__.py @@ -128,8 +128,7 @@ def inject( # Single use variable here to hack black and make lint pass environ_propagators = environ.get( - OTEL_PROPAGATORS, - "tracecontext,baggage", + OTEL_PROPAGATORS, "tracecontext,baggage", ) for propagator in environ_propagators.split(","): @@ -150,8 +149,6 @@ def get_global_textmap() -> textmap.TextMapPropagator: return _HTTP_TEXT_FORMAT -def set_global_textmap( - http_text_format: textmap.TextMapPropagator, -) -> None: +def set_global_textmap(http_text_format: textmap.TextMapPropagator,) -> None: global _HTTP_TEXT_FORMAT # pylint:disable=global-statement _HTTP_TEXT_FORMAT = http_text_format # type: ignore From eebfcaa70c53b9870767f0a82e7592e713c85ac5 Mon Sep 17 00:00:00 2001 From: alrex Date: Tue, 2 Mar 2021 16:38:06 -0800 Subject: [PATCH 3/3] Update CHANGELOG.md Co-authored-by: Leighton Chen --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bf633ba0f13..a93756ebe68 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,7 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Rename `DefaultSpan` to `NonRecordingSpan` ([#1661])(https://github.com/open-telemetry/opentelemetry-python/pull/1661) - Rename `BaggagePropagator` to `W3CBaggagePropagator` - ([#1666])(https://github.com/open-telemetry/opentelemetry-python/pull/1666) + ([#1663])(https://github.com/open-telemetry/opentelemetry-python/pull/1663) ## [0.18b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.18b0) - 2021-02-16 ### Added