Rename Baggage Header name to baggage (#2003)

* Rename Baggage Header name to baggage * Updated CHANGELOG.md
open-telemetry · Apr 20, 2021 · eb42939 · eb42939
1 parent ca5a93d
commit eb42939
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/src/OpenTelemetry.Api/CHANGELOG.md b/src/OpenTelemetry.Api/CHANGELOG.md
@@ -9,6 +9,10 @@ please check the latest changes
 
 ## Unreleased
 
+* `BaggagePropagator` now uses `baggage` as the header name instead of `Baggage`
+  to `Extract` from and `Inject` to `carrier`
+  ([#2003](https://github.com/open-telemetry/opentelemetry-dotnet/pull/2003))
+
 ## 1.1.0-beta1
 
 Released 2021-Mar-19

diff --git a/src/OpenTelemetry.Api/Context/Propagation/BaggagePropagator.cs b/src/OpenTelemetry.Api/Context/Propagation/BaggagePropagator.cs
@@ -28,7 +28,7 @@ namespace OpenTelemetry.Context.Propagation
     /// </summary>
     public class BaggagePropagator : TextMapPropagator
     {
-        internal const string BaggageHeaderName = "Baggage";
+        internal const string BaggageHeaderName = "baggage";
 
         private const int MaxBaggageLength = 8192;
         private const int MaxBaggageItems = 180;

diff --git a/test/OpenTelemetry.Instrumentation.Http.Tests/HttpClientTests.Basic.netcore31.cs b/test/OpenTelemetry.Instrumentation.Http.Tests/HttpClientTests.Basic.netcore31.cs
@@ -392,7 +392,7 @@ public async Task HttpClientInstrumentationContextPropagation()
 
             Assert.True(request.Headers.TryGetValues("traceparent", out var traceparents));
             Assert.True(request.Headers.TryGetValues("tracestate", out var tracestates));
-            Assert.True(request.Headers.TryGetValues("Baggage", out var baggages));
+            Assert.True(request.Headers.TryGetValues("baggage", out var baggages));
             Assert.Single(traceparents);
             Assert.Single(tracestates);
             Assert.Single(baggages);

diff --git a/test/OpenTelemetry.Instrumentation.Http.Tests/HttpWebRequestActivitySourceTests.netfx.cs b/test/OpenTelemetry.Instrumentation.Http.Tests/HttpWebRequestActivitySourceTests.netfx.cs
@@ -816,7 +816,7 @@ private static void ActivityEnrichment(Activity activity, string method, object
 
         private static void ValidateBaggage(HttpWebRequest request)
         {
-            string[] baggage = request.Headers["Baggage"].Split(',');
+            string[] baggage = request.Headers["baggage"].Split(',');
 
             Assert.Equal(3, baggage.Length);
             Assert.Contains("key=value", baggage);