From 6576a962b500a75c49c029a11854bb3e6ff303ad Mon Sep 17 00:00:00 2001 From: Mikel Blanchard Date: Fri, 28 Apr 2023 12:19:55 -0700 Subject: [PATCH] Code review. --- .../.publicApi/net462/PublicAPI.Unshipped.txt | 2 ++ .../.publicApi/net6.0/PublicAPI.Unshipped.txt | 2 ++ .../netstandard2.0/PublicAPI.Unshipped.txt | 2 ++ .../netstandard2.1/PublicAPI.Unshipped.txt | 2 ++ src/OpenTelemetry/BaseExportProcessor.cs | 6 ++++ src/OpenTelemetry/BaseProcessor.cs | 4 +++ src/OpenTelemetry/Logs/LoggerProviderSdk.cs | 31 ++++++------------- 7 files changed, 28 insertions(+), 21 deletions(-) diff --git a/src/OpenTelemetry/.publicApi/net462/PublicAPI.Unshipped.txt b/src/OpenTelemetry/.publicApi/net462/PublicAPI.Unshipped.txt index f43534a60aa..ae90dbc9e28 100644 --- a/src/OpenTelemetry/.publicApi/net462/PublicAPI.Unshipped.txt +++ b/src/OpenTelemetry/.publicApi/net462/PublicAPI.Unshipped.txt @@ -35,6 +35,8 @@ OpenTelemetry.Metrics.ExponentialHistogramData.ZeroCount.get -> long OpenTelemetry.Metrics.MetricType.ExponentialHistogram = 80 -> OpenTelemetry.Metrics.MetricType OpenTelemetry.Metrics.TraceBasedExemplarFilter OpenTelemetry.Metrics.TraceBasedExemplarFilter.TraceBasedExemplarFilter() -> void +override OpenTelemetry.BaseExportProcessor.ToString() -> string! +override OpenTelemetry.BaseProcessor.ToString() -> string! static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.SetExemplarFilter(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder, OpenTelemetry.Metrics.ExemplarFilter! exemplarFilter) -> OpenTelemetry.Metrics.MeterProviderBuilder! ~abstract OpenTelemetry.Metrics.ExemplarFilter.ShouldSample(double value, System.ReadOnlySpan> tags) -> bool ~abstract OpenTelemetry.Metrics.ExemplarFilter.ShouldSample(long value, System.ReadOnlySpan> tags) -> bool diff --git a/src/OpenTelemetry/.publicApi/net6.0/PublicAPI.Unshipped.txt b/src/OpenTelemetry/.publicApi/net6.0/PublicAPI.Unshipped.txt index f43534a60aa..ae90dbc9e28 100644 --- a/src/OpenTelemetry/.publicApi/net6.0/PublicAPI.Unshipped.txt +++ b/src/OpenTelemetry/.publicApi/net6.0/PublicAPI.Unshipped.txt @@ -35,6 +35,8 @@ OpenTelemetry.Metrics.ExponentialHistogramData.ZeroCount.get -> long OpenTelemetry.Metrics.MetricType.ExponentialHistogram = 80 -> OpenTelemetry.Metrics.MetricType OpenTelemetry.Metrics.TraceBasedExemplarFilter OpenTelemetry.Metrics.TraceBasedExemplarFilter.TraceBasedExemplarFilter() -> void +override OpenTelemetry.BaseExportProcessor.ToString() -> string! +override OpenTelemetry.BaseProcessor.ToString() -> string! static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.SetExemplarFilter(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder, OpenTelemetry.Metrics.ExemplarFilter! exemplarFilter) -> OpenTelemetry.Metrics.MeterProviderBuilder! ~abstract OpenTelemetry.Metrics.ExemplarFilter.ShouldSample(double value, System.ReadOnlySpan> tags) -> bool ~abstract OpenTelemetry.Metrics.ExemplarFilter.ShouldSample(long value, System.ReadOnlySpan> tags) -> bool diff --git a/src/OpenTelemetry/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt b/src/OpenTelemetry/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt index f43534a60aa..ae90dbc9e28 100644 --- a/src/OpenTelemetry/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/OpenTelemetry/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt @@ -35,6 +35,8 @@ OpenTelemetry.Metrics.ExponentialHistogramData.ZeroCount.get -> long OpenTelemetry.Metrics.MetricType.ExponentialHistogram = 80 -> OpenTelemetry.Metrics.MetricType OpenTelemetry.Metrics.TraceBasedExemplarFilter OpenTelemetry.Metrics.TraceBasedExemplarFilter.TraceBasedExemplarFilter() -> void +override OpenTelemetry.BaseExportProcessor.ToString() -> string! +override OpenTelemetry.BaseProcessor.ToString() -> string! static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.SetExemplarFilter(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder, OpenTelemetry.Metrics.ExemplarFilter! exemplarFilter) -> OpenTelemetry.Metrics.MeterProviderBuilder! ~abstract OpenTelemetry.Metrics.ExemplarFilter.ShouldSample(double value, System.ReadOnlySpan> tags) -> bool ~abstract OpenTelemetry.Metrics.ExemplarFilter.ShouldSample(long value, System.ReadOnlySpan> tags) -> bool diff --git a/src/OpenTelemetry/.publicApi/netstandard2.1/PublicAPI.Unshipped.txt b/src/OpenTelemetry/.publicApi/netstandard2.1/PublicAPI.Unshipped.txt index f43534a60aa..ae90dbc9e28 100644 --- a/src/OpenTelemetry/.publicApi/netstandard2.1/PublicAPI.Unshipped.txt +++ b/src/OpenTelemetry/.publicApi/netstandard2.1/PublicAPI.Unshipped.txt @@ -35,6 +35,8 @@ OpenTelemetry.Metrics.ExponentialHistogramData.ZeroCount.get -> long OpenTelemetry.Metrics.MetricType.ExponentialHistogram = 80 -> OpenTelemetry.Metrics.MetricType OpenTelemetry.Metrics.TraceBasedExemplarFilter OpenTelemetry.Metrics.TraceBasedExemplarFilter.TraceBasedExemplarFilter() -> void +override OpenTelemetry.BaseExportProcessor.ToString() -> string! +override OpenTelemetry.BaseProcessor.ToString() -> string! static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.SetExemplarFilter(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder, OpenTelemetry.Metrics.ExemplarFilter! exemplarFilter) -> OpenTelemetry.Metrics.MeterProviderBuilder! ~abstract OpenTelemetry.Metrics.ExemplarFilter.ShouldSample(double value, System.ReadOnlySpan> tags) -> bool ~abstract OpenTelemetry.Metrics.ExemplarFilter.ShouldSample(long value, System.ReadOnlySpan> tags) -> bool diff --git a/src/OpenTelemetry/BaseExportProcessor.cs b/src/OpenTelemetry/BaseExportProcessor.cs index 9684a764ae2..e1e715fa6c0 100644 --- a/src/OpenTelemetry/BaseExportProcessor.cs +++ b/src/OpenTelemetry/BaseExportProcessor.cs @@ -48,6 +48,7 @@ public abstract class BaseExportProcessor : BaseProcessor where T : class { protected readonly BaseExporter exporter; + private readonly string friendlyTypeName; private bool disposed; /// @@ -58,11 +59,16 @@ protected BaseExportProcessor(BaseExporter exporter) { Guard.ThrowIfNull(exporter); + this.friendlyTypeName = $"{this.GetType().Name}<{exporter.GetType().Name}>"; this.exporter = exporter; } internal BaseExporter Exporter => this.exporter; + /// + public override string ToString() + => this.friendlyTypeName; + /// public sealed override void OnStart(T data) { diff --git a/src/OpenTelemetry/BaseProcessor.cs b/src/OpenTelemetry/BaseProcessor.cs index 78e6c2daf88..8020a141b50 100644 --- a/src/OpenTelemetry/BaseProcessor.cs +++ b/src/OpenTelemetry/BaseProcessor.cs @@ -153,6 +153,10 @@ public void Dispose() GC.SuppressFinalize(this); } + /// + public override string ToString() + => this.typeName; + internal virtual void SetParentProvider(BaseProvider parentProvider) { this.ParentProvider = parentProvider; diff --git a/src/OpenTelemetry/Logs/LoggerProviderSdk.cs b/src/OpenTelemetry/Logs/LoggerProviderSdk.cs index c2c30cb138e..9baf8d47188 100644 --- a/src/OpenTelemetry/Logs/LoggerProviderSdk.cs +++ b/src/OpenTelemetry/Logs/LoggerProviderSdk.cs @@ -61,9 +61,6 @@ public LoggerProviderSdk( configureProviderBuilder.ConfigureBuilder(serviceProvider!, state); } - StringBuilder processorsAdded = new StringBuilder(); - StringBuilder instrumentationFactoriesAdded = new StringBuilder(); - var resourceBuilder = state.ResourceBuilder ?? ResourceBuilder.CreateDefault(); resourceBuilder.ServiceProvider = serviceProvider; this.Resource = resourceBuilder.Build(); @@ -71,10 +68,10 @@ public LoggerProviderSdk( foreach (var processor in state.Processors) { this.AddProcessor(processor); - processorsAdded.Append(processor.GetType()); - processorsAdded.Append(';'); } + StringBuilder instrumentationFactoriesAdded = new StringBuilder(); + foreach (var instrumentation in state.Instrumentation) { this.instrumentations.Add(instrumentation.Instance); @@ -82,12 +79,6 @@ public LoggerProviderSdk( instrumentationFactoriesAdded.Append(';'); } - if (processorsAdded.Length != 0) - { - processorsAdded.Remove(processorsAdded.Length - 1, 1); - OpenTelemetrySdkEventSource.Log.LoggerProviderSdkEvent($"Processors added = \"{processorsAdded}\"."); - } - if (instrumentationFactoriesAdded.Length != 0) { instrumentationFactoriesAdded.Remove(instrumentationFactoriesAdded.Length - 1, 1); @@ -107,14 +98,10 @@ public LoggerProviderSdk( public void AddProcessor(BaseProcessor processor) { - OpenTelemetrySdkEventSource.Log.LoggerProviderSdkEvent("Started adding processor."); - Guard.ThrowIfNull(processor); processor.SetParentProvider(this); - StringBuilder processorAdded = new StringBuilder(); - if (this.threadStaticPool != null && this.ContainsBatchProcessor(processor)) { OpenTelemetrySdkEventSource.Log.LoggerProviderSdkEvent("Using shared thread pool."); @@ -122,27 +109,29 @@ public void AddProcessor(BaseProcessor processor) this.threadStaticPool = null; } + StringBuilder processorAdded = new StringBuilder(); + if (this.Processor == null) { - processorAdded.Append("Setting processor to "); + processorAdded.Append("Setting processor to '"); processorAdded.Append(processor); + processorAdded.Append('\''); this.Processor = processor; } else if (this.Processor is CompositeProcessor compositeProcessor) { - processorAdded.Append("Adding processor "); + processorAdded.Append("Adding processor '"); processorAdded.Append(processor); - processorAdded.Append(" to composite processor"); + processorAdded.Append("' to composite processor"); compositeProcessor.AddProcessor(processor); } else { - processorAdded.Append("Creating new composite processor with processor "); - processorAdded.Append(this.Processor); - processorAdded.Append(" and adding new processor "); + processorAdded.Append("Creating new composite processor and adding new processor '"); processorAdded.Append(processor); + processorAdded.Append('\''); var newCompositeProcessor = new CompositeProcessor(new[] {