Enabled system metrics for App Starts spans

Author: Robert Bartoszewski

Sources/BugsnagPerformance/Private/Core/SpanFactory/AppStartup/AppStartupSpanFactoryImpl.mm

@@ -19,6 +19,7 @@
     auto name = isColdLaunch ? @"[AppStart/iOSCold]" : @"[AppStart/iOSWarm]";
     SpanOptions options;
     options.startTime = startTime;
+    options.firstClass = BSGTriStateYes;
     auto attributes = spanAttributesProvider_->appStartSpanAttributes(firstViewName, isColdLaunch);
     return startAppStartSpan(name, options, attributes, @[]);
 }

features/default/automatic_spans.feature

@@ -23,7 +23,17 @@ Feature: Automatic instrumentation spans
     * a span string attribute "bugsnag.span.category" equals "app_start"
     * a span string attribute "bugsnag.span.category" equals "app_start_phase"
     * a span string attribute "bugsnag.app_start.first_view_name" equals "Fixture.ViewController"
-    * every span bool attribute "bugsnag.span.first_class" does not exist
+    * the span named "[AppStart/iOSCold]" array attribute "bugsnag.system.cpu_measures_total" is not empty
+    * the span named "[AppStart/iOSCold]" float attribute "bugsnag.system.cpu_mean_total" is greater than 0.0
+    * the span named "[AppStart/iOSCold]" array attribute "bugsnag.system.cpu_measures_main_thread" is not empty
+    * the span named "[AppStart/iOSCold]" float attribute "bugsnag.system.cpu_mean_main_thread" is greater than 0.0
+    * the span named "[AppStart/iOSCold]" array attribute "bugsnag.system.cpu_measures_overhead" is not empty
+    * the span named "[AppStart/iOSCold]" float attribute "bugsnag.system.cpu_mean_overhead" is greater than 0.0
+    * the span named "[AppStart/iOSCold]" array attribute "bugsnag.system.memory.timestamps" is not empty
+    * the span named "[AppStart/iOSCold]" integer attribute "bugsnag.system.memory.spaces.device.size" is greater than 0
+    * the span named "[AppStart/iOSCold]" array attribute "bugsnag.system.memory.spaces.device.used" is not empty
+    * the span named "[AppStart/iOSCold]" integer attribute "bugsnag.system.memory.spaces.device.mean" is greater than 0
+    * a span bool attribute "bugsnag.span.first_class" is true
     * the trace payload field "resourceSpans.0.resource" string attribute "service.name" matches the regex "com.bugsnag.fixtures.cocoaperformance(xcframework)?"
     * the trace payload field "resourceSpans.0.resource" string attribute "telemetry.sdk.name" equals "bugsnag.performance.cocoa"
     * the trace payload field "resourceSpans.0.resource" string attribute "telemetry.sdk.version" matches the regex "[0-9]+\.[0-9]+\.[0-9]+"
@@ -73,6 +83,16 @@ Feature: Automatic instrumentation spans
     * a span named "[ViewLoadPhase/viewDidLayoutSubviews]/Fixture.ViewController" is a child of span named "[ViewLoad/UIKit]/Fixture.ViewController"
     * a span named "[AppStart/iOSCold]" ended at the same time as a span named "[AppStartPhase/UI init]"
     * a span named "[ViewLoad/UIKit]/Fixture.ViewController" ended before a span named "[AppStartPhase/UI init]"
+    * the span named "[AppStart/iOSCold]" array attribute "bugsnag.system.cpu_measures_total" is not empty
+    * the span named "[AppStart/iOSCold]" float attribute "bugsnag.system.cpu_mean_total" is greater than 0.0
+    * the span named "[AppStart/iOSCold]" array attribute "bugsnag.system.cpu_measures_main_thread" is not empty
+    * the span named "[AppStart/iOSCold]" float attribute "bugsnag.system.cpu_mean_main_thread" is greater than 0.0
+    * the span named "[AppStart/iOSCold]" array attribute "bugsnag.system.cpu_measures_overhead" is not empty
+    * the span named "[AppStart/iOSCold]" float attribute "bugsnag.system.cpu_mean_overhead" is greater than 0.0
+    * the span named "[AppStart/iOSCold]" array attribute "bugsnag.system.memory.timestamps" is not empty
+    * the span named "[AppStart/iOSCold]" integer attribute "bugsnag.system.memory.spaces.device.size" is greater than 0
+    * the span named "[AppStart/iOSCold]" array attribute "bugsnag.system.memory.spaces.device.used" is not empty
+    * the span named "[AppStart/iOSCold]" integer attribute "bugsnag.system.memory.spaces.device.mean" is greater than 0
 
   Scenario: AutoInstrumentViewLoadScenario
     Given I run "AutoInstrumentViewLoadScenario"

features/fixtures/ios/Scenarios/AutoInstrumentAppStartsScenario.swift

@@ -13,6 +13,8 @@ class AutoInstrumentAppStartsScenario: Scenario {
     override func setInitialBugsnagConfiguration() {
         super.setInitialBugsnagConfiguration()
         bugsnagPerfConfig.autoInstrumentAppStarts = true
+        bugsnagPerfConfig.enabledMetrics.cpu = true
+        bugsnagPerfConfig.enabledMetrics.memory = true
     }
 
     override func run() {

features/fixtures/ios/Scenarios/AutoInstrumentAppStartsWithViewLoadScenario.swift

@@ -14,6 +14,8 @@ class AutoInstrumentAppStartsWithViewLoadScenario: Scenario {
         super.setInitialBugsnagConfiguration()
         bugsnagPerfConfig.autoInstrumentAppStarts = true
         bugsnagPerfConfig.autoInstrumentViewControllers = true
+        bugsnagPerfConfig.enabledMetrics.cpu = true
+        bugsnagPerfConfig.enabledMetrics.memory = true
         // This test can generate a variable number of spans depending on the OS version,
         // so use a timed send instead.
         bugsnagPerfConfig.internal.autoTriggerExportOnBatchSize = 100

features/steps/app_steps.rb

@@ -179,6 +179,13 @@ def run_command(action, args)
   attribute_values.map { |v| Maze.check.match pattern, v }
 end
 
+Then('the span named {string} integer attribute {string} is greater than {int}') do |spanName, attribute, expected|
+  spans = spans_from_request_list(Maze::Server.list_for('traces'))
+  span = spans.find { |span| span['name'] == spanName }
+  selected_attribute = span['attributes'].find { |a| a['key'].eql?(attribute) && a['value'].has_key?('intValue') }
+  Maze.check.true(selected_attribute['value']['intValue'].to_f > expected)
+end
+
 Then('a span integer attribute {string} is greater than {int}') do |attribute, expected|
   spans = spans_from_request_list(Maze::Server.list_for('traces'))
   selected_attributes = spans.map { |span| span['attributes'].find { |a| a['key'].eql?(attribute) && a['value'].has_key?('intValue') } }.compact
@@ -200,6 +207,12 @@ def run_command(action, args)
   Maze.check.false(attribute_values.empty?)
 end
 
+Then('the span named {string} float attribute {string} is greater than {float}') do |spanName, attribute, expected|
+  spans = spans_from_request_list(Maze::Server.list_for('traces'))
+  span = spans.find { |span| span['name'] == spanName }
+  selected_attribute = span['attributes'].find { |a| a['key'].eql?(attribute) && a['value'].has_key?('doubleValue') }
+  Maze.check.true(selected_attribute['value']['doubleValue'].to_f > expected)
+end
 
 Then('a span float attribute {string} is greater than {float}') do |attribute, expected|
   spans = spans_from_request_list(Maze::Server.list_for('traces'))
@@ -272,6 +285,21 @@ def get_array_attribute_contents(attribute)
   return array_attributes[0]
 end
 
+def get_array_attribute_contents(spanName, attribute)
+  spans = spans_from_request_list(Maze::Server.list_for('traces'))
+  span = spans.find { |span| span['name'] == spanName }
+  selected_attribute = span['attributes'].find { |a| a['key'].eql?(attribute) &&
+                                                     a['value'].has_key?('arrayValue') &&
+                                                     a['value']['arrayValue'].has_key?('values') }
+  array_attributes = selected_attribute['value']['arrayValue']['values']
+  return array_attributes
+end
+
+Then('the span named {string} array attribute {string} is not empty') do |name, attribute|
+  array_contents = get_array_attribute_contents(name, attribute)
+  Maze.check.false(array_contents.empty?)
+end
+
 Then('a span array attribute {string} is empty') do |attribute|
   array_contents = get_array_attribute_contents(attribute)
   Maze.check.true(array_contents.empty?)