Resource allocation improvement (#1463)

* Introduces the concept of IProviderContainer which allows injection of a TracerProvider into lower levels (Processor, Exporter, etc.). * Removed IProviderContainer and fixed the provider types. * Removed log provider example. * Working on getting everything working with the new API. * Attempting to get all the tests passing. * Added concept of BaseProvider. Updated public API. * Project fixup. * Removed OnParentProviderSet. * Updated changelog. * Test fixup. * Test fixup. * Cleanup.
open-telemetry · Nov 9, 2020 · b956a5f · b956a5f
1 parent 052ecc4
commit b956a5f
Show file tree

Hide file tree

Showing 41 changed files with 322 additions and 383 deletions.
diff --git a/.github/workflows/dotnet-core-linux.yml b/.github/workflows/dotnet-core-linux.yml
@@ -20,12 +20,12 @@ jobs:
     - name: Setup .NET Core 2.1
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 2.1.807
+        dotnet-version: 2.1.x
 
     - name: Setup .NET Core 3.1
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 3.1.301
+        dotnet-version: 3.1.x
 
     - name: Setup .NET 5
       uses: actions/setup-dotnet@v1

diff --git a/build/Common.prod.props b/build/Common.prod.props
@@ -63,6 +63,8 @@
   <ItemGroup>
     <AdditionalFiles Include=".publicApi\$(TargetFramework)\PublicAPI.Shipped.txt" />
     <AdditionalFiles Include=".publicApi\$(TargetFramework)\PublicAPI.Unshipped.txt" />
+    <None Include=".publicApi\*\PublicAPI.Shipped.txt" />
+    <None Include=".publicApi\*\PublicAPI.Unshipped.txt" />
   </ItemGroup>
 
 </Project>
diff --git a/src/OpenTelemetry.Api/.publicApi/net452/PublicAPI.Unshipped.txt b/src/OpenTelemetry.Api/.publicApi/net452/PublicAPI.Unshipped.txt
@@ -14,6 +14,10 @@ OpenTelemetry.Baggage.RemoveBaggage(string name) -> OpenTelemetry.Baggage
 OpenTelemetry.Baggage.SetBaggage(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string>> baggageItems) -> OpenTelemetry.Baggage
 OpenTelemetry.Baggage.SetBaggage(params System.Collections.Generic.KeyValuePair<string, string>[] baggageItems) -> OpenTelemetry.Baggage
 OpenTelemetry.Baggage.SetBaggage(string name, string value) -> OpenTelemetry.Baggage
+OpenTelemetry.BaseProvider
+OpenTelemetry.BaseProvider.BaseProvider() -> void
+OpenTelemetry.BaseProvider.Dispose() -> void
+OpenTelemetry.BaseProvider.~BaseProvider() -> void
 OpenTelemetry.Context.Propagation.B3Propagator
 OpenTelemetry.Context.Propagation.B3Propagator.B3Propagator() -> void
 OpenTelemetry.Context.Propagation.B3Propagator.B3Propagator(bool singleHeader) -> void
@@ -70,7 +74,6 @@ OpenTelemetry.Metrics.Meter.Meter() -> void
 OpenTelemetry.Metrics.MeterFactoryBase
 OpenTelemetry.Metrics.MeterFactoryBase.MeterFactoryBase() -> void
 OpenTelemetry.Metrics.MeterProvider
-OpenTelemetry.Metrics.MeterProvider.Dispose() -> void
 OpenTelemetry.Metrics.MeterProvider.MeterProvider() -> void
 OpenTelemetry.Metrics.NoopBoundCounterMetric<T>
 OpenTelemetry.Metrics.NoopBoundCounterMetric<T>.NoopBoundCounterMetric() -> void
@@ -166,7 +169,6 @@ OpenTelemetry.Trace.Tracer.StartRootSpan(string name, OpenTelemetry.Trace.SpanKi
 OpenTelemetry.Trace.Tracer.StartSpan(string name, OpenTelemetry.Trace.SpanKind kind = OpenTelemetry.Trace.SpanKind.Internal, in OpenTelemetry.Trace.SpanContext parentContext = default(OpenTelemetry.Trace.SpanContext), OpenTelemetry.Trace.SpanAttributes initialAttributes = null, System.Collections.Generic.IEnumerable<OpenTelemetry.Trace.Link> links = null, System.DateTimeOffset startTime = default(System.DateTimeOffset)) -> OpenTelemetry.Trace.TelemetrySpan
 OpenTelemetry.Trace.Tracer.StartSpan(string name, OpenTelemetry.Trace.SpanKind kind, in OpenTelemetry.Trace.TelemetrySpan parentSpan, OpenTelemetry.Trace.SpanAttributes initialAttributes = null, System.Collections.Generic.IEnumerable<OpenTelemetry.Trace.Link> links = null, System.DateTimeOffset startTime = default(System.DateTimeOffset)) -> OpenTelemetry.Trace.TelemetrySpan
 OpenTelemetry.Trace.TracerProvider
-OpenTelemetry.Trace.TracerProvider.Dispose() -> void
 OpenTelemetry.Trace.TracerProvider.GetTracer(string name, string version = null) -> OpenTelemetry.Trace.Tracer
 OpenTelemetry.Trace.TracerProvider.TracerProvider() -> void
 abstract OpenTelemetry.Context.RuntimeContextSlot<T>.Get() -> T
@@ -300,10 +302,9 @@ static readonly OpenTelemetry.Metrics.NoopMeasureMetric<T>.Instance -> OpenTelem
 static readonly OpenTelemetry.Trace.Status.Error -> OpenTelemetry.Trace.Status
 static readonly OpenTelemetry.Trace.Status.Ok -> OpenTelemetry.Trace.Status
 static readonly OpenTelemetry.Trace.Status.Unset -> OpenTelemetry.Trace.Status
+virtual OpenTelemetry.BaseProvider.Dispose(bool disposing) -> void
 virtual OpenTelemetry.Context.RuntimeContextSlot<T>.Dispose(bool disposing) -> void
 virtual OpenTelemetry.Metrics.LabelSet.Labels.get -> System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string>>
 virtual OpenTelemetry.Metrics.LabelSet.Labels.set -> void
 virtual OpenTelemetry.Metrics.MeterFactoryBase.GetMeter(string name, string version = null) -> OpenTelemetry.Metrics.Meter
-virtual OpenTelemetry.Metrics.MeterProvider.Dispose(bool disposing) -> void
 virtual OpenTelemetry.Metrics.MeterProvider.GetMeter(string name, string version = null) -> OpenTelemetry.Metrics.Meter
-virtual OpenTelemetry.Trace.TracerProvider.Dispose(bool disposing) -> void
diff --git a/src/OpenTelemetry.Api/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt b/src/OpenTelemetry.Api/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt
@@ -14,6 +14,10 @@ OpenTelemetry.Baggage.RemoveBaggage(string name) -> OpenTelemetry.Baggage
 OpenTelemetry.Baggage.SetBaggage(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string>> baggageItems) -> OpenTelemetry.Baggage
 OpenTelemetry.Baggage.SetBaggage(params System.Collections.Generic.KeyValuePair<string, string>[] baggageItems) -> OpenTelemetry.Baggage
 OpenTelemetry.Baggage.SetBaggage(string name, string value) -> OpenTelemetry.Baggage
+OpenTelemetry.BaseProvider
+OpenTelemetry.BaseProvider.BaseProvider() -> void
+OpenTelemetry.BaseProvider.Dispose() -> void
+OpenTelemetry.BaseProvider.~BaseProvider() -> void
 OpenTelemetry.Context.AsyncLocalRuntimeContextSlot<T>
 OpenTelemetry.Context.AsyncLocalRuntimeContextSlot<T>.AsyncLocalRuntimeContextSlot(string name) -> void
 OpenTelemetry.Context.Propagation.B3Propagator
@@ -70,7 +74,6 @@ OpenTelemetry.Metrics.Meter.Meter() -> void
 OpenTelemetry.Metrics.MeterFactoryBase
 OpenTelemetry.Metrics.MeterFactoryBase.MeterFactoryBase() -> void
 OpenTelemetry.Metrics.MeterProvider
-OpenTelemetry.Metrics.MeterProvider.Dispose() -> void
 OpenTelemetry.Metrics.MeterProvider.MeterProvider() -> void
 OpenTelemetry.Metrics.NoopBoundCounterMetric<T>
 OpenTelemetry.Metrics.NoopBoundCounterMetric<T>.NoopBoundCounterMetric() -> void
@@ -166,7 +169,6 @@ OpenTelemetry.Trace.Tracer.StartRootSpan(string name, OpenTelemetry.Trace.SpanKi
 OpenTelemetry.Trace.Tracer.StartSpan(string name, OpenTelemetry.Trace.SpanKind kind = OpenTelemetry.Trace.SpanKind.Internal, in OpenTelemetry.Trace.SpanContext parentContext = default(OpenTelemetry.Trace.SpanContext), OpenTelemetry.Trace.SpanAttributes initialAttributes = null, System.Collections.Generic.IEnumerable<OpenTelemetry.Trace.Link> links = null, System.DateTimeOffset startTime = default(System.DateTimeOffset)) -> OpenTelemetry.Trace.TelemetrySpan
 OpenTelemetry.Trace.Tracer.StartSpan(string name, OpenTelemetry.Trace.SpanKind kind, in OpenTelemetry.Trace.TelemetrySpan parentSpan, OpenTelemetry.Trace.SpanAttributes initialAttributes = null, System.Collections.Generic.IEnumerable<OpenTelemetry.Trace.Link> links = null, System.DateTimeOffset startTime = default(System.DateTimeOffset)) -> OpenTelemetry.Trace.TelemetrySpan
 OpenTelemetry.Trace.TracerProvider
-OpenTelemetry.Trace.TracerProvider.Dispose() -> void
 OpenTelemetry.Trace.TracerProvider.GetTracer(string name, string version = null) -> OpenTelemetry.Trace.Tracer
 OpenTelemetry.Trace.TracerProvider.TracerProvider() -> void
 abstract OpenTelemetry.Context.RuntimeContextSlot<T>.Get() -> T
@@ -300,10 +302,9 @@ static readonly OpenTelemetry.Metrics.NoopMeasureMetric<T>.Instance -> OpenTelem
 static readonly OpenTelemetry.Trace.Status.Error -> OpenTelemetry.Trace.Status
 static readonly OpenTelemetry.Trace.Status.Ok -> OpenTelemetry.Trace.Status
 static readonly OpenTelemetry.Trace.Status.Unset -> OpenTelemetry.Trace.Status
+virtual OpenTelemetry.BaseProvider.Dispose(bool disposing) -> void
 virtual OpenTelemetry.Context.RuntimeContextSlot<T>.Dispose(bool disposing) -> void
 virtual OpenTelemetry.Metrics.LabelSet.Labels.get -> System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string>>
 virtual OpenTelemetry.Metrics.LabelSet.Labels.set -> void
 virtual OpenTelemetry.Metrics.MeterFactoryBase.GetMeter(string name, string version = null) -> OpenTelemetry.Metrics.Meter
-virtual OpenTelemetry.Metrics.MeterProvider.Dispose(bool disposing) -> void
 virtual OpenTelemetry.Metrics.MeterProvider.GetMeter(string name, string version = null) -> OpenTelemetry.Metrics.Meter
-virtual OpenTelemetry.Trace.TracerProvider.Dispose(bool disposing) -> void
diff --git a/src/OpenTelemetry.Api/BaseProvider.cs b/src/OpenTelemetry.Api/BaseProvider.cs
@@ -0,0 +1,49 @@
+// <copyright file="BaseProvider.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using System;
+
+namespace OpenTelemetry
+{
+    /// <summary>
+    /// Contains logic shared by all OpenTelemetry providers.
+    /// </summary>
+    public abstract class BaseProvider : IDisposable
+    {
+        /// <summary>
+        /// Finalizes an instance of the <see cref="BaseProvider"/> class.
+        /// </summary>
+        ~BaseProvider()
+        {
+            this.Dispose(false);
+        }
+
+        /// <inheritdoc/>
+        public void Dispose()
+        {
+            this.Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        /// <summary>
+        /// Releases the unmanaged resources used by this class and optionally releases the managed resources.
+        /// </summary>
+        /// <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
+        protected virtual void Dispose(bool disposing)
+        {
+        }
+    }
+}
diff --git a/src/OpenTelemetry.Api/Metrics/MeterProvider.cs b/src/OpenTelemetry.Api/Metrics/MeterProvider.cs
@@ -21,7 +21,7 @@ namespace OpenTelemetry.Metrics
     /// <summary>
     /// MeterProvider is the entry point of the OpenTelemetry Metrics API. It provides access to Meters.
     /// </summary>
-    public class MeterProvider : IDisposable
+    public class MeterProvider : BaseProvider
     {
         private static ProxyMeter proxyMeter = new ProxyMeter();
         private static bool isInitialized;
@@ -71,13 +71,6 @@ public static void SetDefault(MeterProvider meterProvider)
             isInitialized = true;
         }
 
-        /// <inheritdoc/>
-        public void Dispose()
-        {
-            this.Dispose(true);
-            GC.SuppressFinalize(this);
-        }
-
         /// <summary>
         /// Returns a Meter for a given name and version.
         /// </summary>
@@ -96,13 +89,5 @@ internal static void Reset()
             isInitialized = false;
             defaultProvider = new MeterProvider();
         }
-
-        /// <summary>
-        /// Releases the unmanaged resources used by this class and optionally releases the managed resources.
-        /// </summary>
-        /// <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
-        protected virtual void Dispose(bool disposing)
-        {
-        }
     }
 }
diff --git a/src/OpenTelemetry.Api/Trace/TracerProvider.cs b/src/OpenTelemetry.Api/Trace/TracerProvider.cs
@@ -14,15 +14,14 @@
 // limitations under the License.
 // </copyright>
 
-using System;
 using System.Diagnostics;
 
 namespace OpenTelemetry.Trace
 {
     /// <summary>
     /// TracerProvider is the entry point of the OpenTelemetry API. It provides access to <see cref="Tracer"/>.
     /// </summary>
-    public class TracerProvider : IDisposable
+    public class TracerProvider : BaseProvider
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="TracerProvider"/> class.
@@ -51,20 +50,5 @@ public Tracer GetTracer(string name, string version = null)
 
             return new Tracer(new ActivitySource(name, version));
         }
-
-        /// <inheritdoc/>
-        public void Dispose()
-        {
-            this.Dispose(true);
-            GC.SuppressFinalize(this);
-        }
-
-        /// <summary>
-        /// Releases the unmanaged resources used by this class and optionally releases the managed resources.
-        /// </summary>
-        /// <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
-        protected virtual void Dispose(bool disposing)
-        {
-        }
     }
 }
diff --git a/src/OpenTelemetry.Exporter.Console/ConsoleExporter.cs b/src/OpenTelemetry.Exporter.Console/ConsoleExporter.cs
@@ -21,7 +21,6 @@
 using OpenTelemetry.Logs;
 #endif
 using OpenTelemetry.Resources;
-using OpenTelemetry.Trace;
 
 namespace OpenTelemetry.Exporter
 {
@@ -99,7 +98,7 @@ public override ExportResult Export(in Batch<T> batch)
                         }
                     }
 
-                    var resource = activity.GetResource();
+                    var resource = this.ParentProvider.GetResource();
                     if (resource != Resource.Empty)
                     {
                         this.WriteLine("Resource associated with Activity:");

diff --git a/src/OpenTelemetry.Exporter.Jaeger/JaegerExporter.cs b/src/OpenTelemetry.Exporter.Jaeger/JaegerExporter.cs
@@ -20,7 +20,6 @@
 using System.Runtime.CompilerServices;
 using OpenTelemetry.Exporter.Jaeger.Implementation;
 using OpenTelemetry.Resources;
-using OpenTelemetry.Trace;
 using Thrift.Protocol;
 using Thrift.Transport;
 using Process = OpenTelemetry.Exporter.Jaeger.Implementation.Process;
@@ -65,13 +64,13 @@ public override ExportResult Export(in Batch<Activity> activityBatch)
         {
             try
             {
-                foreach (var activity in activityBatch)
+                if (this.processCache == null)
                 {
-                    if (this.processCache == null)
-                    {
-                        this.ApplyLibraryResource(activity.GetResource());
-                    }
+                    this.SetResource(this.ParentProvider.GetResource());
+                }
 
+                foreach (var activity in activityBatch)
+                {
                     this.AppendSpan(activity.ToJaegerSpan());
                 }
 
@@ -87,18 +86,18 @@ public override ExportResult Export(in Batch<Activity> activityBatch)
             }
         }
 
-        internal void ApplyLibraryResource(Resource libraryResource)
+        internal void SetResource(Resource resource)
         {
-            if (libraryResource is null)
+            if (resource is null)
             {
-                throw new ArgumentNullException(nameof(libraryResource));
+                throw new ArgumentNullException(nameof(resource));
             }
 
             var process = this.Process;
 
             string serviceName = null;
             string serviceNamespace = null;
-            foreach (var label in libraryResource.Attributes)
+            foreach (var label in resource.Attributes)
             {
                 string key = label.Key;
 

diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ActivityExtensions.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ActivityExtensions.cs
@@ -28,6 +28,7 @@
 using OpenTelemetry.Trace;
 using OtlpCollector = Opentelemetry.Proto.Collector.Trace.V1;
 using OtlpCommon = Opentelemetry.Proto.Common.V1;
+using OtlpResource = Opentelemetry.Proto.Resource.V1;
 using OtlpTrace = Opentelemetry.Proto.Trace.V1;
 
 namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation
@@ -40,23 +41,18 @@ internal static class ActivityExtensions
 
         internal static void AddBatch(
             this OtlpCollector.ExportTraceServiceRequest request,
-            OtlpExporter otlpExporter,
+            OtlpResource.Resource processResource,
             in Batch<Activity> activityBatch)
         {
             Dictionary<string, OtlpTrace.InstrumentationLibrarySpans> spansByLibrary = new Dictionary<string, OtlpTrace.InstrumentationLibrarySpans>();
-            OtlpTrace.ResourceSpans resourceSpans = null;
+            OtlpTrace.ResourceSpans resourceSpans = new OtlpTrace.ResourceSpans
+            {
+                Resource = processResource,
+            };
+            request.ResourceSpans.Add(resourceSpans);
 
             foreach (var activity in activityBatch)
             {
-                if (resourceSpans == null)
-                {
-                    resourceSpans = new OtlpTrace.ResourceSpans
-                    {
-                        Resource = otlpExporter.EnsureProcessResource(activity),
-                    };
-                    request.ResourceSpans.Add(resourceSpans);
-                }
-
                 OtlpTrace.Span span = activity.ToOtlpSpan();
                 if (span == null)
                 {