Update diagnosticsource to rc1 (#1203)

* Step1 of updating to Rc1 of diagnostic source * Update parent.spanid to parent.traceid as traceid will be default for root. * add samplingatributes to activity tags * updating to isremote=true * updating tests * changelogs Co-authored-by: Eddy Nakamura <ednakamu@microsoft.com>
open-telemetry · Sep 1, 2020 · f679960 · f679960
1 parent 261afaa
commit f679960
Show file tree

Hide file tree

Showing 20 changed files with 96 additions and 79 deletions.
diff --git a/NuGet.config b/NuGet.config
@@ -6,6 +6,7 @@
     <!--
     <add key="Dotnet5" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json" />
     -->
+    <add key="Dotnet5" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json" />
   </packageSources>
   <disabledPackageSources />
 </configuration>
diff --git a/build/Common.props b/build/Common.props
@@ -38,7 +38,7 @@
     <StackExchangeRedisPkgVer>[2.1.58,3.0)</StackExchangeRedisPkgVer>
     <StyleCopAnalyzersPkgVer>[1.1.118,2.0)</StyleCopAnalyzersPkgVer>
     <SystemCollectionsImmutablePkgVer>[1.4.0,2.0)</SystemCollectionsImmutablePkgVer>
-    <SystemDiagnosticSourcePkgVer>[5.0.0-preview.8.20407.11]</SystemDiagnosticSourcePkgVer>
+    <SystemDiagnosticSourcePkgVer>[5.0.0-rc.1.20428.3]</SystemDiagnosticSourcePkgVer>
     <SystemReflectionEmitLightweightPkgVer>[4.7.0,5.0)</SystemReflectionEmitLightweightPkgVer>
     <SystemTextJsonPkgVer>[4.7.0,5.0)</SystemTextJsonPkgVer>
     <SystemThreadingTasksExtensionsPkgVer>[4.5.3,5.0)</SystemThreadingTasksExtensionsPkgVer>

diff --git a/examples/AspNet/Examples.AspNet.csproj b/examples/AspNet/Examples.AspNet.csproj
@@ -79,7 +79,7 @@
     <PackageReference Include="Microsoft.AspNet.Mvc" Version="5.2.7" />
     <PackageReference Include="Microsoft.AspNet.WebPages" Version="3.2.7" />
     <PackageReference Include="System.Runtime.CompilerServices.Unsafe">
-      <Version>5.0.0-preview.8.20407.11</Version>
+      <Version>5.0.0-rc.1.20428.3</Version>
     </PackageReference>
   </ItemGroup>
   <ItemGroup>

diff --git a/src/OpenTelemetry.Api/CHANGELOG.md b/src/OpenTelemetry.Api/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+* Updated System.Diagnostics.DiagnosticSource to version 5.0.0-rc.1.20428.3
+
 ## 0.5.0-beta.2
 
 Released 2020-08-28

diff --git a/src/OpenTelemetry/CHANGELOG.md b/src/OpenTelemetry/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+* Fixes [953](https://github.com/open-telemetry/opentelemetry-dotnet/issues/953)
+* Changes arising from DiagnosticSource changes ([#1203](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1203/files))
+
 ## 0.5.0-beta.2
 
 Released 2020-08-28

diff --git a/src/OpenTelemetry/Trace/TracerProviderSdk.cs b/src/OpenTelemetry/Trace/TracerProviderSdk.cs
@@ -93,30 +93,23 @@ static TracerProviderSdk()
                         this.processor?.OnEnd(activity);
                     }
                 },
-
-                // Setting this to true means TraceId will be always
-                // available in sampling callbacks and will be the actual
-                // traceid used, if activity ends up getting created.
-                AutoGenerateRootContextTraceId = true,
             };
 
             if (sampler is AlwaysOnSampler)
             {
-                listener.GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) =>
-                    !Sdk.SuppressInstrumentation ? ActivityDataRequest.AllDataAndRecorded : ActivityDataRequest.None;
+                listener.Sample = (ref ActivityCreationOptions<ActivityContext> options) =>
+                    !Sdk.SuppressInstrumentation ? ActivitySamplingResult.AllDataAndRecorded : ActivitySamplingResult.None;
             }
             else if (sampler is AlwaysOffSampler)
             {
-                /*TODO: Change options.Parent.SpanId to options.Parent.TraceId
-                        once AutoGenerateRootContextTraceId is removed.*/
-                listener.GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) =>
-                    !Sdk.SuppressInstrumentation ? PropagateOrIgnoreData(options.Parent.SpanId) : ActivityDataRequest.None;
+                listener.Sample = (ref ActivityCreationOptions<ActivityContext> options) =>
+                    !Sdk.SuppressInstrumentation ? PropagateOrIgnoreData(options.Parent.TraceId) : ActivitySamplingResult.None;
             }
             else
             {
                 // This delegate informs ActivitySource about sampling decision when the parent context is an ActivityContext.
-                listener.GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) =>
-                    !Sdk.SuppressInstrumentation ? ComputeActivityDataRequest(options, sampler) : ActivityDataRequest.None;
+                listener.Sample = (ref ActivityCreationOptions<ActivityContext> options) =>
+                    !Sdk.SuppressInstrumentation ? ComputeActivitySamplingResult(options, sampler) : ActivitySamplingResult.None;
             }
 
             if (sources.Any())
@@ -219,52 +212,50 @@ protected override void Dispose(bool disposing)
             base.Dispose(disposing);
         }
 
-        private static ActivityDataRequest ComputeActivityDataRequest(
+        private static ActivitySamplingResult ComputeActivitySamplingResult(
             in ActivityCreationOptions<ActivityContext> options,
             Sampler sampler)
         {
-            // As we set ActivityListener.AutoGenerateRootContextTraceId = true,
-            // Parent.TraceId will always be the TraceId of the to-be-created Activity,
-            // if it get created.
-            ActivityTraceId traceId = options.Parent.TraceId;
-
             var samplingParameters = new SamplingParameters(
                 options.Parent,
-                traceId,
+                options.TraceId,
                 options.Name,
                 options.Kind,
                 options.Tags,
                 options.Links);
 
             var shouldSample = sampler.ShouldSample(samplingParameters);
 
-            var activityDataRequest = shouldSample.Decision switch
+            var activitySamplingResult = shouldSample.Decision switch
             {
-                SamplingDecision.RecordAndSampled => ActivityDataRequest.AllDataAndRecorded,
-                SamplingDecision.Record => ActivityDataRequest.AllData,
-                _ => ActivityDataRequest.PropagationData
+                SamplingDecision.RecordAndSampled => ActivitySamplingResult.AllDataAndRecorded,
+                SamplingDecision.Record => ActivitySamplingResult.AllData,
+                _ => ActivitySamplingResult.PropagationData
             };
 
-            if (activityDataRequest != ActivityDataRequest.PropagationData)
+            if (activitySamplingResult != ActivitySamplingResult.PropagationData)
             {
-                return activityDataRequest;
+                foreach (var att in shouldSample.Attributes)
+                {
+                    options.SamplingTags.Add(att.Key, att.Value);
+                }
+
+                return activitySamplingResult;
             }
 
-            /*TODO: Change options.Parent.SpanId to options.Parent.TraceId
-                    once AutoGenerateRootContextTraceId is removed.*/
-            return PropagateOrIgnoreData(options.Parent.SpanId);
+            return PropagateOrIgnoreData(options.Parent.TraceId);
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        private static ActivityDataRequest PropagateOrIgnoreData(ActivitySpanId spanId)
+        private static ActivitySamplingResult PropagateOrIgnoreData(ActivityTraceId traceId)
         {
-            var isRootSpan = spanId == default;
+            var isRootSpan = traceId == default;
 
             // If it is the root span select PropagationData so the trace ID is preserved
             // even if no activity of the trace is recorded (sampled per OpenTelemetry parlance).
             return isRootSpan
-                ? ActivityDataRequest.PropagationData
-                : ActivityDataRequest.None;
+                ? ActivitySamplingResult.PropagationData
+                : ActivitySamplingResult.None;
         }
     }
 }
diff --git a/test/Benchmarks/Tracing/TraceBenchmarks.cs b/test/Benchmarks/Tracing/TraceBenchmarks.cs
@@ -39,26 +39,23 @@ public TraceBenchmarks()
                 ActivityStarted = null,
                 ActivityStopped = null,
                 ShouldListenTo = (activitySource) => activitySource.Name == this.sourceWithPropagationDataListner.Name,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.PropagationData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.PropagationData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.PropagationData,
             });
 
             ActivitySource.AddActivityListener(new ActivityListener
             {
                 ActivityStarted = null,
                 ActivityStopped = null,
                 ShouldListenTo = (activitySource) => activitySource.Name == this.sourceWithAllDataListner.Name,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
             });
 
             ActivitySource.AddActivityListener(new ActivityListener
             {
                 ActivityStarted = null,
                 ActivityStopped = null,
                 ShouldListenTo = (activitySource) => activitySource.Name == this.sourceWithAllDataAndRecordedListner.Name,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllDataAndRecorded,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllDataAndRecorded,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllDataAndRecorded,
             });
 
             Sdk.CreateTracerProviderBuilder()

diff --git a/test/OpenTelemetry.Exporter.Jaeger.Tests/Implementation/JaegerActivityConversionTest.cs b/test/OpenTelemetry.Exporter.Jaeger.Tests/Implementation/JaegerActivityConversionTest.cs
@@ -35,8 +35,7 @@ static JaegerActivityConversionTest()
             var listener = new ActivityListener
             {
                 ShouldListenTo = _ => true,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
             };
 
             ActivitySource.AddActivityListener(listener);

diff --git a/test/OpenTelemetry.Exporter.Jaeger.Tests/Implementation/JaegerUdpBatcherTests.cs b/test/OpenTelemetry.Exporter.Jaeger.Tests/Implementation/JaegerUdpBatcherTests.cs
@@ -41,8 +41,7 @@ static JaegerUdpBatcherTests()
             var listener = new ActivityListener
             {
                 ShouldListenTo = _ => true,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
             };
 
             ActivitySource.AddActivityListener(listener);

diff --git a/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpExporterTest.cs b/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpExporterTest.cs
@@ -42,8 +42,7 @@ static OtlpExporterTest()
             var listener = new ActivityListener
             {
                 ShouldListenTo = _ => true,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
             };
 
             ActivitySource.AddActivityListener(listener);

diff --git a/test/OpenTelemetry.Exporter.ZPages.Tests/ZPagesExporterTests.cs b/test/OpenTelemetry.Exporter.ZPages.Tests/ZPagesExporterTests.cs
@@ -40,8 +40,7 @@ static ZPagesExporterTests()
             var listener = new ActivityListener
             {
                 ShouldListenTo = _ => true,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
             };
 
             ActivitySource.AddActivityListener(listener);

diff --git a/test/OpenTelemetry.Exporter.Zipkin.Tests/ZipkinExporterTests.cs b/test/OpenTelemetry.Exporter.Zipkin.Tests/ZipkinExporterTests.cs
@@ -48,8 +48,7 @@ static ZipkinExporterTests()
             var listener = new ActivityListener
             {
                 ShouldListenTo = _ => true,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
             };
 
             ActivitySource.AddActivityListener(listener);

diff --git a/test/OpenTelemetry.Instrumentation.Http.Tests/HttpWebRequestActivitySourceTests.netfx.cs b/test/OpenTelemetry.Instrumentation.Http.Tests/HttpWebRequestActivitySourceTests.netfx.cs
@@ -197,7 +197,7 @@ public async Task TestBasicReceiveAndResponseEvents(string method, string queryS
         [InlineData("POST")]
         public async Task TestBasicReceiveAndResponseEventsWithoutSampling(string method)
         {
-            using var eventRecords = new ActivitySourceRecorder(activityDataRequest: ActivityDataRequest.None);
+            using var eventRecords = new ActivitySourceRecorder(activitySamplingResult: ActivitySamplingResult.None);
 
             // Send a random Http request to generate some events
             using (var client = new HttpClient())
@@ -889,14 +889,14 @@ private class ActivitySourceRecorder : IDisposable
             private readonly Action<KeyValuePair<string, Activity>> onEvent;
             private readonly ActivityListener activityListener;
 
-            public ActivitySourceRecorder(Action<KeyValuePair<string, Activity>> onEvent = null, ActivityDataRequest activityDataRequest = ActivityDataRequest.AllDataAndRecorded)
+            public ActivitySourceRecorder(Action<KeyValuePair<string, Activity>> onEvent = null, ActivitySamplingResult activitySamplingResult = ActivitySamplingResult.AllDataAndRecorded)
             {
                 this.activityListener = new ActivityListener
                 {
                     ShouldListenTo = (activitySource) => activitySource.Name == HttpWebRequestActivitySource.ActivitySourceName,
                     ActivityStarted = this.ActivityStarted,
                     ActivityStopped = this.ActivityStopped,
-                    GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => activityDataRequest,
+                    Sample = (ref ActivityCreationOptions<ActivityContext> options) => activitySamplingResult,
                 };
 
                 ActivitySource.AddActivityListener(this.activityListener);

diff --git a/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientInstrumentationOptionsTests.cs b/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientInstrumentationOptionsTests.cs
@@ -31,8 +31,7 @@ static SqlClientInstrumentationOptionsTests()
             var listener = new ActivityListener
             {
                 ShouldListenTo = _ => true,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
             };
 
             ActivitySource.AddActivityListener(listener);

diff --git a/test/OpenTelemetry.Shims.OpenTracing.Tests/ScopeManagerShimTests.cs b/test/OpenTelemetry.Shims.OpenTracing.Tests/ScopeManagerShimTests.cs
@@ -35,8 +35,7 @@ static ScopeManagerShimTests()
             var listener = new ActivityListener
             {
                 ShouldListenTo = _ => true,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
             };
 
             ActivitySource.AddActivityListener(listener);

diff --git a/test/OpenTelemetry.Shims.OpenTracing.Tests/SpanBuilderShimTests.cs b/test/OpenTelemetry.Shims.OpenTracing.Tests/SpanBuilderShimTests.cs
@@ -37,8 +37,7 @@ static SpanBuilderShimTests()
             var listener = new ActivityListener
             {
                 ShouldListenTo = _ => true,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
             };
 
             ActivitySource.AddActivityListener(listener);

diff --git a/test/OpenTelemetry.Shims.OpenTracing.Tests/SpanShimTests.cs b/test/OpenTelemetry.Shims.OpenTracing.Tests/SpanShimTests.cs
@@ -37,8 +37,7 @@ static SpanShimTests()
             var listener = new ActivityListener
             {
                 ShouldListenTo = _ => true,
-                GetRequestedDataUsingParentId = (ref ActivityCreationOptions<string> options) => ActivityDataRequest.AllData,
-                GetRequestedDataUsingContext = (ref ActivityCreationOptions<ActivityContext> options) => ActivityDataRequest.AllData,
+                Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
             };
 
             ActivitySource.AddActivityListener(listener);