iOS native profiling

.github/workflows/device-tests-ios.yml

@@ -7,7 +7,7 @@ on:
       - release/*
   pull_request:
     paths-ignore:
-      - '**.md'
+      - "**.md"
 
 jobs:
   build:

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- iOS profiling support (alpha). ([#2930](https://github.com/getsentry/sentry-dotnet/pull/2930))
+
 ### Fixes
 
 - Stop Sentry for MacCatalyst from creating `default.profraw` in the app bundle using xcodebuild archive to build sentry-cocoa ([#2960](https://github.com/getsentry/sentry-dotnet/pull/2960))

benchmarks/Sentry.Benchmarks/ProfilingBenchmarks.cs

@@ -25,7 +25,7 @@ public void StartProfiler()
     public void StopProfiler()
     {
         _profiler?.Finish();
-        _profiler?.CollectAsync(new Transaction("", "")).Wait();
+        (_profiler as SamplingTransactionProfiler)?.CollectAsync(new Transaction("", "")).Wait();
         _profiler = null;
         _factory.Dispose();
         _factory = null;
@@ -55,7 +55,7 @@ public long Transaction(int runtimeMs, bool collect)
         var transaction = new Transaction(tt);
         if (collect)
         {
-            var collectTask = tt.TransactionProfiler.CollectAsync(transaction);
+            var collectTask = (tt.TransactionProfiler as SamplingTransactionProfiler).CollectAsync(transaction);
             collectTask.Wait();
         }
         return result;

samples/Sentry.Samples.Ios/AppDelegate.cs

@@ -16,6 +16,8 @@ public override bool FinishedLaunching(UIApplication application, NSDictionary l
         {
             o.Debug = true;
             o.Dsn = "https://[email protected]/5428537";
+            o.TracesSampleRate = 1.0;
+            o.ProfilesSampleRate = 1.0;
         });
 
         // create a new window instance based on the screen size
@@ -50,6 +52,43 @@ public override bool FinishedLaunching(UIApplication application, NSDictionary l
         // throw new Exception("Test Unhandled Managed Exception");
         // SentrySdk.CauseCrash(CrashType.Native);
 
+        {
+            var tx = SentrySdk.StartTransaction("app", "run");
+            var count = 10;
+            for (var i = 0; i < count; i++)
+            {
+                FindPrimeNumber(100000);
+            }
+
+            tx.Finish();
+        }
+
         return true;
     }
+
+    private static long FindPrimeNumber(int n)
+    {
+        int count = 0;
+        long a = 2;
+        while (count < n)
+        {
+            long b = 2;
+            int prime = 1;// to check if found a prime
+            while (b * b <= a)
+            {
+                if (a % b == 0)
+                {
+                    prime = 0;
+                    break;
+                }
+                b++;
+            }
+            if (prime > 0)
+            {
+                count++;
+            }
+            a++;
+        }
+        return (--a);
+    }
 }

scripts/device-test.ps1

@@ -22,7 +22,7 @@ Push-Location $PSScriptRoot/..
 try
 {
     $tfm = 'net7.0-'
-    $arch = $(uname -m) -eq 'arm64' ? 'arm64' : 'x64'
+    $arch = (!$IsWindows -and $(uname -m) -eq 'arm64') ? 'arm64' : 'x64'
     if ($Platform -eq 'android')
     {
         $tfm += 'android'
@@ -75,7 +75,11 @@ try
         }
         finally
         {
-            scripts/parse-xunit2-xml.ps1 ./test_output/TestResults.xml | Out-File $env:GITHUB_STEP_SUMMARY
+            if ($CI)
+            {
+                scripts/parse-xunit2-xml.ps1 (Get-Item ./test_output/*.xml).FullName | Out-File $env:GITHUB_STEP_SUMMARY
+            }
+
         }
     }
 }

scripts/parse-xunit2-xml.ps1

@@ -4,7 +4,7 @@ Set-StrictMode -Version Latest
 
 if ([string]::IsNullOrEmpty($File) -or !(Test-Path($File)))
 {
-    Write-Warning "Test output file was not found."
+    Write-Warning "Test output file was not found: '$File'."
 
     # Return success exit code so that GitHub Actions highlights the failure in the test run, rather than in this script.
     return
@@ -20,7 +20,7 @@ function ElementText([System.Xml.XmlElement] $element)
 $summary = "## Summary`n`n"
 $summary += "| Assembly | Passed | Failed | Skipped |`n"
 $summary += "| -------- | -----: | -----: | ------: |`n"
-$failures = ""
+$failures = ''
 foreach ($assembly in $xml.assemblies.assembly)
 {
     $summary += "| $($assembly.name) | $($assembly.passed) | $($assembly.failed) | $($assembly.skipped) |`n"
@@ -30,23 +30,25 @@ foreach ($assembly in $xml.assemblies.assembly)
         $failures += "### $($assembly.name)`n"
         foreach ($test in $assembly.collection.test)
         {
-            if ($test.result -eq "Pass")
+            if ($test.result -eq 'Pass')
             {
                 continue
             }
 
             $failures += "#### $($test.name.Replace('\"', '"'))"
-            if ($test.result -eq "Skip")
+            if ($test.result -eq 'Skip')
             {
                 $failures += " - Skipped`n"
                 $failures += "$(ElementText $test.reason)"
             }
             else
             {
                 $failures += " - $($test.result)ed`n"
-                if ($test.PSobject.Properties.name -match "output")
+                if ($test.PSobject.Properties.name -match 'output')
                 {
+                    $failures += '```' + "`n"
                     $failures += "$(ElementText $test.output)`n"
+                    $failures += '```'
                 }
                 $failures += '```' + "`n"
                 $failures += "$(ElementText $test.failure.message)`n"

src/Sentry.Profiling/SentryProfiling.cs → src/Sentry.Profiling/ProfilingIntegration.cs

@@ -10,6 +10,9 @@ public class ProfilingIntegration : ISdkIntegration
     /// <inheritdoc/>
     public void Register(IHub hub, SentryOptions options)
     {
-        options.TransactionProfilerFactory = SamplingTransactionProfilerFactory.Create(options);
+        if (options.IsProfilingEnabled)
+        {
+            options.TransactionProfilerFactory ??= SamplingTransactionProfilerFactory.Create(options);
+        }
     }
 }

src/Sentry.Profiling/SamplingTransactionProfiler.cs

@@ -96,11 +96,14 @@ public void Finish()
     }
 
     /// <inheritdoc />
-    public async Task<ProfileInfo> CollectAsync(Transaction transaction)
+    public Protocol.Envelopes.ISerializable? Collect(Transaction transaction)
+        => Protocol.Envelopes.AsyncJsonSerializable.CreateFrom(CollectAsync(transaction));
+
+    internal async Task<ProfileInfo> CollectAsync(Transaction transaction)
     {
         if (!_stopped)
         {
-            throw new InvalidOperationException("Profiler.CollectAsync() called before Finish()");
+            throw new InvalidOperationException("Profiler.Collect() called before Finish()");
         }
 
         // Wait for the last sample (<= _endTimeMs), or at most 1 second. The timeout shouldn't happen because

src/Sentry/BindableSentryOptions.cs

@@ -40,6 +40,7 @@ internal partial class BindableSentryOptions
     public bool? EnableTracing { get; set; }
     public double? TracesSampleRate { get; set; }
     public List<string>? TracePropagationTargets { get; set; }
+    public double? ProfilesSampleRate { get; set; }
     public StackTraceMode? StackTraceMode { get; set; }
     public long? MaxAttachmentSize { get; set; }
     public StartupTimeDetectionMode? DetectStartupTime { get; set; }
@@ -82,6 +83,7 @@ public void ApplyTo(SentryOptions options)
         options.DefaultTags = DefaultTags ?? options.DefaultTags;
         options.EnableTracing = EnableTracing ?? options.EnableTracing;
         options.TracesSampleRate = TracesSampleRate ?? options.TracesSampleRate;
+        options.ProfilesSampleRate = ProfilesSampleRate ?? options.ProfilesSampleRate;
         options.TracePropagationTargets = TracePropagationTargets?.Select(s => new SubstringOrRegexPattern(s)).ToList() ?? options.TracePropagationTargets;
         options.StackTraceMode = StackTraceMode ?? options.StackTraceMode;
         options.MaxAttachmentSize = MaxAttachmentSize ?? options.MaxAttachmentSize;

src/Sentry/Internal/Hub.cs

@@ -154,7 +154,9 @@ internal ITransactionTracer StartTransaction(
                 transaction.SampleRate = sampleRate;
             }
 
-            if (transaction.IsSampled is true && _options.TransactionProfilerFactory is { } profilerFactory)
+            if (transaction.IsSampled is true &&
+                _options.TransactionProfilerFactory is { } profilerFactory &&
+                _randomValuesFactory.NextBool(_options.ProfilesSampleRate ?? 0.0))
             {
                 // TODO cancellation token based on Hub being closed?
                 transaction.TransactionProfiler = profilerFactory.Start(transaction, CancellationToken.None);
@@ -200,7 +202,7 @@ public SentryTraceHeader GetTraceHeader()
 
     public BaggageHeader GetBaggage()
     {
-        if (GetSpan() is TransactionTracer { DynamicSamplingContext: { IsEmpty: false } dsc } )
+        if (GetSpan() is TransactionTracer { DynamicSamplingContext: { IsEmpty: false } dsc })
         {
             return dsc.ToBaggageHeader();
         }
@@ -528,11 +530,11 @@ public void Dispose()
 #elif ANDROID
             // TODO
 #elif NET8_0_OR_GREATER
-            if (AotHelper.IsNativeAot)
-            {
-                _options?.LogDebug("Closing native SDK");
-                SentrySdk.CloseNativeSdk();
-            }
+        if (AotHelper.IsNativeAot)
+        {
+            _options?.LogDebug("Closing native SDK");
+            SentrySdk.CloseNativeSdk();
+        }
 #endif
     }
 

src/Sentry/Internal/ITransactionProfiler.cs

@@ -23,8 +23,7 @@ internal interface ITransactionProfiler
     /// </summary>
     void Finish();
 
-    /// <summary>
-    /// Process and collect the profile.
-    /// </summary>
-    Task<ProfileInfo> CollectAsync(Transaction transaction);
+    /// <summary>Process and collect the profile.</summary>
+    /// <returns>The collected profile.</returns>
+    ISerializable? Collect(Transaction transaction);
 }

src/Sentry/Internal/SentryStopwatch.cs

@@ -8,6 +8,7 @@ internal struct SentryStopwatch
 {
     private static readonly double StopwatchTicksPerTimeSpanTick =
         (double)Stopwatch.Frequency / TimeSpan.TicksPerSecond;
+    private static readonly double StopwatchTicksPerNs = (double)Stopwatch.Frequency / 1000000000.0;
 
     private long _startTimestamp;
     private DateTimeOffset _startDateTimeOffset;
@@ -21,14 +22,15 @@ internal struct SentryStopwatch
     public DateTimeOffset StartDateTimeOffset => _startDateTimeOffset;
     public DateTimeOffset CurrentDateTimeOffset => _startDateTimeOffset + Elapsed;
 
+    private long Diff() => Stopwatch.GetTimestamp() - _startTimestamp;
+
     public TimeSpan Elapsed
     {
-        get
-        {
-            var now = Stopwatch.GetTimestamp();
-            var diff = now - _startTimestamp;
-            var ticks = (long)(diff / StopwatchTicksPerTimeSpanTick);
-            return TimeSpan.FromTicks(ticks);
-        }
+        get => TimeSpan.FromTicks((long)(Diff() / StopwatchTicksPerTimeSpanTick));
+    }
+
+    public ulong ElapsedNanoseconds
+    {
+        get => (ulong)(Diff() / StopwatchTicksPerNs);
     }
 }

src/Sentry/Internal/SerializableExtensions.cs

@@ -1,7 +1,6 @@
 using Sentry.Extensibility;
 using Sentry.Infrastructure;
 using Sentry.Protocol.Envelopes;
-using ISerializable = Sentry.Protocol.Envelopes.ISerializable;
 
 namespace Sentry.Internal;
 

src/Sentry/Platforms/Cocoa/CocoaProfiler.cs

@@ -0,0 +1,62 @@
+using Sentry.Extensibility;
+using Sentry.Internal;
+using Sentry.Cocoa.Extensions;
+using Sentry.Cocoa.Facades;
+
+namespace Sentry.Cocoa;
+
+internal class CocoaProfiler : ITransactionProfiler
+{
+    private readonly SentryOptions _options;
+    private readonly SentryId _traceId;
+    private readonly CocoaSdk.SentryId _cocoaTraceId;
+    private readonly ulong _startTimeNs;
+    private ulong _endTimeNs;
+    private readonly SentryStopwatch _stopwatch;
+
+    public CocoaProfiler(SentryOptions options, ulong startTimeNs, SentryId traceId, CocoaSdk.SentryId cocoaTraceId)
+    {
+        _stopwatch = SentryStopwatch.StartNew();
+        _options = options;
+        _startTimeNs = startTimeNs;
+        _traceId = traceId;
+        _cocoaTraceId = cocoaTraceId;
+        _options.LogDebug("Trace {0} profile start timestamp: {1} ns", _traceId, _startTimeNs);
+    }
+
+    /// <inheritdoc />
+    public void Finish()
+    {
+        if (_endTimeNs == 0)
+        {
+            _endTimeNs = _startTimeNs + (ulong)_stopwatch.ElapsedNanoseconds;
+            _options.LogDebug("Trace {0} profile end timestamp: {1} ns", _traceId, _endTimeNs);
+        }
+    }
+
+    public ISerializable? Collect(Transaction transaction)
+    {
+        // TODO change return type of CocoaSDKs CollectProfileBetween to NSMutableDictionary
+        var payload = SentryCocoaHybridSdk.CollectProfileBetween(_startTimeNs, _endTimeNs, _cocoaTraceId)?.MutableCopy() as NSMutableDictionary;
+        if (payload is null)
+        {
+            _options.LogWarning("Trace {0} collected profile payload is null", _traceId);
+            return null;
+        }
+        _options.LogDebug("Trace {0} profile payload collected", _traceId);
+
+        var payloadTx = payload["transaction"]?.MutableCopy() as NSMutableDictionary;
+        if (payloadTx is null)
+        {
+            _options.LogWarning("Trace {0} collected profile payload doesn't have transaction information", _traceId);
+            return null;
+        }
+
+        payloadTx["id"] = transaction.EventId.ToString().ToNSString();
+        payloadTx["trace_id"] = _traceId.ToString().ToNSString();
+        payloadTx["name"] = transaction.Name.ToNSString();
+        payload["transaction"] = payloadTx;
+        payload["timestamp"] = transaction.StartTimestamp.ToString("o", CultureInfo.InvariantCulture).ToNSString();
+        return new SerializableNSObject(payload);
+    }
+}

src/Sentry/Platforms/Cocoa/CocoaProfilerFactory.cs

@@ -0,0 +1,22 @@
+using Sentry.Internal;
+using Sentry.Cocoa.Extensions;
+
+namespace Sentry.Cocoa;
+
+internal class CocoaProfilerFactory : ITransactionProfilerFactory
+{
+    private readonly SentryOptions _options;
+
+    internal CocoaProfilerFactory(SentryOptions options)
+    {
+        _options = options;
+    }
+
+    /// <inheritdoc />
+    public ITransactionProfiler? Start(ITransactionTracer tracer, CancellationToken cancellationToken)
+    {
+        var traceId = tracer.TraceId.ToCocoaSentryId();
+        var startTime = SentryCocoaHybridSdk.StartProfilerForTrace(traceId);
+        return new CocoaProfiler(_options, startTime, tracer.TraceId, traceId);
+    }
+}

src/Sentry/Platforms/Cocoa/Extensions/CocoaExtensions.cs

@@ -8,6 +8,8 @@ internal static class CocoaExtensions
 
     public static NSDate ToNSDate(this DateTimeOffset timestamp) => (NSDate)timestamp.UtcDateTime;
 
+    public static NSString ToNSString(this string str) => new NSString(str);
+
     public static string? ToJsonString(this NSObject? obj, IDiagnosticLogger? logger = null)
     {
         using var data = obj.ToJsonData(logger);