Rename TextFormatContext -> PropagationContext.

examples/MicroserviceExample/Utils/Messaging/MessageSender.cs

@@ -61,7 +61,7 @@ public string SendMessage()
                     if (activity != null)
                     {
                         // Inject the ActivityContext into the message headers to propagate trace context to the receiving service.
-                        TextFormat.Inject(new TextFormatContext(activity.Context, activity.Baggage), props, this.InjectTraceContextIntoBasicProperties);
+                        TextFormat.Inject(new PropagationContext(activity.Context, activity.Baggage), props, this.InjectTraceContextIntoBasicProperties);
 
                         // The OpenTelemetry messaging specification defines a number of attributes. These attributes are added here.
                         RabbitMqHelper.AddMessagingTags(activity);

src/OpenTelemetry.Api/CHANGELOG.md

@@ -2,8 +2,8 @@
 
 ## Unreleased
 
-* `TextFormatContext` is now used instead of `ActivityContext` in the
-    `ITextFormat`
+* `PropagationContext` is now used instead of `ActivityContext` in the
+    `ITextFormat` API
     ([#1048](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1048))
 * Added `BaggageFormat` an `ITextFormat` implementation for managing Baggage
     propagation via the [W3C

src/OpenTelemetry.Api/Context/Propagation/BaggageFormat.cs

@@ -37,7 +37,7 @@ public class BaggageFormat : ITextFormat
         public ISet<string> Fields => new HashSet<string> { BaggageHeaderName };
 
         /// <inheritdoc/>
-        public TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
+        public PropagationContext Extract<T>(PropagationContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
         {
             if (carrier == null)
             {
@@ -60,7 +60,7 @@ public TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T
                     TryExtractBaggage(baggageCollection.ToArray(), out baggage);
                 }
 
-                return new TextFormatContext(
+                return new PropagationContext(
                     context.ActivityContext,
                     baggage ?? context.ActivityBaggage);
             }
@@ -73,7 +73,7 @@ public TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T
         }
 
         /// <inheritdoc/>
-        public void Inject<T>(TextFormatContext context, T carrier, Action<T, string, string> setter)
+        public void Inject<T>(PropagationContext context, T carrier, Action<T, string, string> setter)
         {
             if (carrier == null)
             {

src/OpenTelemetry.Api/Context/Propagation/CompositePropagator.cs

@@ -40,7 +40,7 @@ public CompositePropagator(IEnumerable<ITextFormat> textFormats)
         public ISet<string> Fields => EmptyFields;
 
         /// <inheritdoc/>
-        public TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
+        public PropagationContext Extract<T>(PropagationContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
         {
             foreach (var textFormat in this.textFormats)
             {
@@ -51,7 +51,7 @@ public TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T
         }
 
         /// <inheritdoc/>
-        public void Inject<T>(TextFormatContext context, T carrier, Action<T, string, string> setter)
+        public void Inject<T>(PropagationContext context, T carrier, Action<T, string, string> setter)
         {
             foreach (var textFormat in this.textFormats)
             {

src/OpenTelemetry.Api/Context/Propagation/ITextFormat.cs

@@ -39,7 +39,7 @@ public interface ITextFormat
         /// <param name="context">The default context to transmit over the wire.</param>
         /// <param name="carrier">Object to set context on. Instance of this object will be passed to setter.</param>
         /// <param name="setter">Action that will set name and value pair on the object.</param>
-        void Inject<T>(TextFormatContext context, T carrier, Action<T, string, string> setter);
+        void Inject<T>(PropagationContext context, T carrier, Action<T, string, string> setter);
 
         /// <summary>
         /// Extracts activity context from textual representation.
@@ -49,6 +49,6 @@ public interface ITextFormat
         /// <param name="carrier">Object to extract context from. Instance of this object will be passed to the getter.</param>
         /// <param name="getter">Function that will return string value of a key with the specified name.</param>
         /// <returns>Context from it's text representation.</returns>
-        TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T, string, IEnumerable<string>> getter);
+        PropagationContext Extract<T>(PropagationContext context, T carrier, Func<T, string, IEnumerable<string>> getter);
     }
 }

src/OpenTelemetry.Api/Context/Propagation/TextFormatContext.cs → src/OpenTelemetry.Api/Context/Propagation/PropagationContext.cs

@@ -1,4 +1,4 @@
-// <copyright file="TextFormatContext.cs" company="OpenTelemetry Authors">
+// <copyright file="PropagationContext.cs" company="OpenTelemetry Authors">
 // Copyright The OpenTelemetry Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,16 +22,16 @@
 namespace OpenTelemetry.Context.Propagation
 {
     /// <summary>
-    /// TextFormat context.
+    /// Stores propagation data.
     /// </summary>
-    public readonly struct TextFormatContext : IEquatable<TextFormatContext>
+    public readonly struct PropagationContext : IEquatable<PropagationContext>
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="TextFormatContext"/> struct.
+        /// Initializes a new instance of the <see cref="PropagationContext"/> struct.
         /// </summary>
         /// <param name="activityContext">Entries for activity context.</param>
         /// <param name="activityBaggage">Entries for activity baggage.</param>
-        public TextFormatContext(ActivityContext activityContext, IEnumerable<KeyValuePair<string, string>> activityBaggage)
+        public PropagationContext(ActivityContext activityContext, IEnumerable<KeyValuePair<string, string>> activityBaggage)
         {
             this.ActivityContext = activityContext;
             this.ActivityBaggage = activityBaggage;
@@ -48,21 +48,21 @@ public TextFormatContext(ActivityContext activityContext, IEnumerable<KeyValuePa
         public IEnumerable<KeyValuePair<string, string>> ActivityBaggage { get; }
 
         /// <summary>
-        /// Compare two entries of <see cref="TextFormatContext"/> for equality.
+        /// Compare two entries of <see cref="PropagationContext"/> for equality.
         /// </summary>
         /// <param name="left">First Entry to compare.</param>
         /// <param name="right">Second Entry to compare.</param>
-        public static bool operator ==(TextFormatContext left, TextFormatContext right) => left.Equals(right);
+        public static bool operator ==(PropagationContext left, PropagationContext right) => left.Equals(right);
 
         /// <summary>
-        /// Compare two entries of <see cref="TextFormatContext"/> for not equality.
+        /// Compare two entries of <see cref="PropagationContext"/> for not equality.
         /// </summary>
         /// <param name="left">First Entry to compare.</param>
         /// <param name="right">Second Entry to compare.</param>
-        public static bool operator !=(TextFormatContext left, TextFormatContext right) => !(left == right);
+        public static bool operator !=(PropagationContext left, PropagationContext right) => !(left == right);
 
         /// <inheritdoc/>
-        public bool Equals(TextFormatContext value)
+        public bool Equals(PropagationContext value)
         {
             if (this.ActivityContext != value.ActivityContext
                 || this.ActivityBaggage is null != value.ActivityBaggage is null)
@@ -96,7 +96,7 @@ public bool Equals(TextFormatContext value)
         }
 
         /// <inheritdoc/>
-        public override bool Equals(object obj) => (obj is TextFormatContext context) && this.Equals(context);
+        public override bool Equals(object obj) => (obj is PropagationContext context) && this.Equals(context);
 
         /// <inheritdoc/>
         public override int GetHashCode()

src/OpenTelemetry.Api/Context/Propagation/TraceContextFormat.cs

@@ -43,7 +43,7 @@ public class TraceContextFormat : ITextFormat
         public ISet<string> Fields => new HashSet<string> { TraceState, TraceParent };
 
         /// <inheritdoc/>
-        public TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
+        public PropagationContext Extract<T>(PropagationContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
         {
             if (carrier == null)
             {
@@ -82,7 +82,7 @@ public TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T
                     TryExtractTracestate(tracestateCollection.ToArray(), out tracestate);
                 }
 
-                return new TextFormatContext(
+                return new PropagationContext(
                     new ActivityContext(traceId, spanId, traceoptions, tracestate, isRemote: true),
                     context.ActivityBaggage);
             }
@@ -96,7 +96,7 @@ public TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T
         }
 
         /// <inheritdoc/>
-        public void Inject<T>(TextFormatContext context, T carrier, Action<T, string, string> setter)
+        public void Inject<T>(PropagationContext context, T carrier, Action<T, string, string> setter)
         {
             if (context.ActivityContext.TraceId == default || context.ActivityContext.SpanId == default)
             {

src/OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerDiagnosticListener.cs

@@ -107,7 +107,7 @@ public override void OnStartActivity(Activity activity, object payload)
 
             if (!(this.httpClientSupportsW3C && this.options.TextFormat is TraceContextFormat))
             {
-                this.options.TextFormat.Inject(new TextFormatContext(activity.Context, activity.Baggage), request, HttpRequestMessageHeaderValueSetter);
+                this.options.TextFormat.Inject(new PropagationContext(activity.Context, activity.Baggage), request, HttpRequestMessageHeaderValueSetter);
             }
         }
 

src/OpenTelemetry.Instrumentation.Http/Implementation/HttpWebRequestActivitySource.netfx.cs

@@ -187,7 +187,7 @@ private static void AddExceptionTags(Exception exception, Activity activity)
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         private static void InstrumentRequest(HttpWebRequest request, Activity activity)
-            => Options.TextFormat.Inject(new TextFormatContext(activity.Context, activity.Baggage), request, HttpWebRequestHeaderValuesSetter);
+            => Options.TextFormat.Inject(new PropagationContext(activity.Context, activity.Baggage), request, HttpWebRequestHeaderValuesSetter);
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         private static bool IsRequestInstrumented(HttpWebRequest request)

src/OpenTelemetry.Shims.OpenTracing/TracerShim.cs

@@ -60,7 +60,7 @@ public TracerShim(Trace.Tracer tracer, ITextFormat textFormat)
                 throw new ArgumentNullException(nameof(carrier));
             }
 
-            TextFormatContext textFormatContext = default;
+            PropagationContext propagationContext = default;
 
             if ((format == BuiltinFormats.TextMap || format == BuiltinFormats.HttpHeaders) && carrier is ITextMap textMapCarrier)
             {
@@ -81,10 +81,10 @@ static IEnumerable<string> GetCarrierKeyValue(Dictionary<string, IEnumerable<str
                     return value;
                 }
 
-                textFormatContext = this.textFormat.Extract(textFormatContext, carrierMap, GetCarrierKeyValue);
+                propagationContext = this.textFormat.Extract(propagationContext, carrierMap, GetCarrierKeyValue);
             }
 
-            return !textFormatContext.ActivityContext.IsValid() ? null : new SpanContextShim(new Trace.SpanContext(textFormatContext.ActivityContext), textFormatContext.ActivityBaggage);
+            return !propagationContext.ActivityContext.IsValid() ? null : new SpanContextShim(new Trace.SpanContext(propagationContext.ActivityContext), propagationContext.ActivityBaggage);
         }
 
         /// <inheritdoc/>
@@ -116,7 +116,7 @@ public void Inject<TCarrier>(
             if ((format == BuiltinFormats.TextMap || format == BuiltinFormats.HttpHeaders) && carrier is ITextMap textMapCarrier)
             {
                 this.textFormat.Inject(
-                    new TextFormatContext(shim.SpanContext, shim.GetBaggageItems()),
+                    new PropagationContext(shim.SpanContext, shim.GetBaggageItems()),
                     textMapCarrier,
                     (instrumentation, key, value) => instrumentation.Set(key, value));
             }

src/OpenTelemetry/Context/Propagation/B3Format.cs

@@ -70,7 +70,7 @@ public B3Format(bool singleHeader)
         public ISet<string> Fields => AllFields;
 
         /// <inheritdoc/>
-        public TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
+        public PropagationContext Extract<T>(PropagationContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
         {
             if (carrier == null)
             {
@@ -95,7 +95,7 @@ public TextFormatContext Extract<T>(TextFormatContext context, T carrier, Func<T
         }
 
         /// <inheritdoc/>
-        public void Inject<T>(TextFormatContext context, T carrier, Action<T, string, string> setter)
+        public void Inject<T>(PropagationContext context, T carrier, Action<T, string, string> setter)
         {
             if (context.ActivityContext.TraceId == default || context.ActivityContext.SpanId == default)
             {
@@ -140,7 +140,7 @@ public void Inject<T>(TextFormatContext context, T carrier, Action<T, string, st
             }
         }
 
-        private static TextFormatContext ExtractFromMultipleHeaders<T>(TextFormatContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
+        private static PropagationContext ExtractFromMultipleHeaders<T>(PropagationContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
         {
             try
             {
@@ -179,7 +179,7 @@ private static TextFormatContext ExtractFromMultipleHeaders<T>(TextFormatContext
                     traceOptions |= ActivityTraceFlags.Recorded;
                 }
 
-                return new TextFormatContext(
+                return new PropagationContext(
                     new ActivityContext(traceId, spanId, traceOptions, isRemote: true),
                     context.ActivityBaggage);
             }
@@ -190,7 +190,7 @@ private static TextFormatContext ExtractFromMultipleHeaders<T>(TextFormatContext
             }
         }
 
-        private static TextFormatContext ExtractFromSingleHeader<T>(TextFormatContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
+        private static PropagationContext ExtractFromSingleHeader<T>(PropagationContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
         {
             try
             {
@@ -239,7 +239,7 @@ private static TextFormatContext ExtractFromSingleHeader<T>(TextFormatContext co
                     }
                 }
 
-                return new TextFormatContext(
+                return new PropagationContext(
                     new ActivityContext(traceId, spanId, traceOptions, isRemote: true),
                     context.ActivityBaggage);
             }

test/OpenTelemetry.Instrumentation.AspNet.Tests/HttpInListenerTests.cs

@@ -127,7 +127,7 @@ public void AspNetRequestsAreCollectedSuccessfully(
             var expectedTraceId = ActivityTraceId.CreateRandom();
             var expectedSpanId = ActivitySpanId.CreateRandom();
             var textFormat = new Mock<ITextFormat>();
-            textFormat.Setup(m => m.Extract<HttpRequest>(It.IsAny<TextFormatContext>(), It.IsAny<HttpRequest>(), It.IsAny<Func<HttpRequest, string, IEnumerable<string>>>())).Returns(new TextFormatContext(
+            textFormat.Setup(m => m.Extract<HttpRequest>(It.IsAny<PropagationContext>(), It.IsAny<HttpRequest>(), It.IsAny<Func<HttpRequest, string, IEnumerable<string>>>())).Returns(new PropagationContext(
                 new ActivityContext(
                     expectedTraceId,
                     expectedSpanId,

test/OpenTelemetry.Instrumentation.AspNetCore.Tests/BasicTests.cs

@@ -144,7 +144,7 @@ public async Task CustomTextFormat()
             var expectedSpanId = ActivitySpanId.CreateRandom();
 
             var textFormat = new Mock<ITextFormat>();
-            textFormat.Setup(m => m.Extract(It.IsAny<TextFormatContext>(), It.IsAny<HttpRequest>(), It.IsAny<Func<HttpRequest, string, IEnumerable<string>>>())).Returns(new TextFormatContext(
+            textFormat.Setup(m => m.Extract(It.IsAny<PropagationContext>(), It.IsAny<HttpRequest>(), It.IsAny<Func<HttpRequest, string, IEnumerable<string>>>())).Returns(new PropagationContext(
                 new ActivityContext(
                 expectedTraceId,
                 expectedSpanId,

test/OpenTelemetry.Instrumentation.Http.Tests/HttpClientTests.Basic.netcore31.cs

@@ -121,8 +121,8 @@ public async Task HttpClientInstrumentationInjectsHeadersAsync()
         public async Task HttpClientInstrumentationInjectsHeadersAsync_CustomFormat()
         {
             var textFormat = new Mock<ITextFormat>();
-            textFormat.Setup(m => m.Inject<HttpRequestMessage>(It.IsAny<TextFormatContext>(), It.IsAny<HttpRequestMessage>(), It.IsAny<Action<HttpRequestMessage, string, string>>()))
-                .Callback<TextFormatContext, HttpRequestMessage, Action<HttpRequestMessage, string, string>>((context, message, action) =>
+            textFormat.Setup(m => m.Inject<HttpRequestMessage>(It.IsAny<PropagationContext>(), It.IsAny<HttpRequestMessage>(), It.IsAny<Action<HttpRequestMessage, string, string>>()))
+                .Callback<PropagationContext, HttpRequestMessage, Action<HttpRequestMessage, string, string>>((context, message, action) =>
                 {
                     action(message, "custom_traceparent", $"00/{context.ActivityContext.TraceId}/{context.ActivityContext.SpanId}/01");
                     action(message, "custom_tracestate", Activity.Current.TraceStateString);

test/OpenTelemetry.Instrumentation.Http.Tests/HttpWebRequestTests.Basic.netfx.cs

@@ -97,8 +97,8 @@ public async Task HttpWebRequestInstrumentationInjectsHeadersAsync()
         public async Task HttpWebRequestInstrumentationInjectsHeadersAsync_CustomFormat()
         {
             var textFormat = new Mock<ITextFormat>();
-            textFormat.Setup(m => m.Inject(It.IsAny<TextFormatContext>(), It.IsAny<HttpWebRequest>(), It.IsAny<Action<HttpWebRequest, string, string>>()))
-                .Callback<TextFormatContext, HttpWebRequest, Action<HttpWebRequest, string, string>>((context, message, action) =>
+            textFormat.Setup(m => m.Inject(It.IsAny<PropagationContext>(), It.IsAny<HttpWebRequest>(), It.IsAny<Action<HttpWebRequest, string, string>>()))
+                .Callback<PropagationContext, HttpWebRequest, Action<HttpWebRequest, string, string>>((context, message, action) =>
                 {
                     action(message, "custom_traceparent", $"00/{context.ActivityContext.TraceId}/{context.ActivityContext.SpanId}/01");
                     action(message, "custom_tracestate", Activity.Current.TraceStateString);