Rename of Propagators

examples/Console/TestOpenTracingWithConsoleExporter.cs

@@ -40,7 +40,7 @@ internal static object Run(OpenTracingShimOptions options)
 
             // Following shows how to use the OpenTracing shim
 
-            var tracer = new TracerShim(TracerProvider.Default.GetTracer("MyCompany.MyProduct.MyWebServer"), new TextMapPropagator());
+            var tracer = new TracerShim(TracerProvider.Default.GetTracer("MyCompany.MyProduct.MyWebServer"), new TraceContextPropagator());
 
             using (IScope parentScope = tracer.BuildSpan("Parent").StartActive(finishSpanOnDispose: true))
             {

examples/MicroserviceExample/Utils/Messaging/MessageReceiver.cs

@@ -30,7 +30,7 @@ namespace Utils.Messaging
     public class MessageReceiver : IDisposable
     {
         private static readonly ActivitySource ActivitySource = new ActivitySource(nameof(MessageReceiver));
-        private static readonly IPropagator Propagator = new TextMapPropagator();
+        private static readonly ITextMapPropagator Propagator = new TraceContextPropagator();
 
         private readonly ILogger<MessageReceiver> logger;
         private readonly IConnection connection;

examples/MicroserviceExample/Utils/Messaging/MessageSender.cs

@@ -28,7 +28,7 @@ namespace Utils.Messaging
     public class MessageSender : IDisposable
     {
         private static readonly ActivitySource ActivitySource = new ActivitySource(nameof(MessageSender));
-        private static readonly IPropagator Propagator = new TextMapPropagator();
+        private static readonly ITextMapPropagator Propagator = new TraceContextPropagator();
 
         private readonly ILogger<MessageSender> logger;
         private readonly IConnection connection;

src/OpenTelemetry.Api/CHANGELOG.md

@@ -9,6 +9,8 @@
 * `B3Propagator` now supports the value `true` to be passed in for the header
  `X-B3-Sampled`.
  ([#1413](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1413))
+ * Renamed IPropagator to ITextMapPropagator, TextMapPropagator to TraceContextPropagator
+  ([#1427](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1427))
 
 ## 0.7.0-beta.1
 

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

@@ -24,9 +24,9 @@
 namespace OpenTelemetry.Context.Propagation
 {
     /// <summary>
-    /// B3 text propagator. See https://github.com/openzipkin/b3-propagation for the specification.
+    /// A text map propagator for B3. See https://github.com/openzipkin/b3-propagation.
     /// </summary>
-    public sealed class B3Propagator : IPropagator
+    public sealed class B3Propagator : ITextMapPropagator
     {
         internal const string XB3TraceId = "X-B3-TraceId";
         internal const string XB3SpanId = "X-B3-SpanId";

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

@@ -24,9 +24,9 @@
 namespace OpenTelemetry.Context.Propagation
 {
     /// <summary>
-    /// W3C baggage: https://github.com/w3c/baggage/blob/master/baggage/HTTP_HEADER_FORMAT.md.
+    /// A text map propagator for W3C Baggage. See https://w3c.github.io/baggage/
     /// </summary>
-    public class BaggagePropagator : IPropagator
+    public class BaggagePropagator : ITextMapPropagator
     {
         internal const string BaggageHeaderName = "Baggage";
 

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

@@ -22,18 +22,18 @@ namespace OpenTelemetry.Context.Propagation
     /// <summary>
     /// CompositePropagator provides a mechanism for combining multiple propagators into a single one.
     /// </summary>
-    public class CompositePropagator : IPropagator
+    public class CompositePropagator : ITextMapPropagator
     {
         private static readonly ISet<string> EmptyFields = new HashSet<string>();
-        private readonly List<IPropagator> propagators;
+        private readonly List<ITextMapPropagator> propagators;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="CompositePropagator"/> class.
         /// </summary>
-        /// <param name="propagators">List of <see cref="IPropagator"/> wire context propagator.</param>
-        public CompositePropagator(IEnumerable<IPropagator> propagators)
+        /// <param name="propagators">List of <see cref="ITextMapPropagator"/> wire context propagator.</param>
+        public CompositePropagator(IEnumerable<ITextMapPropagator> propagators)
         {
-            this.propagators = new List<IPropagator>(propagators ?? throw new ArgumentNullException(nameof(propagators)));
+            this.propagators = new List<ITextMapPropagator>(propagators ?? throw new ArgumentNullException(nameof(propagators)));
         }
 
         /// <inheritdoc/>

src/OpenTelemetry.Api/Context/Propagation/IPropagator.cs → src/OpenTelemetry.Api/Context/Propagation/ITextMapPropagator.cs

@@ -1,4 +1,4 @@
-// <copyright file="IPropagator.cs" company="OpenTelemetry Authors">
+// <copyright file="ITextMapPropagator.cs" company="OpenTelemetry Authors">
 // Copyright The OpenTelemetry Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,10 +20,11 @@
 namespace OpenTelemetry.Context.Propagation
 {
     /// <summary>
-    /// Defines an interface for Propagator, which is used to read and write
-    /// context data from and to message exchanges by the applications.
+    /// Defines an interface for a Propagator of TextMap type,
+    /// which uses string key/value pairs to inject and extract
+    /// propagation data.
     /// </summary>
-    public interface IPropagator
+    public interface ITextMapPropagator
     {
         /// <summary>
         /// Gets the list of headers used by propagator. The use cases of this are:

src/OpenTelemetry.Api/Context/Propagation/TextMapPropagator.cs → src/OpenTelemetry.Api/Context/Propagation/TraceContextPropagator.cs

@@ -1,4 +1,4 @@
-// <copyright file="TextMapPropagator.cs" company="OpenTelemetry Authors">
+// <copyright file="TraceContextPropagator.cs" company="OpenTelemetry Authors">
 // Copyright The OpenTelemetry Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,9 +24,9 @@
 namespace OpenTelemetry.Context.Propagation
 {
     /// <summary>
-    /// W3C trace context text wire protocol formatter. See https://github.com/w3c/distributed-tracing/.
+    /// A text map propagator for W3C trace context. See https://w3c.github.io/trace-context/.
     /// </summary>
-    public class TextMapPropagator : IPropagator
+    public class TraceContextPropagator : ITextMapPropagator
     {
         private const string TraceParent = "traceparent";
         private const string TraceState = "tracestate";
@@ -53,13 +53,13 @@ public PropagationContext Extract<T>(PropagationContext context, T carrier, Func
 
             if (carrier == null)
             {
-                OpenTelemetryApiEventSource.Log.FailedToExtractActivityContext(nameof(TextMapPropagator), "null carrier");
+                OpenTelemetryApiEventSource.Log.FailedToExtractActivityContext(nameof(TraceContextPropagator), "null carrier");
                 return context;
             }
 
             if (getter == null)
             {
-                OpenTelemetryApiEventSource.Log.FailedToExtractActivityContext(nameof(TextMapPropagator), "null getter");
+                OpenTelemetryApiEventSource.Log.FailedToExtractActivityContext(nameof(TraceContextPropagator), "null getter");
                 return context;
             }
 
@@ -94,7 +94,7 @@ public PropagationContext Extract<T>(PropagationContext context, T carrier, Func
             }
             catch (Exception ex)
             {
-                OpenTelemetryApiEventSource.Log.ActivityContextExtractException(nameof(TextMapPropagator), ex);
+                OpenTelemetryApiEventSource.Log.ActivityContextExtractException(nameof(TraceContextPropagator), ex);
             }
 
             // in case of exception indicate to upstream that there is no parseable context from the top
@@ -106,19 +106,19 @@ public void Inject<T>(PropagationContext context, T carrier, Action<T, string, s
         {
             if (context.ActivityContext.TraceId == default || context.ActivityContext.SpanId == default)
             {
-                OpenTelemetryApiEventSource.Log.FailedToInjectActivityContext(nameof(TextMapPropagator), "Invalid context");
+                OpenTelemetryApiEventSource.Log.FailedToInjectActivityContext(nameof(TraceContextPropagator), "Invalid context");
                 return;
             }
 
             if (carrier == null)
             {
-                OpenTelemetryApiEventSource.Log.FailedToInjectActivityContext(nameof(TextMapPropagator), "null carrier");
+                OpenTelemetryApiEventSource.Log.FailedToInjectActivityContext(nameof(TraceContextPropagator), "null carrier");
                 return;
             }
 
             if (setter == null)
             {
-                OpenTelemetryApiEventSource.Log.FailedToInjectActivityContext(nameof(TextMapPropagator), "null setter");
+                OpenTelemetryApiEventSource.Log.FailedToInjectActivityContext(nameof(TraceContextPropagator), "null setter");
                 return;
             }
 

src/OpenTelemetry.Instrumentation.AspNet/AspNetInstrumentationOptions.cs

@@ -27,11 +27,11 @@ namespace OpenTelemetry.Instrumentation.AspNet
     public class AspNetInstrumentationOptions
     {
         /// <summary>
-        /// Gets or sets <see cref="IPropagator"/> for context propagation. Default value: <see cref="CompositePropagator"/> with <see cref="TextMapPropagator"/> &amp; <see cref="BaggagePropagator"/>.
+        /// Gets or sets <see cref="ITextMapPropagator"/> for context propagation. Default value: <see cref="CompositePropagator"/> with <see cref="TraceContextPropagator"/> &amp; <see cref="BaggagePropagator"/>.
         /// </summary>
-        public IPropagator Propagator { get; set; } = new CompositePropagator(new IPropagator[]
+        public ITextMapPropagator Propagator { get; set; } = new CompositePropagator(new ITextMapPropagator[]
         {
-            new TextMapPropagator(),
+            new TraceContextPropagator(),
             new BaggagePropagator(),
         });
 

src/OpenTelemetry.Instrumentation.AspNet/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+* Renamed IPropagator to ITextMapPropagator, TextMapPropagator to TraceContextPropagator
+  ([#1427](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1427))
+
 ## 0.7.0-beta.1
 
 Released 2020-Oct-16

src/OpenTelemetry.Instrumentation.AspNet/Implementation/HttpInListener.cs

@@ -70,7 +70,7 @@ public override void OnStartActivity(Activity activity, object payload)
             var request = context.Request;
             var requestValues = request.Unvalidated;
 
-            if (!(this.options.Propagator is TextMapPropagator))
+            if (!(this.options.Propagator is TraceContextPropagator))
             {
                 var ctx = this.options.Propagator.Extract(default, request, HttpRequestHeaderValuesGetter);
 
@@ -139,7 +139,7 @@ public override void OnStopActivity(Activity activity, object payload)
             Activity activityToEnrich = activity;
             Activity createdActivity = null;
 
-            bool isCustomPropagator = !(this.options.Propagator is TextMapPropagator);
+            bool isCustomPropagator = !(this.options.Propagator is TraceContextPropagator);
 
             if (isCustomPropagator)
             {

src/OpenTelemetry.Instrumentation.AspNetCore/AspNetCoreInstrumentationOptions.cs

@@ -27,11 +27,11 @@ namespace OpenTelemetry.Instrumentation.AspNetCore
     public class AspNetCoreInstrumentationOptions
     {
         /// <summary>
-        /// Gets or sets <see cref="IPropagator"/> for context propagation. Default value: <see cref="CompositePropagator"/> with <see cref="TextMapPropagator"/> &amp; <see cref="BaggagePropagator"/>.
+        /// Gets or sets <see cref="ITextMapPropagator"/> for context propagation. Default value: <see cref="CompositePropagator"/> with <see cref="TraceContextPropagator"/> &amp; <see cref="BaggagePropagator"/>.
         /// </summary>
-        public IPropagator Propagator { get; set; } = new CompositePropagator(new IPropagator[]
+        public ITextMapPropagator Propagator { get; set; } = new CompositePropagator(new ITextMapPropagator[]
         {
-            new TextMapPropagator(),
+            new TraceContextPropagator(),
             new BaggagePropagator(),
         });
 

src/OpenTelemetry.Instrumentation.AspNetCore/CHANGELOG.md

@@ -10,6 +10,8 @@
   [Grpc.AspNetCore](https://www.nuget.org/packages/Grpc.AspNetCore/).
   This option is enabled by default.
   ([#1423](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1423))
+* Renamed IPropagator to ITextMapPropagator, TextMapPropagator to TraceContextPropagator
+  ([#1427](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1427))
 
 ## 0.7.0-beta.1
 

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInListener.cs

@@ -78,7 +78,7 @@ public override void OnStartActivity(Activity activity, object payload)
             }
 
             var request = context.Request;
-            if (!this.hostingSupportsW3C || !(this.options.Propagator is TextMapPropagator))
+            if (!this.hostingSupportsW3C || !(this.options.Propagator is TraceContextPropagator))
             {
                 var ctx = this.options.Propagator.Extract(default, request, HttpRequestHeaderValuesGetter);
 

src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md

@@ -6,6 +6,8 @@
   `HttpWebRequest` in Activity.CustomProperty. To enrich activity, use the
   Enrich action on the instrumentation.
   ([#1407](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1407))
+* Renamed IPropagator to ITextMapPropagator, TextMapPropagator to TraceContextPropagator
+  ([#1427](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1427))
 
 ## 0.7.0-beta.1
 

src/OpenTelemetry.Instrumentation.Http/HttpClientInstrumentationOptions.cs

@@ -35,11 +35,11 @@ public class HttpClientInstrumentationOptions
         public bool SetHttpFlavor { get; set; }
 
         /// <summary>
-        /// Gets or sets <see cref="IPropagator"/> for context propagation. Default value: <see cref="CompositePropagator"/> with <see cref="TextMapPropagator"/> &amp; <see cref="BaggagePropagator"/>.
+        /// Gets or sets <see cref="ITextMapPropagator"/> for context propagation. Default value: <see cref="CompositePropagator"/> with <see cref="TraceContextPropagator"/> &amp; <see cref="BaggagePropagator"/>.
         /// </summary>
-        public IPropagator Propagator { get; set; } = new CompositePropagator(new IPropagator[]
+        public ITextMapPropagator Propagator { get; set; } = new CompositePropagator(new ITextMapPropagator[]
         {
-            new TextMapPropagator(),
+            new TraceContextPropagator(),
             new BaggagePropagator(),
         });
 

src/OpenTelemetry.Instrumentation.Http/HttpWebRequestInstrumentationOptions.netfx.cs

@@ -35,11 +35,11 @@ public class HttpWebRequestInstrumentationOptions
         public bool SetHttpFlavor { get; set; }
 
         /// <summary>
-        /// Gets or sets <see cref="IPropagator"/> for context propagation. Default value: <see cref="CompositePropagator"/> with <see cref="TextMapPropagator"/> &amp; <see cref="BaggagePropagator"/>.
+        /// Gets or sets <see cref="ITextMapPropagator"/> for context propagation. Default value: <see cref="CompositePropagator"/> with <see cref="TraceContextPropagator"/> &amp; <see cref="BaggagePropagator"/>.
         /// </summary>
-        public IPropagator Propagator { get; set; } = new CompositePropagator(new IPropagator[]
+        public ITextMapPropagator Propagator { get; set; } = new CompositePropagator(new ITextMapPropagator[]
         {
-            new TextMapPropagator(),
+            new TraceContextPropagator(),
             new BaggagePropagator(),
         });
 

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

@@ -115,7 +115,7 @@ public override void OnStartActivity(Activity activity, object payload)
                 }
             }
 
-            if (!(this.httpClientSupportsW3C && this.options.Propagator is TextMapPropagator))
+            if (!(this.httpClientSupportsW3C && this.options.Propagator is TraceContextPropagator))
             {
                 this.options.Propagator.Inject(new PropagationContext(activity.Context, Baggage.Current), request, HttpRequestMessageHeaderValueSetter);
             }

src/OpenTelemetry.Shims.OpenTracing/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## Unreleased
+* Renamed IPropagator to ITextMapPropagator, TextMapPropagator to TraceContextPropagator
+  ([#1427](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1427))
 
 ## 0.7.0-beta.1
 

src/OpenTelemetry.Shims.OpenTracing/TracerShim.cs

@@ -24,9 +24,9 @@ namespace OpenTelemetry.Shims.OpenTracing
     public class TracerShim : global::OpenTracing.ITracer
     {
         private readonly Trace.Tracer tracer;
-        private readonly IPropagator propagator;
+        private readonly ITextMapPropagator propagator;
 
-        public TracerShim(Trace.Tracer tracer, IPropagator textFormat)
+        public TracerShim(Trace.Tracer tracer, ITextMapPropagator textFormat)
         {
             this.tracer = tracer ?? throw new ArgumentNullException(nameof(tracer));
             this.propagator = textFormat ?? throw new ArgumentNullException(nameof(textFormat));

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

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

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

@@ -196,7 +196,7 @@ public async Task CustomPropagator()
             var expectedTraceId = ActivityTraceId.CreateRandom();
             var expectedSpanId = ActivitySpanId.CreateRandom();
 
-            var propagator = new Mock<IPropagator>();
+            var propagator = new Mock<ITextMapPropagator>();
             propagator.Setup(m => m.Extract(It.IsAny<PropagationContext>(), It.IsAny<HttpRequest>(), It.IsAny<Func<HttpRequest, string, IEnumerable<string>>>())).Returns(
                 new PropagationContext(
                     new ActivityContext(

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

@@ -75,7 +75,7 @@ public async Task HttpClientInstrumentationInjectsHeadersAsync(bool shouldEnrich
             parent.ActivityTraceFlags = ActivityTraceFlags.Recorded;
 
             // Ensure that the header value func does not throw if the header key can't be found
-            var mockPropagator = new Mock<IPropagator>();
+            var mockPropagator = new Mock<ITextMapPropagator>();
 
             // var isInjectedHeaderValueGetterThrows = false;
             // mockTextFormat
@@ -133,7 +133,7 @@ public async Task HttpClientInstrumentationInjectsHeadersAsync(bool shouldEnrich
         [InlineData(false)]
         public async Task HttpClientInstrumentationInjectsHeadersAsync_CustomFormat(bool shouldEnrich)
         {
-            var propagator = new Mock<IPropagator>();
+            var propagator = new Mock<ITextMapPropagator>();
             propagator.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) =>
                 {

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

@@ -98,7 +98,7 @@ public async Task HttpWebRequestInstrumentationInjectsHeadersAsync()
         [Fact]
         public async Task HttpWebRequestInstrumentationInjectsHeadersAsync_CustomFormat()
         {
-            var propagator = new Mock<IPropagator>();
+            var propagator = new Mock<ITextMapPropagator>();
             propagator.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) =>
                 {