app start control (#196)

Author: richardelms

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/AppStartHandler.cs

@@ -98,6 +98,8 @@ private static Span CreateAppStartSpan(string name, string category)
             return _spanFactory.CreateAutoAppStartSpan(name, category, category.Equals(APP_START_CATEGORY));
         }
 
+        internal Span GetAppStartSpan() => _rootSpan;
+
         internal void SubsystemRegistration()
         {
             _rootSpan = CreateAppStartSpan(UNITY_RUNTIME_SPAN_NAME, APP_START_CATEGORY);

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/AppStartSpanControl.cs

@@ -0,0 +1,20 @@
+namespace BugsnagUnityPerformance
+{
+    internal class AppStartSpanControl : IAppStartSpanControl
+    {
+        private const string Prefix = "[AppStart/UnityRuntime]";
+        private readonly Span _span;
+
+        public AppStartSpanControl(Span span) => _span = span;
+
+        public void SetType(string type)
+        {
+            _span?.TryUpdateAppStartSpan(type, Prefix);
+        }
+
+        public void ClearType()
+        {
+            _span?.TryUpdateAppStartSpan(null, Prefix);
+        }
+    }
+}

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/AppStartSpanControl.cs.meta

@@ -0,0 +1,23 @@
+namespace BugsnagUnityPerformance
+{
+    internal class SpanControlRegistry
+    {
+        private readonly AppStartHandler _appStartHandler;
+
+        public SpanControlRegistry(AppStartHandler handler)
+        {
+            _appStartHandler = handler;
+        }
+
+        public T GetSpanControl<T>(ISpanQuery<T> query) where T : class
+        {
+            if (query is SpanType.AppStartQuery)
+            {
+                var span = _appStartHandler.GetAppStartSpan();
+                return span != null ? new AppStartSpanControl(span) as T : null;
+            }
+
+            return null;
+        }
+    }
+}

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/SpanControlRegistry.cs

@@ -32,6 +32,7 @@ public class BugsnagPerformance
         private SystemMetricsCollector _systemMetricsCollector;
         private static List<WeakReference<Span>> _potentiallyOpenSpans = new List<WeakReference<Span>>();
         private Func<BugsnagNetworkRequestInfo, BugsnagNetworkRequestInfo> _networkRequestCallback;
+        private static SpanControlRegistry _spanControlRegistry;
 
         private static Dictionary<WeakReference<BugsnagUnityWebRequest>, Span> _networkSpans = new Dictionary<WeakReference<BugsnagUnityWebRequest>, Span>();
 
@@ -44,7 +45,6 @@ internal class SceneLoadSpanContainer
         {
             public List<Span> Spans = new List<Span>();
         }
-
         public static void Start(PerformanceConfiguration configuration)
         {
 #if BUGSNAG_DEBUG
@@ -122,6 +122,11 @@ public static Span StartNetworkSpan(string url, HttpVerb httpVerb, SpanOptions s
             return _sharedInstance._spanFactory.CreateManualNetworkSpan(url, httpVerb, spanOptions);
         }
 
+        public static T GetSpanControl<T>(ISpanQuery<T> query) where T : class
+        {
+            return _spanControlRegistry?.GetSpanControl(query);
+        }
+
         [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
         private static void SubsystemRegistration()
         {
@@ -141,6 +146,7 @@ private BugsnagPerformance()
             _tracer = new Tracer(_sampler, _delivery, _frameMetricsCollector, _systemMetricsCollector);
             _spanFactory = new SpanFactory(_tracer.OnSpanEnd, _frameMetricsCollector);
             _appStartHandler = new AppStartHandler(_spanFactory);
+            _spanControlRegistry = new SpanControlRegistry(_appStartHandler);
             _pValueUpdater = new PValueUpdater(_delivery, _sampler);
         }
 

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/SpanControlRegistry.cs.meta

@@ -31,6 +31,7 @@ public class Span : ISpanContext
         private const string MEMORY_SPACES_ART_SIZE_KEY = "bugsnag.system.memory.spaces.art.size";
         private const string MEMORY_SPACES_ART_USED_KEY = "bugsnag.system.memory.spaces.art.used";
         private const string MEMORY_SPACES_ART_MEAN_KEY = "bugsnag.system.memory.spaces.art.mean";
+        private const string APP_START_NAME_KEY = "bugsnag.app_start.name";
         private const double CPU_METRICS_MIN_THRESHOLD = 0.0001;
 
         public string Name { get; internal set; }
@@ -42,7 +43,7 @@ public class Span : ISpanContext
         public DateTimeOffset EndTime { get; internal set; }
         internal double samplingProbability { get; private set; }
         internal bool Ended;
-        private object _endLock = new object();
+        private readonly object _endLock = new object();
         private OnSpanEnd _onSpanEnd;
         internal bool IsAppStartSpan;
         internal bool WasDiscarded;
@@ -52,6 +53,8 @@ public class Span : ISpanContext
         private int _customAttributeCount;
         private int _maxCustomAttributes;
         internal bool IsFrozenFrameSpan;
+        private readonly object _attributesLock = new object();
+
 
         public Span(string name, SpanKind kind, string id,
         string traceId, string parentSpanId, DateTimeOffset startTime,
@@ -190,12 +193,15 @@ public void UpdateSamplingProbability(double value)
         internal void SetAttributeInternal(string key, bool value) => SetAttributeWithoutChecks(key, value);
         private void SetAttributeWithoutChecks(string key, object value)
         {
-            if (value == null)
+            lock (_attributesLock)
             {
-                _attributes.Remove(key);
-                return;
+                if (value == null)
+                {
+                    _attributes.Remove(key);
+                    return;
+                }
+                _attributes[key] = value;
             }
-            _attributes[key] = value;
         }
 
 
@@ -215,31 +221,57 @@ private void SetAttributeWithChecks(string key, object value)
                 MainThreadDispatchBehaviour.LogWarning($"Attempting to set attribute: {key} on span: {Name} after the span has ended.");
                 return;
             }
-
-            if (_attributes.ContainsKey(key))
+            lock (_attributesLock)
             {
-                if (value == null)
+                if (_attributes.ContainsKey(key))
                 {
-                    _attributes.Remove(key);
-                    _customAttributeCount--;
+                    if (value == null)
+                    {
+                        _attributes.Remove(key);
+                        _customAttributeCount--;
+                    }
+                    else
+                    {
+                        _attributes[key] = value;
+                    }
+                    return;
                 }
-                else
+
+                if (_customAttributeCount >= _maxCustomAttributes)
                 {
-                    _attributes[key] = value;
+                    DroppedAttributesCount++;
+                    return;
                 }
-                return;
+                _attributes[key] = value;
+                _customAttributeCount++;
             }
+        }
 
-            if (_customAttributeCount >= _maxCustomAttributes)
+        internal bool TryUpdateAppStartSpan(string? type, string namePrefix = "[AppStart/UnityRuntime]")
+        {
+            lock (_endLock)
             {
-                DroppedAttributesCount++;
-                return;
+                if (Ended)
+                {
+                    return false;
+                }
+                Name = type == null ? namePrefix : namePrefix + type;
+                lock (_attributesLock)
+                {
+                    if (type == null) _attributes.Remove(APP_START_NAME_KEY);
+                    else _attributes[APP_START_NAME_KEY] = type;
+                }
+                return true;
             }
-            _attributes[key] = value;
-            _customAttributeCount++;
         }
 
-        internal Dictionary<string, object> GetAttributes() => new Dictionary<string, object>(_attributes);
+        internal Dictionary<string, object> GetAttributes()
+        {
+            lock (_attributesLock)
+            {
+                return new Dictionary<string, object>(_attributes);
+            }
+        }
 
         internal void SetCallbackComplete()
         {

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Public/BugsnagPerformance.cs

@@ -0,0 +1,16 @@
+namespace BugsnagUnityPerformance
+{
+    public interface IAppStartSpanControl
+    {
+        void SetType(string type);
+        void ClearType();
+    }
+
+    public interface ISpanQuery<T> { }
+
+    public static class SpanType
+    {
+        public static readonly ISpanQuery<IAppStartSpanControl> AppStart = new AppStartQuery();
+        internal sealed class AppStartQuery : ISpanQuery<IAppStartSpanControl> { }
+    }
+}

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Public/Span.cs

@@ -2,9 +2,13 @@
 
 ## TBD
 
+### Additions
+
+- Allow app start span customisation. [#196](https://github.com/bugsnag/bugsnag-unity-performance/pull/196)
+
 ### Bug Fixes
 
-- Fix issue where CPU metrics where reported when no valid CPU data was avaliable. [#193](https://github.com/bugsnag/bugsnag-unity-performance/pull/193)
+- Fix issue where CPU metrics were reported when no valid CPU data was available. [#193](https://github.com/bugsnag/bugsnag-unity-performance/pull/193)
 
 ## v1.10.0 (2025-06-03)