reorder propagators

Author: srprash

aws-opentelemetry-distro/src/amazon/opentelemetry/distro/aws_opentelemetry_distro.py

@@ -73,7 +73,8 @@ def _configure(self, **kwargs):
         os.environ.setdefault(OTEL_EXPORTER_OTLP_PROTOCOL, "http/protobuf")
 
         if os.environ.get(OTEL_PROPAGATORS, None) is None:
-            os.environ.setdefault(OTEL_PROPAGATORS, "tracecontext,baggage,xray")
+            # xray is set after baggage in case xray propagator depends on the result of the baggage header extraction.
+            os.environ.setdefault(OTEL_PROPAGATORS, "baggage,xray,tracecontext")
             # We need to explicitly reload the opentelemetry.propagate module here
             # because this module initializes the default propagators when it loads very early in the chain.
             # Without reloading the OTEL_PROPAGATOR config from this distro won't take any effect.

aws-opentelemetry-distro/tests/amazon/opentelemetry/distro/test_aws_opentelementry_configurator.py

@@ -1262,7 +1262,7 @@ def validate_distro_environ():
     tc.assertEqual(
         "base2_exponential_bucket_histogram", os.environ.get("OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION")
     )
-    tc.assertEqual("tracecontext,baggage,xray", os.environ.get("OTEL_PROPAGATORS"))
+    tc.assertEqual("baggage,xray,tracecontext", os.environ.get("OTEL_PROPAGATORS"))
     tc.assertEqual("xray", os.environ.get("OTEL_PYTHON_ID_GENERATOR"))
 
     # Not set

aws-opentelemetry-distro/tests/amazon/opentelemetry/distro/test_aws_opentelemetry_distro.py

@@ -75,7 +75,7 @@ def test_configure_sets_default_values(self, mock_super_configure, mock_apply_pa
 
         # Check that default values are set
         self.assertEqual(os.environ.get("OTEL_EXPORTER_OTLP_PROTOCOL"), "http/protobuf")
-        self.assertEqual(os.environ.get("OTEL_PROPAGATORS"), "tracecontext,baggage,xray")
+        self.assertEqual(os.environ.get("OTEL_PROPAGATORS"), "baggage,xray,tracecontext")
         self.assertEqual(os.environ.get("OTEL_PYTHON_ID_GENERATOR"), "xray")
         self.assertEqual(
             os.environ.get("OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION"),
@@ -270,7 +270,7 @@ def test_otel_propagators_added_when_not_user_defined(self, mock_super_configure
 
         self.assertTrue(isinstance(propagators, CompositePropagator))
 
-        expected_propagators = ["TraceContextTextMapPropagator", "W3CBaggagePropagator", "AwsXRayPropagator"]
+        expected_propagators = ["W3CBaggagePropagator", "AwsXRayPropagator", "TraceContextTextMapPropagator"]
         individual_propagators = propagators._propagators
         self.assertEqual(3, len(individual_propagators))
         actual_propagators = []