profiling streaming TraceLog

.gitmodules

@@ -8,3 +8,6 @@
 	path = modules/Carthage
 	url = https://github.com/Carthage/Carthage
 	branch = xcframework-catalyst
+[submodule "modules/perfview"]
+	path = modules/perfview
+	url = https://github.com/getsentry/perfview.git

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Features
 
 - Graphql client ([#2538](https://github.com/getsentry/sentry-dotnet/pull/2538))
+- Profiling multiple transactions in parallel ([#2385](https://github.com/getsentry/sentry-dotnet/pull/2385))
 
 ### Dependencies
 

Sentry-CI-Pack.slnf

@@ -17,8 +17,9 @@
       "src\\Sentry.Maui\\Sentry.Maui.csproj",
       "src\\Sentry.NLog\\Sentry.NLog.csproj",
       "src\\Sentry.OpenTelemetry\\Sentry.OpenTelemetry.csproj",
+      "src\\Sentry.Profiling\\Sentry.Profiling.csproj",
       "src\\Sentry.Serilog\\Sentry.Serilog.csproj",
       "src\\Sentry\\Sentry.csproj"
     ]
   }
-}
+}

Sentry-CI-Test.slnf

@@ -20,6 +20,7 @@
       "test\\Sentry.Serilog.Tests\\Sentry.Serilog.Tests.csproj",
       "test\\Sentry.Testing.CrashableApp\\Sentry.Testing.CrashableApp.csproj",
       "test\\Sentry.Testing\\Sentry.Testing.csproj",
+      "test\\Sentry.Profiling.Tests\\Sentry.Profiling.Tests.csproj",
       "test\\Sentry.Tests\\Sentry.Tests.csproj"
     ]
   }

SentryCore.slnf

@@ -2,11 +2,15 @@
   "solution": {
     "path": "Sentry.sln",
     "projects": [
+      "benchmarks\\Sentry.Benchmarks\\Sentry.Benchmarks.csproj",
       "samples\\Sentry.Samples.Console.Basic\\Sentry.Samples.Console.Basic.csproj",
+      "samples\\Sentry.Samples.Console.Profiling\\Sentry.Samples.Console.Profiling.csproj",
+      "src\\Sentry.Profiling\\Sentry.Profiling.csproj",
       "src\\Sentry\\Sentry.csproj",
+      "test\\Sentry.Profiling.Tests\\Sentry.Profiling.Tests.csproj",
       "test\\Sentry.Testing.CrashableApp\\Sentry.Testing.CrashableApp.csproj",
       "test\\Sentry.Testing\\Sentry.Testing.csproj",
       "test\\Sentry.Tests\\Sentry.Tests.csproj"
     ]
   }
-}
+}

benchmarks/Sentry.Benchmarks/ProfilingBenchmarks.cs

@@ -1,41 +1,59 @@
 using System.Diagnostics.Tracing;
 using BenchmarkDotNet.Attributes;
 using Microsoft.Diagnostics.NETCore.Client;
-using Microsoft.Diagnostics.Tracing.Parsers;
 using NSubstitute;
 using Sentry.Internal;
 using Sentry.Profiling;
 
 namespace Sentry.Benchmarks;
 
+extern alias BenchmarkDotNetTransientTraceEvent;
+
 public class ProfilingBenchmarks
 {
     private IHub _hub = Substitute.For<IHub>();
-    private ITransactionProfilerFactory _factory = new SamplingTransactionProfilerFactory(Path.GetTempPath(), new());
+    private SamplingTransactionProfilerFactory _factory;
+    private ITransactionProfiler _profiler;
+
+    [GlobalSetup(Targets = new string[] { nameof(Transaction), nameof(DoHardWorkWhileProfiling) })]
+    public void StartProfiler()
+    {
+        _factory = SamplingTransactionProfilerFactory.Create(new());
+    }
+
+    [GlobalCleanup(Targets = new string[] { nameof(Transaction), nameof(DoHardWorkWhileProfiling) })]
+    public void StopProfiler()
+    {
+        _profiler?.Finish();
+        _profiler?.CollectAsync(new Transaction("", "")).Wait();
+        _profiler = null;
+        _factory.Dispose();
+        _factory = null;
+    }
 
     #region full transaction profiling
-    public IEnumerable<object[]> ProfilerArguments()
+    public IEnumerable<object[]> TransactionBenchmarkArguments()
     {
         foreach (var runtimeMs in new[] { 25, 100, 1000, 10000 })
         {
-            foreach (var processing in new[] { true, false })
+            foreach (var collect in new[] { true, false })
             {
-                yield return new object[] { runtimeMs, processing };
+                yield return new object[] { runtimeMs, collect };
             }
         }
     }
 
     // Run a profiled transaction. Profiler starts and stops for each transaction separately.
     [Benchmark]
-    [ArgumentsSource(nameof(ProfilerArguments))]
-    public long Transaction(int runtimeMs, bool processing)
+    [ArgumentsSource(nameof(TransactionBenchmarkArguments))]
+    public long Transaction(int runtimeMs, bool collect)
     {
         var tt = new TransactionTracer(_hub, "test", "");
         tt.TransactionProfiler = _factory.Start(tt, CancellationToken.None);
         var result = RunForMs(runtimeMs);
-        tt.TransactionProfiler?.Finish();
+        tt.TransactionProfiler.Finish();
         var transaction = new Transaction(tt);
-        if (processing)
+        if (collect)
         {
             var collectTask = tt.TransactionProfiler.CollectAsync(transaction);
             collectTask.Wait();
@@ -97,11 +115,7 @@ public DiagnosticsClient DiagnosticsClientNew()
     [Benchmark]
     public void DiagnosticsSessionStartStop()
     {
-        var session = DiagnosticsClientNew().StartEventPipeSession(
-            SampleProfilerSession.Providers,
-            SampleProfilerSession.RequestRundown,
-            SampleProfilerSession.CircularBufferMB
-        );
+        var session = DiagnosticsClientNew().StartEventPipeSession(SampleProfilerSession.Providers, true, SampleProfilerSession.CircularBufferMB);
         session.EventStream.Dispose();
         session.Dispose();
     }
@@ -125,9 +139,9 @@ public void DiagnosticsSessionStartCopyStop(bool rundown, string provider)
     {
         EventPipeProvider[] providers = provider switch
         {
-            "runtime" => new[] { new EventPipeProvider("Microsoft-Windows-DotNETRuntime", EventLevel.Informational, (long)ClrTraceEventParser.Keywords.Default) },
+            "runtime" => new[] { new EventPipeProvider("Microsoft-Windows-DotNETRuntime", EventLevel.Informational, (long)BenchmarkDotNetTransientTraceEvent::Microsoft.Diagnostics.Tracing.Parsers.ClrTraceEventParser.Keywords.Default) },
             "sample" => new[] { new EventPipeProvider("Microsoft-DotNETCore-SampleProfiler", EventLevel.Informational) },
-            "tpl" => new[] { new EventPipeProvider("System.Threading.Tasks.TplEventSource", EventLevel.Informational, (long)TplEtwProviderTraceEventParser.Keywords.Default) },
+            "tpl" => new[] { new EventPipeProvider("System.Threading.Tasks.TplEventSource", EventLevel.Informational, (long)BenchmarkDotNetTransientTraceEvent::Microsoft.Diagnostics.Tracing.Parsers.TplEtwProviderTraceEventParser.Keywords.Default) },
             "all" => SampleProfilerSession.Providers,
             _ => throw new InvalidEnumArgumentException(nameof(provider))
         };
@@ -139,19 +153,10 @@ public void DiagnosticsSessionStartCopyStop(bool rundown, string provider)
         session.Dispose();
     }
 
-    // Same as DiagnosticsSessionStartCopyStop(rundown: true, provider: 'all')
-    [Benchmark]
-    public void SampleProfilerSessionStartStopFinishWait()
-    {
-        var session = SampleProfilerSession.StartNew(CancellationToken.None);
-        session.Stop();
-        session.FinishAsync().Wait();
-    }
-
     [Benchmark]
     public void SampleProfilerSessionStartStop()
     {
-        var session = SampleProfilerSession.StartNew(CancellationToken.None);
+        using var session = SampleProfilerSession.StartNew();
         session.Stop();
     }
     #endregion
@@ -163,30 +168,15 @@ public void SampleProfilerSessionStartStop()
     [ArgumentsSource(nameof(OverheadRunArguments))]
     public long DoHardWork(int n)
     {
-        return ProfilingBenchmarks.FindPrimeNumber(n);
+        return FindPrimeNumber(n);
     }
 
     [BenchmarkCategory("overhead"), Benchmark]
     [ArgumentsSource(nameof(OverheadRunArguments))]
     public long DoHardWorkWhileProfiling(int n)
     {
-        return ProfilingBenchmarks.FindPrimeNumber(n);
-    }
-
-    private ITransactionProfiler _profiler;
-
-    [GlobalSetup(Target = nameof(DoHardWorkWhileProfiling))]
-    public void StartProfiler()
-    {
-        _profiler = _factory.Start(new TransactionTracer(_hub, "", ""), CancellationToken.None);
-    }
-
-    [GlobalCleanup(Target = nameof(DoHardWorkWhileProfiling))]
-    public void StopProfiler()
-    {
-        _profiler?.Finish();
-        _profiler?.CollectAsync(new Transaction("", "")).Wait();
-        _profiler = null;
+        _profiler ??= _factory.Start(new TransactionTracer(_hub, "", ""), CancellationToken.None);
+        return FindPrimeNumber(n);
     }
     #endregion
 }

benchmarks/Sentry.Benchmarks/Sentry.Benchmarks.csproj

@@ -16,4 +16,12 @@
     <ProjectReference Include="..\..\src\Sentry.Profiling\Sentry.Profiling.csproj" />
   </ItemGroup>
 
+  <!-- BenchmarkDotNet depends on Microsoft.Diagnostics.Tracing.TraceEvent which includes types we're vendoring in Sentry through the perview submodule.-->
+  <Target Name="ChangeAliasesOfStrongNameAssemblies" BeforeTargets="FindReferenceAssembliesForReferences;ResolveReferences">
+    <ItemGroup>
+      <ReferencePath Condition="'%(FileName)' == 'Microsoft.Diagnostics.Tracing.TraceEvent'">
+        <Aliases>BenchmarkDotNetTransientTraceEvent</Aliases>
+      </ReferencePath>
+    </ItemGroup>
+  </Target>
 </Project>

benchmarks/Sentry.Benchmarks/run.cmd

@@ -1,4 +1,4 @@
-set framework=netcoreapp2.1
+set framework=net6.0
 
 dotnet build -c Release -f %framework%
 if not errorlevel 0 exit /b -1

benchmarks/Sentry.Benchmarks/run.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 set -e errexit
 
-framework=netcoreapp2.1
+framework=net6.0
 dotnet build -c Release -f $framework
 dotnet bin/Release/$framework/Sentry.Benchmarks.dll